diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index 33b017c6a9..2823c69d23 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -2165,6 +2165,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", @@ -2437,6 +2524,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", @@ -11773,6 +11950,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", @@ -18967,6 +19231,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", @@ -93463,6 +93817,318 @@ ], "additionalProperties": false }, + "copilot-ide-code-completions": { + "type": "object", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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.", @@ -263053,6 +263719,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": [ { @@ -290968,6 +291789,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.", @@ -292274,6 +293104,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/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index 4602126f1c..bba2ad23fe 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -1502,6 +1502,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 @@ -1688,6 +1759,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 @@ -8615,6 +8761,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 @@ -13804,6 +14024,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 @@ -67859,6 +68154,287 @@ components: - assignee - created_at additionalProperties: false + copilot-ide-code-completions: + type: object + description: Usage metrics for Copilot editor code completions in the IDE. + nullable: true + 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 + nullable: true + 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 + description: Usage metrics for Copilot Chat in the IDE. + nullable: true + 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 + nullable: true + 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 + description: Usage metrics for Copilot Chat in github.com + nullable: true + 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 + description: The training date for the custom model (if applicable). + nullable: true + 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 + description: Usage metrics for Copilot for pull requests. + nullable: true + 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 + nullable: true + 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. @@ -196922,6 +197498,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' @@ -221045,6 +221720,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. @@ -222136,6 +222818,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/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index 33b017c6a9..2823c69d23 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -2165,6 +2165,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", @@ -2437,6 +2524,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", @@ -11773,6 +11950,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", @@ -18967,6 +19231,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", @@ -93463,6 +93817,318 @@ ], "additionalProperties": false }, + "copilot-ide-code-completions": { + "type": "object", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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.", @@ -263053,6 +263719,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": [ { @@ -290968,6 +291789,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.", @@ -292274,6 +293104,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/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 4602126f1c..bba2ad23fe 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -1502,6 +1502,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 @@ -1688,6 +1759,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 @@ -8615,6 +8761,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 @@ -13804,6 +14024,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 @@ -67859,6 +68154,287 @@ components: - assignee - created_at additionalProperties: false + copilot-ide-code-completions: + type: object + description: Usage metrics for Copilot editor code completions in the IDE. + nullable: true + 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 + nullable: true + 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 + description: Usage metrics for Copilot Chat in the IDE. + nullable: true + 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 + nullable: true + 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 + description: Usage metrics for Copilot Chat in github.com + nullable: true + 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 + description: The training date for the custom model (if applicable). + nullable: true + 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 + description: Usage metrics for Copilot for pull requests. + nullable: true + 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 + nullable: true + 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. @@ -196922,6 +197498,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' @@ -221045,6 +221720,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. @@ -222136,6 +222818,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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 0771a47891..1bd12dc337 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -16676,6 +16676,646 @@ } } }, + "/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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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", @@ -19956,6 +20596,655 @@ } } }, + "/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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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", @@ -69957,6 +71246,646 @@ } } }, + "/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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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", @@ -125278,6 +127207,655 @@ } } }, + "/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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 2b183af347..fec7258842 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -838,7 +838,7 @@ paths: - subscriptions_url - type - url - type: &223 + type: &226 type: string description: The type of credit the user is receiving. enum: @@ -971,7 +971,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &95 + schema: &98 title: Validation Error Simple description: Validation Error Simple type: object @@ -1004,7 +1004,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &534 + - &537 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1122,7 +1122,7 @@ paths: GitHub. type: object nullable: true - properties: &56 + properties: &59 id: description: Unique identifier of the GitHub app example: 37 @@ -1211,7 +1211,7 @@ paths: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' - required: &57 + required: &60 - id - node_id - owner @@ -1516,7 +1516,7 @@ paths: schema: type: integer default: 30 - - &155 + - &158 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 @@ -1537,7 +1537,7 @@ paths: application/json: schema: type: array - items: &156 + items: &159 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1614,7 +1614,7 @@ paths: - installation_id - repository_id examples: - default: &157 + default: &160 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1673,7 +1673,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &94 + schema: &97 title: Validation Error description: Validation Error type: object @@ -1742,7 +1742,7 @@ paths: description: Response content: application/json: - schema: &158 + schema: &161 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1856,7 +1856,7 @@ paths: - request - response examples: - default: &159 + default: &162 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1916,7 +1916,7 @@ paths: parameters: - *17 responses: - '202': &96 + '202': &99 description: Accepted content: application/json: @@ -2111,7 +2111,7 @@ paths: parameters: - *18 - *20 - - &62 + - &65 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) @@ -2835,11 +2835,11 @@ paths: - selected repositories: type: array - items: &55 + items: &58 title: Repository description: A repository on GitHub. type: object - properties: &203 + properties: &206 id: description: Unique identifier of the repository example: 42 @@ -2859,7 +2859,7 @@ paths: title: License Simple description: License Simple type: object - properties: &73 + properties: &76 key: type: string example: mit @@ -2881,7 +2881,7 @@ paths: html_url: type: string format: uri - required: &74 + required: &77 - key - name - url @@ -3268,7 +3268,7 @@ paths: type: boolean description: Whether anonymous git access is enabled for this repository - required: &204 + required: &207 - archive_url - assignees_url - blobs_url @@ -6964,7 +6964,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &136 + items: &139 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -6975,7 +6975,7 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: &89 + properties: &92 login: type: string example: github @@ -7016,7 +7016,7 @@ paths: type: string example: A great organization nullable: true - required: &90 + required: &93 - login - url - id @@ -7034,7 +7034,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &166 + - &169 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -7093,7 +7093,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &181 + properties: &184 id: description: Unique identifier of the team type: integer @@ -7149,7 +7149,7 @@ paths: maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string - required: &182 + required: &185 - id - node_id - url @@ -7260,7 +7260,7 @@ paths: - created_at additionalProperties: false examples: - default: &137 + default: &140 value: total_seats: 2 seats: @@ -7342,6 +7342,479 @@ 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: + - *40 + - 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 + - *20 + - 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: &53 + 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 + description: Usage metrics for Copilot editor code completions + in the IDE. + nullable: true + 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 + nullable: true + 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 + description: Usage metrics for Copilot Chat in the IDE. + nullable: true + 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 + nullable: true + 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 + description: Usage metrics for Copilot Chat in github.com + nullable: true + 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 + description: The training date for the custom model + (if applicable). + nullable: true + 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 + description: Usage metrics for Copilot for pull requests. + nullable: true + 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 + nullable: true + 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: &54 + 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': *41 + '403': *29 + '404': *7 + '422': &55 + 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 @@ -7399,7 +7872,7 @@ paths: application/json: schema: type: array - items: &53 + items: &56 title: Copilot Usage Metrics description: Summary of Copilot usage. type: object @@ -7578,7 +8051,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &139 + - &142 name: state in: query description: |- @@ -7587,7 +8060,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &140 + - &143 name: severity in: query description: |- @@ -7596,7 +8069,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &141 + - &144 name: ecosystem in: query description: |- @@ -7605,14 +8078,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &142 + - &145 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 - - &143 + - &146 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -7622,7 +8095,7 @@ paths: enum: - development - runtime - - &144 + - &147 name: sort in: query description: |- @@ -7638,7 +8111,7 @@ paths: - *42 - *43 - *44 - - &145 + - &148 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -7651,7 +8124,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &146 + - &149 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -7671,7 +8144,7 @@ paths: application/json: schema: type: array - items: &147 + items: &150 type: object description: A Dependabot alert. properties: @@ -7724,7 +8197,7 @@ paths: enum: - development - runtime - security_advisory: &386 + security_advisory: &389 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -7942,13 +8415,13 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &124 + updated_at: &127 type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_at: &126 + dismissed_at: &129 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -7978,14 +8451,14 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &125 + fixed_at: &128 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &387 + auto_dismissed_at: &390 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -8288,7 +8761,7 @@ paths: - repository additionalProperties: false examples: - default: &148 + default: &151 value: - number: 2 state: dismissed @@ -8632,7 +9105,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *40 - - &214 + - &217 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -8643,7 +9116,7 @@ paths: enum: - open - resolved - - &215 + - &218 name: secret_type in: query description: |- @@ -8653,7 +9126,7 @@ paths: required: false schema: type: string - - &216 + - &219 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -8662,7 +9135,7 @@ paths: required: false schema: type: string - - &217 + - &220 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. @@ -8678,7 +9151,7 @@ paths: - *18 - *43 - *44 - - &218 + - &221 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -8687,7 +9160,7 @@ paths: required: false schema: type: string - - &219 + - &222 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -8696,7 +9169,7 @@ paths: schema: type: boolean default: false - - &220 + - &223 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -8712,7 +9185,7 @@ paths: application/json: schema: type: array - items: &221 + items: &224 type: object properties: number: *48 @@ -8731,14 +9204,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &527 + state: &530 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: &528 + resolution: &531 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -8813,7 +9286,7 @@ paths: repositories in the same organization or enterprise. nullable: true examples: - default: &222 + default: &225 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -9022,7 +9495,7 @@ paths: headers: Link: *39 '404': *7 - '503': &60 + '503': &63 description: Service unavailable content: application/json: @@ -9040,6 +9513,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: + - *40 + - 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 + - *20 + - 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: *53 + examples: + default: *54 + '500': *41 + '403': *29 + '404': *7 + '422': *55 + 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 @@ -9069,7 +9616,7 @@ paths: url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team parameters: - *40 - - &178 + - &181 name: team_slug description: The slug of the team name. in: path @@ -9107,9 +9654,9 @@ paths: application/json: schema: type: array - items: *53 + items: *56 examples: - default: &138 + default: &141 value: - day: '2023-10-15' total_suggestions_count: 1000 @@ -9204,7 +9751,7 @@ paths: application/json: schema: type: array - items: &84 + items: &87 title: Event description: Event type: object @@ -9214,7 +9761,7 @@ paths: type: type: string nullable: true - actor: &54 + actor: &57 title: Actor description: Actor type: object @@ -9254,18 +9801,18 @@ paths: - id - name - url - org: *54 + org: *57 payload: type: object properties: action: type: string - issue: &72 + issue: &75 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &435 + properties: &438 id: type: integer format: int64 @@ -9376,7 +9923,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &371 + properties: &374 url: type: string format: uri @@ -9446,7 +9993,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &372 + required: &375 - closed_issues - creator - description @@ -9525,7 +10072,7 @@ paths: timeline_url: type: string format: uri - repository: *55 + repository: *58 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -9535,9 +10082,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 - author_association: &58 + properties: *59 + required: *60 + author_association: &61 title: author_association type: string example: OWNER @@ -9551,7 +10098,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &59 + reactions: &62 title: Reaction Rollup type: object properties: @@ -9587,7 +10134,7 @@ paths: - hooray - eyes - rocket - required: &436 + required: &439 - assignee - closed_at - comments @@ -9609,7 +10156,7 @@ paths: - author_association - created_at - updated_at - comment: &433 + comment: &436 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -9657,7 +10204,7 @@ paths: issue_url: type: string format: uri - author_association: *58 + author_association: *61 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -9667,9 +10214,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 - reactions: *59 + properties: *59 + required: *60 + reactions: *62 required: - id - node_id @@ -9764,7 +10311,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -9845,7 +10392,7 @@ paths: _links: type: object properties: - timeline: &61 + timeline: &64 title: Link With Type description: Hypermedia Link with Type type: object @@ -9857,17 +10404,17 @@ paths: required: - href - type - user: *61 - security_advisories: *61 - current_user: *61 - current_user_public: *61 - current_user_actor: *61 - current_user_organization: *61 + user: *64 + security_advisories: *64 + current_user: *64 + current_user_public: *64 + current_user_actor: *64 + current_user_organization: *64 current_user_organizations: type: array - items: *61 - repository_discussions: *61 - repository_discussions_category: *61 + items: *64 + repository_discussions: *64 + repository_discussions_category: *64 required: - timeline - user @@ -9929,7 +10476,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *62 + - *65 - *18 - *20 responses: @@ -9939,7 +10486,7 @@ paths: application/json: schema: type: array - items: &63 + items: &66 title: Base Gist description: Base Gist type: object @@ -10031,7 +10578,7 @@ paths: - created_at - updated_at examples: - default: &64 + default: &67 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -10152,7 +10699,7 @@ paths: description: Response content: application/json: - schema: &65 + schema: &68 title: Gist Simple description: Gist Simple type: object @@ -10169,7 +10716,7 @@ paths: url: type: string format: uri - user: &557 + user: &560 title: Public User description: Public User type: object @@ -10522,7 +11069,7 @@ paths: truncated: type: boolean examples: - default: &66 + default: &69 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -10624,7 +11171,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *62 + - *65 - *18 - *20 responses: @@ -10634,9 +11181,9 @@ paths: application/json: schema: type: array - items: *63 + items: *66 examples: - default: *64 + default: *67 headers: Link: *39 '422': *16 @@ -10658,7 +11205,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *62 + - *65 - *18 - *20 responses: @@ -10668,9 +11215,9 @@ paths: application/json: schema: type: array - items: *63 + items: *66 examples: - default: *64 + default: *67 headers: Link: *39 '401': *25 @@ -10698,7 +11245,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &67 + - &70 name: gist_id description: The unique identifier of the gist. in: path @@ -10710,10 +11257,10 @@ paths: description: Response content: application/json: - schema: *65 + schema: *68 examples: - default: *66 - '403': &70 + default: *69 + '403': &73 description: Forbidden Gist content: application/json: @@ -10761,7 +11308,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *67 + - *70 requestBody: required: true content: @@ -10821,9 +11368,9 @@ paths: description: Response content: application/json: - schema: *65 + schema: *68 examples: - updateGist: *66 + updateGist: *69 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -10981,7 +11528,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *67 + - *70 responses: '204': description: Response @@ -11010,7 +11557,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *67 + - *70 - *18 - *20 responses: @@ -11020,7 +11567,7 @@ paths: application/json: schema: type: array - items: &68 + items: &71 title: Gist Comment description: A comment made to a gist. type: object @@ -11055,7 +11602,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *58 + author_association: *61 required: - url - id @@ -11120,7 +11667,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *67 + - *70 requestBody: required: true content: @@ -11145,9 +11692,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *71 examples: - default: &69 + default: &72 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -11205,8 +11752,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *67 - - &71 + - *70 + - &74 name: comment_id description: The unique identifier of the comment. in: path @@ -11219,12 +11766,12 @@ paths: description: Response content: application/json: - schema: *68 + schema: *71 examples: - default: *69 + default: *72 '304': *37 '404': *7 - '403': *70 + '403': *73 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11246,8 +11793,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *67 - - *71 + - *70 + - *74 requestBody: required: true content: @@ -11272,9 +11819,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *71 examples: - default: *69 + default: *72 '404': *7 x-github: githubCloudOnly: false @@ -11291,8 +11838,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *67 - - *71 + - *70 + - *74 responses: '204': description: Response @@ -11315,7 +11862,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *67 + - *70 - *18 - *20 responses: @@ -11416,7 +11963,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *67 + - *70 - *18 - *20 responses: @@ -11426,7 +11973,7 @@ paths: application/json: schema: type: array - items: *65 + items: *68 examples: default: value: @@ -11491,13 +12038,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *67 + - *70 responses: '201': description: Response content: application/json: - schema: *63 + schema: *66 examples: default: value: @@ -11568,7 +12115,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *67 + - *70 responses: '204': description: Response if gist is starred @@ -11598,7 +12145,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *67 + - *70 responses: '204': description: Response @@ -11620,7 +12167,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *67 + - *70 responses: '204': description: Response @@ -11649,7 +12196,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *67 + - *70 - name: sha in: path required: true @@ -11660,9 +12207,9 @@ paths: description: Response content: application/json: - schema: *65 + schema: *68 examples: - default: *66 + default: *69 '422': *16 '404': *7 '403': *29 @@ -11821,7 +12368,7 @@ paths: type: integer repositories: type: array - items: *55 + items: *58 repository_selection: type: string example: selected @@ -12028,7 +12575,7 @@ paths: - closed - all default: open - - &167 + - &170 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -12047,7 +12594,7 @@ paths: - comments default: created - *42 - - *62 + - *65 - name: collab in: query required: false @@ -12077,9 +12624,9 @@ paths: application/json: schema: type: array - items: *72 + items: *75 examples: - default: &168 + default: &171 value: - id: 1 node_id: MDU6SXNzdWUx @@ -12363,8 +12910,8 @@ paths: title: License Simple description: License Simple type: object - properties: *73 - required: *74 + properties: *76 + required: *77 examples: default: value: @@ -12648,7 +13195,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &75 + X-CommonMarker-Version: &78 example: 0.17.4 schema: type: string @@ -12703,7 +13250,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *75 + X-CommonMarker-Version: *78 content: text/html: schema: @@ -12732,7 +13279,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &78 + - &81 name: account_id description: account_id parameter in: path @@ -12744,7 +13291,7 @@ paths: description: Response content: application/json: - schema: &77 + schema: &80 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -12774,7 +13321,7 @@ paths: nullable: true id: type: integer - plan: &76 + plan: &79 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -12863,7 +13410,7 @@ paths: nullable: true updated_at: type: string - plan: *76 + plan: *79 required: - url - id @@ -12871,7 +13418,7 @@ paths: - login - marketplace_purchase examples: - default: &79 + default: &82 value: url: https://api.github.com/orgs/github type: Organization @@ -12956,9 +13503,9 @@ paths: application/json: schema: type: array - items: *76 + items: *79 examples: - default: &80 + default: &83 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -12998,14 +13545,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &81 + - &84 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &82 + - &85 name: sort description: The property to sort the results by. in: query @@ -13035,9 +13582,9 @@ paths: application/json: schema: type: array - items: *77 + items: *80 examples: - default: &83 + default: &86 value: - url: https://api.github.com/orgs/github type: Organization @@ -13111,15 +13658,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *78 + - *81 responses: '200': description: Response content: application/json: - schema: *77 + schema: *80 examples: - default: *79 + default: *82 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -13151,9 +13698,9 @@ paths: application/json: schema: type: array - items: *76 + items: *79 examples: - default: *80 + default: *83 headers: Link: *39 '401': *25 @@ -13176,8 +13723,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *81 - - *82 + - *84 + - *85 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -13197,9 +13744,9 @@ paths: application/json: schema: type: array - items: *77 + items: *80 examples: - default: *83 + default: *86 headers: Link: *39 '401': *25 @@ -13448,14 +13995,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &239 + - &242 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &240 + - &243 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -13472,7 +14019,7 @@ paths: application/json: schema: type: array - items: *84 + items: *87 examples: default: value: @@ -13526,7 +14073,7 @@ paths: '404': *7 '403': *29 '304': *37 - '301': &251 + '301': &254 description: Moved permanently content: application/json: @@ -13548,7 +14095,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &464 + - &467 name: all description: If `true`, show notifications marked as read. in: query @@ -13556,7 +14103,7 @@ paths: schema: type: boolean default: false - - &465 + - &468 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -13565,8 +14112,8 @@ paths: schema: type: boolean default: false - - *62 - - &466 + - *65 + - &469 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: @@ -13591,18 +14138,18 @@ paths: application/json: schema: type: array - items: &85 + items: &88 title: Thread description: Thread type: object properties: id: type: string - repository: &110 + repository: &113 title: Minimal Repository description: Minimal Repository type: object - properties: &150 + properties: &153 id: type: integer format: int64 @@ -13878,7 +14425,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &205 + security_and_analysis: &208 nullable: true type: object properties: @@ -13934,7 +14481,7 @@ paths: enum: - enabled - disabled - required: &151 + required: &154 - archive_url - assignees_url - blobs_url @@ -14022,7 +14569,7 @@ paths: - url - subscription_url examples: - default: &467 + default: &470 value: - id: '1' repository: @@ -14188,7 +14735,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &86 + - &89 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 @@ -14202,7 +14749,7 @@ paths: description: Response content: application/json: - schema: *85 + schema: *88 examples: default: value: @@ -14304,7 +14851,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *86 + - *89 responses: '205': description: Reset Content @@ -14326,7 +14873,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *86 + - *89 responses: '204': description: No content @@ -14349,13 +14896,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &87 + schema: &90 title: Thread Subscription description: Thread Subscription type: object @@ -14392,7 +14939,7 @@ paths: - url - subscribed examples: - default: &88 + default: &91 value: subscribed: true ignored: false @@ -14423,7 +14970,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *86 + - *89 requestBody: required: false content: @@ -14444,9 +14991,9 @@ paths: description: Response content: application/json: - schema: *87 + schema: *90 examples: - default: *88 + default: *91 '304': *37 '403': *29 '401': *25 @@ -14469,7 +15016,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *86 + - *89 responses: '204': description: Response @@ -14564,14 +15111,14 @@ paths: application/json: schema: type: array - items: &173 + items: &176 title: Organization Simple description: A GitHub organization. type: object - properties: *89 - required: *90 + properties: *92 + required: *93 examples: - default: &575 + default: &578 value: - login: github id: 1 @@ -14616,7 +15163,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - &91 + - &94 name: org description: The organization name. The name is not case sensitive. in: path @@ -14628,7 +15175,7 @@ paths: description: Response content: application/json: - schema: &92 + schema: &95 title: Organization Full description: Organization Full type: object @@ -14912,7 +15459,7 @@ paths: - updated_at - archived_at examples: - default-response: &93 + default-response: &96 value: login: github id: 1 @@ -15002,7 +15549,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *91 + - *94 requestBody: required: false content: @@ -15214,18 +15761,18 @@ paths: description: Response content: application/json: - schema: *92 + schema: *95 examples: - default: *93 + default: *96 '422': description: Validation failed content: application/json: schema: oneOf: - - *94 - - *95 - '409': &131 + - *97 + - *98 + '409': &134 description: Conflict content: application/json: @@ -15252,9 +15799,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *91 + - *94 responses: - '202': *96 + '202': *99 '404': *7 '403': *29 x-github: @@ -15277,7 +15824,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response @@ -15324,7 +15871,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: - - *91 + - *94 - *18 - *20 responses: @@ -15342,7 +15889,7 @@ paths: type: integer repository_cache_usages: type: array - items: &256 + items: &259 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -15397,13 +15944,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: - - *91 + - *94 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &97 + schema: &100 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -15417,7 +15964,7 @@ paths: required: - include_claim_keys examples: - default: &98 + default: &101 value: include_claim_keys: - repo @@ -15439,20 +15986,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: - - *91 + - *94 requestBody: required: true content: application/json: - schema: *97 + schema: *100 examples: - default: *98 + default: *101 responses: '201': description: Empty response content: application/json: - schema: &119 + schema: &122 title: Empty Object description: An object without any properties. type: object @@ -15482,7 +16029,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response @@ -15491,7 +16038,7 @@ paths: schema: type: object properties: - enabled_repositories: &99 + enabled_repositories: &102 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -15504,7 +16051,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: &100 + allowed_actions: &103 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -15512,7 +16059,7 @@ paths: - all - local_only - selected - selected_actions_url: &262 + selected_actions_url: &265 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` @@ -15543,7 +16090,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *91 + - *94 responses: '204': description: Response @@ -15554,8 +16101,8 @@ paths: schema: type: object properties: - enabled_repositories: *99 - allowed_actions: *100 + enabled_repositories: *102 + allowed_actions: *103 required: - enabled_repositories examples: @@ -15582,7 +16129,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: - - *91 + - *94 - *18 - *20 responses: @@ -15600,9 +16147,9 @@ paths: type: number repositories: type: array - items: *55 + items: *58 examples: - default: &569 + default: &572 value: total_count: 1 repositories: @@ -15742,7 +16289,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: - - *91 + - *94 responses: '204': description: Response @@ -15786,8 +16333,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: - - *91 - - &101 + - *94 + - &104 name: repository_id description: The unique identifier of the repository. in: path @@ -15815,8 +16362,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: - - *91 - - *101 + - *94 + - *104 responses: '204': description: Response @@ -15839,13 +16386,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: &102 + schema: &105 type: object properties: github_owned_allowed: @@ -15867,7 +16414,7 @@ paths: items: type: string examples: - default: &103 + default: &106 value: github_owned_allowed: true verified_allowed: false @@ -15892,7 +16439,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *91 + - *94 responses: '204': description: Response @@ -15900,9 +16447,9 @@ paths: required: false content: application/json: - schema: *102 + schema: *105 examples: - selected_actions: *103 + selected_actions: *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -15924,23 +16471,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: &266 + schema: &269 type: object properties: - default_workflow_permissions: &104 + default_workflow_permissions: &107 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &105 + can_approve_pull_request_reviews: &108 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -15948,7 +16495,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &106 + default: &109 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -15973,7 +16520,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *91 + - *94 responses: '204': description: Success response @@ -15981,13 +16528,13 @@ paths: required: false content: application/json: - schema: &267 + schema: &270 type: object properties: - default_workflow_permissions: *104 - can_approve_pull_request_reviews: *105 + default_workflow_permissions: *107 + can_approve_pull_request_reviews: *108 examples: - default: *106 + default: *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16007,7 +16554,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: - - *91 + - *94 - *18 - *20 - name: visible_to_repository @@ -16032,7 +16579,7 @@ paths: type: number runner_groups: type: array - items: &107 + items: &110 type: object properties: id: @@ -16144,7 +16691,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: - - *91 + - *94 requestBody: required: true content: @@ -16213,9 +16760,9 @@ paths: description: Response content: application/json: - schema: *107 + schema: *110 examples: - default: &109 + default: &112 value: id: 2 name: octo-runner-group @@ -16250,8 +16797,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: - - *91 - - &108 + - *94 + - &111 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -16263,7 +16810,7 @@ paths: description: Response content: application/json: - schema: *107 + schema: *110 examples: default: value: @@ -16299,8 +16846,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: - - *91 - - *108 + - *94 + - *111 requestBody: required: true content: @@ -16350,9 +16897,9 @@ paths: description: Response content: application/json: - schema: *107 + schema: *110 examples: - default: *109 + default: *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -16371,8 +16918,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: - - *91 - - *108 + - *94 + - *111 responses: '204': description: Response @@ -16395,8 +16942,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: - - *91 - - *108 + - *94 + - *111 - *20 - *18 responses: @@ -16414,9 +16961,9 @@ paths: type: number repositories: type: array - items: *110 + items: *113 examples: - default: &560 + default: &563 value: total_count: 1 repositories: @@ -16668,8 +17215,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: - - *91 - - *108 + - *94 + - *111 requestBody: required: true content: @@ -16713,9 +17260,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: - - *91 - - *108 - - *101 + - *94 + - *111 + - *104 responses: '204': description: Response @@ -16737,9 +17284,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: - - *91 - - *108 - - *101 + - *94 + - *111 + - *104 responses: '204': description: Response @@ -16762,8 +17309,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: - - *91 - - *108 + - *94 + - *111 - *18 - *20 responses: @@ -16781,7 +17328,7 @@ paths: type: number runners: type: array - items: &112 + items: &115 title: Self hosted runners description: A self hosted runner type: object @@ -16810,7 +17357,7 @@ paths: type: boolean labels: type: array - items: &115 + items: &118 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -16838,7 +17385,7 @@ paths: - busy - labels examples: - default: &113 + default: &116 value: total_count: 2 runners: @@ -16895,8 +17442,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: - - *91 - - *108 + - *94 + - *111 requestBody: required: true content: @@ -16940,9 +17487,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: - - *91 - - *108 - - &111 + - *94 + - *111 + - &114 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -16970,9 +17517,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: - - *91 - - *108 + - *94 - *111 + - *114 responses: '204': description: Response @@ -17002,7 +17549,7 @@ paths: in: query schema: type: string - - *91 + - *94 - *18 - *20 responses: @@ -17020,9 +17567,9 @@ paths: type: integer runners: type: array - items: *112 + items: *115 examples: - default: *113 + default: *116 headers: Link: *39 x-github: @@ -17046,7 +17593,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response @@ -17054,7 +17601,7 @@ paths: application/json: schema: type: array - items: &268 + items: &271 title: Runner Application description: Runner Application type: object @@ -17079,7 +17626,7 @@ paths: - download_url - filename examples: - default: &269 + default: &272 value: - os: osx architecture: x64 @@ -17122,7 +17669,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: - - *91 + - *94 requestBody: required: true content: @@ -17165,7 +17712,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &270 + '201': &273 description: Response content: application/json: @@ -17175,7 +17722,7 @@ paths: - runner - encoded_jit_config properties: - runner: *112 + runner: *115 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -17231,13 +17778,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *91 + - *94 responses: '201': description: Response content: application/json: - schema: &114 + schema: &117 title: Authentication Token description: Authentication Token type: object @@ -17259,7 +17806,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *55 + items: *58 single_file: type: string example: config.yaml @@ -17275,7 +17822,7 @@ paths: - token - expires_at examples: - default: &271 + default: &274 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -17306,15 +17853,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *91 + - *94 responses: '201': description: Response content: application/json: - schema: *114 + schema: *117 examples: - default: &272 + default: &275 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -17339,16 +17886,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: - - *91 - - *111 + - *94 + - *114 responses: '200': description: Response content: application/json: - schema: *112 + schema: *115 examples: - default: &273 + default: &276 value: id: 23 name: MBP @@ -17388,8 +17935,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: - - *91 - - *111 + - *94 + - *114 responses: '204': description: Response @@ -17414,10 +17961,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: - - *91 - - *111 + - *94 + - *114 responses: - '200': &116 + '200': &119 description: Response content: application/json: @@ -17431,7 +17978,7 @@ paths: type: integer labels: type: array - items: *115 + items: *118 examples: default: value: @@ -17470,8 +18017,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: - - *91 - - *111 + - *94 + - *114 requestBody: required: true content: @@ -17495,7 +18042,7 @@ paths: - gpu - accelerated responses: - '200': *116 + '200': *119 '404': *7 '422': *8 x-github: @@ -17519,8 +18066,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: - - *91 - - *111 + - *94 + - *114 requestBody: required: true content: @@ -17545,7 +18092,7 @@ paths: - gpu - accelerated responses: - '200': *116 + '200': *119 '404': *7 '422': *8 x-github: @@ -17569,10 +18116,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: - - *91 - - *111 + - *94 + - *114 responses: - '200': &274 + '200': &277 description: Response content: application/json: @@ -17586,7 +18133,7 @@ paths: type: integer labels: type: array - items: *115 + items: *118 examples: default: value: @@ -17627,9 +18174,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: - - *91 - - *111 - - &275 + - *94 + - *114 + - &278 name: name description: The name of a self-hosted runner's custom label. in: path @@ -17637,7 +18184,7 @@ paths: schema: type: string responses: - '200': *116 + '200': *119 '404': *7 '422': *8 x-github: @@ -17662,7 +18209,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *91 + - *94 - *18 - *20 responses: @@ -17680,7 +18227,7 @@ paths: type: integer secrets: type: array - items: &117 + items: &120 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -17753,13 +18300,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: &287 + schema: &290 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -17788,7 +18335,7 @@ paths: - key_id - key examples: - default: &288 + default: &291 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -17813,8 +18360,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *91 - - &118 + - *94 + - &121 name: secret_name description: The name of the secret. in: path @@ -17826,7 +18373,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *120 examples: default: value: @@ -17856,8 +18403,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 requestBody: required: true content: @@ -17912,7 +18459,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -17938,8 +18485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 responses: '204': description: Response @@ -17965,8 +18512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - *20 - *18 responses: @@ -17984,9 +18531,9 @@ paths: type: integer repositories: type: array - items: *110 + items: *113 examples: - default: &122 + default: &125 value: total_count: 1 repositories: @@ -18078,8 +18625,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 requestBody: required: true content: @@ -18131,8 +18678,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - name: repository_id in: path required: true @@ -18165,8 +18712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - name: repository_id in: path required: true @@ -18198,8 +18745,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *91 - - &261 + - *94 + - &264 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)." @@ -18223,7 +18770,7 @@ paths: type: integer variables: type: array - items: &120 + items: &123 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -18308,7 +18855,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *91 + - *94 requestBody: required: true content: @@ -18356,7 +18903,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -18381,8 +18928,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *91 - - &121 + - *94 + - &124 name: name description: The name of the variable. in: path @@ -18394,7 +18941,7 @@ paths: description: Response content: application/json: - schema: *120 + schema: *123 examples: default: value: @@ -18424,8 +18971,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *91 - - *121 + - *94 + - *124 requestBody: required: true content: @@ -18487,8 +19034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *91 - - *121 + - *94 + - *124 responses: '204': description: Response @@ -18514,8 +19061,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *91 - - *121 + - *94 + - *124 - *20 - *18 responses: @@ -18533,9 +19080,9 @@ paths: type: integer repositories: type: array - items: *110 + items: *113 examples: - default: *122 + default: *125 '409': description: Response when the visibility of the variable is not set to `selected` @@ -18561,8 +19108,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *91 - - *121 + - *94 + - *124 requestBody: required: true content: @@ -18611,8 +19158,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *91 - - *121 + - *94 + - *124 - name: repository_id in: path required: true @@ -18646,8 +19193,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *91 - - *121 + - *94 + - *124 - name: repository_id in: path required: true @@ -18683,7 +19230,7 @@ paths: - *18 - *43 - *44 - - *91 + - *94 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -18724,7 +19271,7 @@ paths: repository_id: type: integer examples: - default: &301 + default: &304 value: attestations: - bundle: @@ -18831,7 +19378,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *91 + - *94 - *18 - *20 responses: @@ -18843,7 +19390,7 @@ paths: type: array items: *19 examples: - default: &169 + default: &172 value: - login: octocat id: 1 @@ -18881,8 +19428,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *91 - - &123 + - *94 + - &126 name: username description: The handle for the GitHub user account. in: path @@ -18913,8 +19460,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -18934,8 +19481,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -18960,18 +19507,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *91 - - &327 + - *94 + - &330 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: &127 + schema: &130 type: string description: The name of the tool used to generate the code scanning analysis. - - &328 + - &331 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 @@ -18979,7 +19526,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &128 + schema: &131 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, @@ -18994,7 +19541,7 @@ paths: be returned. in: query required: false - schema: &330 + schema: &333 type: string description: State of a code scanning alert. enum: @@ -19017,7 +19564,7 @@ paths: be returned. in: query required: false - schema: &331 + schema: &334 type: string description: Severity of a code scanning alert. enum: @@ -19040,16 +19587,16 @@ paths: properties: number: *48 created_at: *49 - updated_at: *124 + updated_at: *127 url: *50 html_url: *51 - instances_url: &332 + instances_url: &335 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &129 + state: &132 type: string description: State of a code scanning alert. nullable: true @@ -19057,7 +19604,7 @@ paths: - open - dismissed - fixed - fixed_at: *125 + fixed_at: *128 dismissed_by: title: Simple User description: A GitHub user. @@ -19065,8 +19612,8 @@ paths: properties: *4 required: *5 nullable: true - dismissed_at: *126 - dismissed_reason: &333 + dismissed_at: *129 + dismissed_reason: &336 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -19075,13 +19622,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &334 + dismissed_comment: &337 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &335 + rule: &338 type: object properties: id: @@ -19134,25 +19681,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &336 + tool: &339 type: object properties: - name: *127 + name: *130 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *128 - most_recent_instance: &337 + guid: *131 + most_recent_instance: &340 type: object properties: - ref: &329 + ref: &332 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &343 + analysis_key: &346 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -19163,13 +19710,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &344 + category: &347 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: *129 + state: *132 commit_sha: type: string message: @@ -19455,7 +20002,7 @@ paths: headers: Link: *39 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19477,7 +20024,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *91 + - *94 - name: target_type in: query description: The target type of the code security configuration @@ -19505,7 +20052,7 @@ paths: application/json: schema: type: array - items: &130 + items: &133 type: object description: A code security configuration properties: @@ -19744,7 +20291,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *91 + - *94 requestBody: required: true content: @@ -19916,9 +20463,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *130 + schema: *133 examples: - default: &132 + default: &135 value: id: 1325 target_type: organization @@ -19964,7 +20511,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *91 + - *94 responses: '200': description: Response @@ -19984,7 +20531,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *130 + configuration: *133 examples: default: value: @@ -20068,7 +20615,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *91 + - *94 requestBody: required: true content: @@ -20091,12 +20638,12 @@ paths: - 32 - 91 responses: - '204': &134 + '204': &137 description: A header with no content is returned. '400': *15 '403': *29 '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20118,8 +20665,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *91 - - &133 + - *94 + - &136 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -20131,9 +20678,9 @@ paths: description: Response content: application/json: - schema: *130 + schema: *133 examples: - default: *132 + default: *135 '304': *37 '403': *29 '404': *7 @@ -20157,8 +20704,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *91 - - *133 + - *94 + - *136 requestBody: required: true content: @@ -20310,7 +20857,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *130 + schema: *133 examples: default: value: @@ -20361,14 +20908,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *91 - - *133 + - *94 + - *136 responses: - '204': *134 + '204': *137 '400': *15 '403': *29 '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20392,8 +20939,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *91 - - *133 + - *94 + - *136 requestBody: required: true content: @@ -20432,7 +20979,7 @@ paths: - 32 - 91 responses: - '202': *96 + '202': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20456,8 +21003,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: - - *91 - - *133 + - *94 + - *136 requestBody: required: true content: @@ -20497,12 +21044,12 @@ paths: - none - private_and_internal - public - configuration: *130 + configuration: *133 examples: default: value: default_for_new_repos: all - configuration: *132 + configuration: *135 '403': *29 '404': *7 x-github: @@ -20526,8 +21073,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *91 - - *133 + - *94 + - *136 - 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)." @@ -20670,7 +21217,7 @@ paths: parameters: - *18 - *20 - - *91 + - *94 responses: '200': description: Response @@ -20686,7 +21233,7 @@ paths: type: integer codespaces: type: array - items: &170 + items: &173 type: object title: Codespace description: A codespace. @@ -20711,12 +21258,12 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *110 + repository: *113 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &357 + properties: &360 name: type: string description: The name of the machine. @@ -20758,7 +21305,7 @@ paths: - ready - in_progress nullable: true - required: &358 + required: &361 - name - display_name - operating_system @@ -20963,7 +21510,7 @@ paths: - pulls_url - recent_folders examples: - default: &171 + default: &174 value: total_count: 3 codespaces: @@ -21395,7 +21942,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *91 + - *94 deprecated: true requestBody: required: true @@ -21462,7 +22009,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *91 + - *94 deprecated: true requestBody: required: true @@ -21517,7 +22064,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *91 + - *94 requestBody: required: true content: @@ -21569,7 +22116,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *91 + - *94 - *18 - *20 responses: @@ -21587,7 +22134,7 @@ paths: type: integer secrets: type: array - items: &135 + items: &138 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -21626,7 +22173,7 @@ paths: - updated_at - visibility examples: - default: &359 + default: &362 value: total_count: 2 secrets: @@ -21658,13 +22205,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: &360 + schema: &363 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -21693,7 +22240,7 @@ paths: - key_id - key examples: - default: &361 + default: &364 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -21716,16 +22263,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 responses: '200': description: Response content: application/json: - schema: *135 + schema: *138 examples: - default: &363 + default: &366 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -21752,8 +22299,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 requestBody: required: true content: @@ -21808,7 +22355,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -21834,8 +22381,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 responses: '204': description: Response @@ -21860,8 +22407,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - *20 - *18 responses: @@ -21879,9 +22426,9 @@ paths: type: integer repositories: type: array - items: *110 + items: *113 examples: - default: *122 + default: *125 '404': *7 x-github: githubCloudOnly: false @@ -21903,8 +22450,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 requestBody: required: true content: @@ -21954,8 +22501,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - name: repository_id in: path required: true @@ -21988,8 +22535,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - name: repository_id in: path required: true @@ -22028,7 +22575,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: - - *91 + - *94 responses: '200': description: OK @@ -22168,7 +22715,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: - - *91 + - *94 - *20 - name: per_page description: The number of results per page (max 100). For more information, @@ -22191,9 +22738,9 @@ paths: currently being billed. seats: type: array - items: *136 + items: *139 examples: - default: *137 + default: *140 headers: Link: *39 '500': *41 @@ -22231,7 +22778,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: - - *91 + - *94 requestBody: content: application/json: @@ -22309,7 +22856,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: - - *91 + - *94 requestBody: content: application/json: @@ -22390,7 +22937,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: - - *91 + - *94 requestBody: content: application/json: @@ -22468,7 +23015,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: - - *91 + - *94 requestBody: content: application/json: @@ -22524,6 +23071,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: + - *94 + - 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 + - *20 + - 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: *53 + examples: + default: *54 + '500': *41 + '403': *29 + '404': *7 + '422': *55 + 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 @@ -22549,7 +23164,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: - - *91 + - *94 - 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`). @@ -22581,9 +23196,9 @@ paths: application/json: schema: type: array - items: *53 + items: *56 examples: - default: *138 + default: *141 '500': *41 '401': *25 '403': *29 @@ -22609,18 +23224,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *91 - - *139 - - *140 - - *141 + - *94 - *142 - *143 - *144 + - *145 + - *146 + - *147 - *42 - *43 - *44 - - *145 - - *146 + - *148 + - *149 - *18 responses: '200': @@ -22629,9 +23244,9 @@ paths: application/json: schema: type: array - items: *147 + items: *150 examples: - default: *148 + default: *151 '304': *37 '400': *15 '403': *29 @@ -22657,7 +23272,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *91 + - *94 - *18 - *20 responses: @@ -22675,7 +23290,7 @@ paths: type: integer secrets: type: array - items: &149 + items: &152 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -22746,13 +23361,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: &390 + schema: &393 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -22769,7 +23384,7 @@ paths: - key_id - key examples: - default: &391 + default: &394 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -22792,14 +23407,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 responses: '200': description: Response content: application/json: - schema: *149 + schema: *152 examples: default: value: @@ -22827,8 +23442,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 requestBody: required: true content: @@ -22883,7 +23498,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -22907,8 +23522,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 responses: '204': description: Response @@ -22932,8 +23547,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - *20 - *18 responses: @@ -22951,9 +23566,9 @@ paths: type: integer repositories: type: array - items: *110 + items: *113 examples: - default: *122 + default: *125 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22974,8 +23589,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 requestBody: required: true content: @@ -23025,8 +23640,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - name: repository_id in: path required: true @@ -23057,8 +23672,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - name: repository_id in: path required: true @@ -23088,7 +23703,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: - - *91 + - *94 responses: '200': description: Response @@ -23096,7 +23711,7 @@ paths: application/json: schema: type: array - items: &184 + items: &187 title: Package description: A software package type: object @@ -23146,8 +23761,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *150 - required: *151 + properties: *153 + required: *154 nullable: true created_at: type: string @@ -23166,7 +23781,7 @@ paths: - created_at - updated_at examples: - default: &185 + default: &188 value: - id: 197 name: hello_docker @@ -23244,7 +23859,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *91 + - *94 - *18 - *20 responses: @@ -23254,7 +23869,7 @@ paths: application/json: schema: type: array - items: *84 + items: *87 examples: 200-response: value: @@ -23323,7 +23938,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *91 + - *94 - *18 - *20 responses: @@ -23333,7 +23948,7 @@ paths: application/json: schema: type: array - items: &163 + items: &166 title: Organization Invitation description: Organization Invitation type: object @@ -23380,7 +23995,7 @@ paths: - invitation_teams_url - node_id examples: - default: &164 + default: &167 value: - id: 1 login: monalisa @@ -23435,7 +24050,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *91 + - *94 - *18 - *20 responses: @@ -23445,7 +24060,7 @@ paths: application/json: schema: type: array - items: &152 + items: &155 title: Org Hook description: Org Hook type: object @@ -23556,7 +24171,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *91 + - *94 requestBody: required: true content: @@ -23616,9 +24231,9 @@ paths: description: Response content: application/json: - schema: *152 + schema: *155 examples: - default: &153 + default: &156 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -23665,8 +24280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *91 - - &154 + - *94 + - &157 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. @@ -23679,9 +24294,9 @@ paths: description: Response content: application/json: - schema: *152 + schema: *155 examples: - default: *153 + default: *156 '404': *7 x-github: githubCloudOnly: false @@ -23708,8 +24323,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *91 - - *154 + - *94 + - *157 requestBody: required: false content: @@ -23754,7 +24369,7 @@ paths: description: Response content: application/json: - schema: *152 + schema: *155 examples: default: value: @@ -23793,8 +24408,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *91 - - *154 + - *94 + - *157 responses: '204': description: Response @@ -23821,8 +24436,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *91 - - *154 + - *94 + - *157 responses: '200': description: Response @@ -23852,8 +24467,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *91 - - *154 + - *94 + - *157 requestBody: required: false content: @@ -23903,10 +24518,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *91 - - *154 + - *94 + - *157 - *18 - - *155 + - *158 - name: redelivery in: query required: false @@ -23919,9 +24534,9 @@ paths: application/json: schema: type: array - items: *156 + items: *159 examples: - default: *157 + default: *160 '400': *15 '422': *16 x-github: @@ -23946,17 +24561,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *91 - - *154 + - *94 + - *157 - *17 responses: '200': description: Response content: application/json: - schema: *158 + schema: *161 examples: - default: *159 + default: *162 '400': *15 '422': *16 x-github: @@ -23981,11 +24596,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *91 - - *154 + - *94 + - *157 - *17 responses: - '202': *96 + '202': *99 '400': *15 '422': *16 x-github: @@ -24011,8 +24626,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *91 - - *154 + - *94 + - *157 responses: '204': description: Response @@ -24036,7 +24651,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *91 + - *94 responses: '200': description: Response @@ -24044,7 +24659,7 @@ paths: application/json: schema: *22 examples: - default: &429 + default: &432 value: id: 1 account: @@ -24113,7 +24728,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *91 + - *94 - *18 - *20 responses: @@ -24202,7 +24817,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response @@ -24210,12 +24825,12 @@ paths: application/json: schema: anyOf: - - &161 + - &164 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &160 + limit: &163 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -24240,7 +24855,7 @@ paths: properties: {} additionalProperties: false examples: - default: &162 + default: &165 value: limit: collaborators_only origin: organization @@ -24264,18 +24879,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *91 + - *94 requestBody: required: true content: application/json: - schema: &430 + schema: &433 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *160 + limit: *163 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -24299,9 +24914,9 @@ paths: description: Response content: application/json: - schema: *161 + schema: *164 examples: - default: *162 + default: *165 '422': *16 x-github: githubCloudOnly: false @@ -24319,7 +24934,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *91 + - *94 responses: '204': description: Response @@ -24343,7 +24958,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *91 + - *94 - *18 - *20 - name: role @@ -24377,9 +24992,9 @@ paths: application/json: schema: type: array - items: *163 + items: *166 examples: - default: *164 + default: *167 headers: Link: *39 '404': *7 @@ -24402,7 +25017,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *91 + - *94 requestBody: required: false content: @@ -24456,7 +25071,7 @@ paths: description: Response content: application/json: - schema: *163 + schema: *166 examples: default: value: @@ -24510,8 +25125,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *91 - - &165 + - *94 + - &168 name: invitation_id description: The unique identifier of the invitation. in: path @@ -24541,8 +25156,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *91 - - *165 + - *94 + - *168 - *18 - *20 responses: @@ -24552,9 +25167,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - default: &183 + default: &186 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -24599,7 +25214,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *91 + - *94 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -24629,7 +25244,7 @@ paths: - closed - all default: open - - *167 + - *170 - name: sort description: What to sort results by. in: query @@ -24642,7 +25257,7 @@ paths: - comments default: created - *42 - - *62 + - *65 - *18 - *20 responses: @@ -24652,9 +25267,9 @@ paths: application/json: schema: type: array - items: *72 + items: *75 examples: - default: *168 + default: *171 headers: Link: *39 '404': *7 @@ -24676,7 +25291,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *91 + - *94 - 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) @@ -24712,7 +25327,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 '422': *16 @@ -24732,8 +25347,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response if requester is an organization member and user is @@ -24764,8 +25379,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -24791,8 +25406,8 @@ paths: parameters: - *18 - *20 - - *91 - - *123 + - *94 + - *126 responses: '200': description: Response @@ -24808,9 +25423,9 @@ paths: type: integer codespaces: type: array - items: *170 + items: *173 examples: - default: *171 + default: *174 '304': *37 '500': *41 '401': *25 @@ -24835,9 +25450,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *91 - - *123 - - &172 + - *94 + - *126 + - &175 name: codespace_name in: path required: true @@ -24845,7 +25460,7 @@ paths: schema: type: string responses: - '202': *96 + '202': *99 '304': *37 '500': *41 '401': *25 @@ -24870,17 +25485,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *91 - - *123 - - *172 + - *94 + - *126 + - *175 responses: '200': description: Response content: application/json: - schema: *170 + schema: *173 examples: - default: &356 + default: &359 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -25050,14 +25665,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: - - *91 - - *123 + - *94 + - *126 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *136 + schema: *139 examples: default: value: @@ -25125,14 +25740,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - - *91 - - *123 + - *94 + - *126 responses: '200': description: Response content: application/json: - schema: &174 + schema: &177 title: Org Membership description: Org Membership type: object @@ -25161,7 +25776,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *173 + organization: *176 user: title: Simple User description: A GitHub user. @@ -25184,7 +25799,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &175 + response-if-user-has-an-active-admin-membership-with-organization: &178 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -25252,8 +25867,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - - *91 - - *123 + - *94 + - *126 requestBody: required: false content: @@ -25281,9 +25896,9 @@ paths: description: Response content: application/json: - schema: *174 + schema: *177 examples: - response-if-user-already-had-membership-with-organization: *175 + response-if-user-already-had-membership-with-organization: *178 '422': *16 '403': *29 x-github: @@ -25304,8 +25919,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -25330,7 +25945,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *91 + - *94 - *18 - *20 - name: exclude @@ -25351,7 +25966,7 @@ paths: application/json: schema: type: array - items: &176 + items: &179 title: Migration description: A migration. type: object @@ -25392,7 +26007,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *55 + items: *58 url: type: string format: uri @@ -25604,7 +26219,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *91 + - *94 requestBody: required: true content: @@ -25680,7 +26295,7 @@ paths: description: Response content: application/json: - schema: *176 + schema: *179 examples: default: value: @@ -25858,8 +26473,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *91 - - &177 + - *94 + - &180 name: migration_id description: The unique identifier of the migration. in: path @@ -25886,7 +26501,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *176 + schema: *179 examples: default: value: @@ -26055,8 +26670,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *91 - - *177 + - *94 + - *180 responses: '302': description: Response @@ -26077,8 +26692,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *91 - - *177 + - *94 + - *180 responses: '204': description: Response @@ -26101,9 +26716,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *91 - - *177 - - &574 + - *94 + - *180 + - &577 name: repo_name description: repo_name parameter in: path @@ -26130,8 +26745,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *91 - - *177 + - *94 + - *180 - *18 - *20 responses: @@ -26141,9 +26756,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: &190 + default: &193 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -26280,7 +26895,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response - list of organization roles @@ -26296,7 +26911,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &180 + items: &183 title: Organization Role description: Organization roles type: object @@ -26423,8 +27038,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *91 - - *178 + - *94 + - *181 responses: '204': description: Response @@ -26449,9 +27064,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *91 - - *178 - - &179 + - *94 + - *181 + - &182 name: role_id description: The unique identifier of the role. in: path @@ -26486,9 +27101,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *91 - - *178 - - *179 + - *94 + - *181 + - *182 responses: '204': description: Response @@ -26513,8 +27128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -26539,9 +27154,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *91 - - *123 - - *179 + - *94 + - *126 + - *182 responses: '204': description: Response @@ -26571,9 +27186,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *91 - - *123 - - *179 + - *94 + - *126 + - *182 responses: '204': description: Response @@ -26601,14 +27216,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *91 - - *179 + - *94 + - *182 responses: '200': description: Response content: application/json: - schema: *180 + schema: *183 examples: default: value: @@ -26658,8 +27273,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: - - *91 - - *179 + - *94 + - *182 - *18 - *20 responses: @@ -26728,8 +27343,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *181 - required: *182 + properties: *184 + required: *185 nullable: true required: - id @@ -26744,7 +27359,7 @@ paths: - slug - parent examples: - default: *183 + default: *186 headers: Link: *39 '404': @@ -26773,8 +27388,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: - - *91 - - *179 + - *94 + - *182 - *18 - *20 responses: @@ -26884,7 +27499,7 @@ paths: - type - url examples: - default: *169 + default: *172 headers: Link: *39 '404': @@ -26908,7 +27523,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *91 + - *94 - 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) @@ -26932,7 +27547,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 x-github: @@ -26957,8 +27572,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *91 - - *123 + - *94 + - *126 requestBody: required: false content: @@ -27015,8 +27630,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -27073,8 +27688,8 @@ paths: - docker - nuget - container - - *91 - - &576 + - *94 + - &579 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -27110,12 +27725,12 @@ paths: application/json: schema: type: array - items: *184 + items: *187 examples: - default: *185 + default: *188 '403': *29 '401': *25 - '400': &578 + '400': &581 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -27137,7 +27752,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &186 + - &189 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 @@ -27155,20 +27770,20 @@ paths: - docker - nuget - container - - &187 + - &190 name: package_name description: The name of the package. in: path required: true schema: type: string - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: *184 + schema: *187 examples: default: value: @@ -27220,9 +27835,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *186 - - *187 - - *91 + - *189 + - *190 + - *94 responses: '204': description: Response @@ -27254,9 +27869,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *186 - - *187 - - *91 + - *189 + - *190 + - *94 - name: token description: package token schema: @@ -27288,9 +27903,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: - - *186 - - *187 - - *91 + - *189 + - *190 + - *94 - *20 - *18 - name: state @@ -27310,7 +27925,7 @@ paths: application/json: schema: type: array - items: &188 + items: &191 title: Package Version description: A version of a software package type: object @@ -27435,10 +28050,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *186 - - *187 - - *91 - - &189 + - *189 + - *190 + - *94 + - &192 name: package_version_id description: Unique identifier of the package version. in: path @@ -27450,7 +28065,7 @@ paths: description: Response content: application/json: - schema: *188 + schema: *191 examples: default: value: @@ -27486,10 +28101,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *186 - - *187 - - *91 - *189 + - *190 + - *94 + - *192 responses: '204': description: Response @@ -27521,10 +28136,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *186 - - *187 - - *91 - *189 + - *190 + - *94 + - *192 responses: '204': description: Response @@ -27551,10 +28166,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: - - *91 + - *94 - *18 - *20 - - &191 + - &194 name: sort description: The property by which to sort the results. in: query @@ -27565,7 +28180,7 @@ paths: - created_at default: created_at - *42 - - &192 + - &195 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -27576,7 +28191,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &193 + - &196 name: repository description: The name of the repository to use to filter the results. in: query @@ -27584,7 +28199,7 @@ paths: schema: type: string example: Hello-World - - &194 + - &197 name: permission description: The permission to use to filter the results. in: query @@ -27592,7 +28207,7 @@ paths: schema: type: string example: issues_read - - &195 + - &198 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) @@ -27602,7 +28217,7 @@ paths: schema: type: string format: date-time - - &196 + - &199 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) @@ -27751,7 +28366,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: - - *91 + - *94 requestBody: required: true content: @@ -27796,7 +28411,7 @@ paths: '422': *16 '404': *7 '403': *29 - '202': *96 + '202': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27817,7 +28432,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: - - *91 + - *94 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -27857,7 +28472,7 @@ paths: '422': *16 '404': *7 '403': *29 - '204': *134 + '204': *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27878,7 +28493,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: - - *91 + - *94 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -27898,9 +28513,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 x-github: @@ -27923,16 +28538,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: - - *91 + - *94 - *18 - *20 - - *191 - - *42 - - *192 - - *193 - *194 + - *42 - *195 - *196 + - *197 + - *198 + - *199 responses: '500': *41 '422': *16 @@ -28067,7 +28682,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: - - *91 + - *94 requestBody: required: true content: @@ -28104,7 +28719,7 @@ paths: responses: '500': *41 '404': *7 - '202': *96 + '202': *99 '403': *29 '422': *16 x-github: @@ -28127,7 +28742,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: - - *91 + - *94 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -28157,7 +28772,7 @@ paths: responses: '500': *41 '404': *7 - '204': *134 + '204': *137 '403': *29 '422': *16 x-github: @@ -28179,7 +28794,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: - - *91 + - *94 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -28198,9 +28813,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 x-github: @@ -28222,7 +28837,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-organization-projects parameters: - - *91 + - *94 - name: state description: Indicates the state of the projects to return. in: query @@ -28243,7 +28858,7 @@ paths: application/json: schema: type: array - items: &197 + items: &200 title: Project description: Projects are a way to organize columns and cards of work. @@ -28387,7 +29002,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#create-an-organization-project parameters: - - *91 + - *94 requestBody: required: true content: @@ -28413,7 +29028,7 @@ paths: description: Response content: application/json: - schema: *197 + schema: *200 examples: default: value: @@ -28451,7 +29066,7 @@ paths: '401': *25 '403': *29 '404': *7 - '410': &248 + '410': &251 description: Gone content: application/json: @@ -28475,7 +29090,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response @@ -28483,7 +29098,7 @@ paths: application/json: schema: type: array - items: &198 + items: &201 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -28542,7 +29157,7 @@ paths: - property_name - value_type examples: - default: &199 + default: &202 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -28583,7 +29198,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *91 + - *94 requestBody: required: true content: @@ -28594,7 +29209,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *198 + items: *201 minItems: 1 maxItems: 100 required: @@ -28624,9 +29239,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - default: *199 + default: *202 '403': *29 '404': *7 x-github: @@ -28647,8 +29262,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *91 - - &200 + - *94 + - &203 name: custom_property_name description: The custom property name in: path @@ -28660,9 +29275,9 @@ paths: description: Response content: application/json: - schema: *198 + schema: *201 examples: - default: &201 + default: &204 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -28695,8 +29310,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: - - *91 - - *200 + - *94 + - *203 requestBody: required: true content: @@ -28755,9 +29370,9 @@ paths: description: Response content: application/json: - schema: *198 + schema: *201 examples: - default: *201 + default: *204 '403': *29 '404': *7 x-github: @@ -28780,10 +29395,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *91 - - *200 + - *94 + - *203 responses: - '204': *134 + '204': *137 '403': *29 '404': *7 x-github: @@ -28804,7 +29419,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *91 + - *94 - *18 - *20 - name: repository_query @@ -28842,7 +29457,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &202 + items: &205 title: Custom Property Value description: Custom property name and associated value type: object @@ -28909,7 +29524,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: - - *91 + - *94 requestBody: required: true content: @@ -28929,7 +29544,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *202 + items: *205 required: - repository_names - properties @@ -28970,7 +29585,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *91 + - *94 - *18 - *20 responses: @@ -28982,7 +29597,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 x-github: @@ -29001,8 +29616,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response if user is a public member @@ -29026,8 +29641,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -29048,8 +29663,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -29073,7 +29688,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *91 + - *94 - name: type description: Specifies the types of repositories you want returned. in: query @@ -29119,9 +29734,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 x-github: @@ -29142,7 +29757,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *91 + - *94 requestBody: required: true content: @@ -29323,7 +29938,7 @@ paths: description: Response content: application/json: - schema: &250 + schema: &253 title: Full Repository description: Full Repository type: object @@ -29600,8 +30215,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *203 - required: *204 + properties: *206 + required: *207 nullable: true temp_clone_token: type: string @@ -29688,8 +30303,8 @@ paths: title: License Simple description: License Simple type: object - properties: *73 - required: *74 + properties: *76 + required: *77 nullable: true organization: title: Simple User @@ -29698,8 +30313,8 @@ paths: properties: *4 required: *5 nullable: true - parent: *55 - source: *55 + parent: *58 + source: *58 forks: type: integer master_branch: @@ -29716,7 +30331,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &378 + properties: &381 url: type: string format: uri @@ -29732,12 +30347,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &379 + required: &382 - url - key - name - html_url - security_and_analysis: *205 + security_and_analysis: *208 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -29821,7 +30436,7 @@ paths: - network_count - subscribers_count examples: - default: &252 + default: &255 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -30339,10 +30954,10 @@ paths: category: orgs subcategory: rules parameters: - - *91 + - *94 - *18 - *20 - - &514 + - &517 name: targets description: | A comma-separated list of rule targets to filter by. @@ -30360,7 +30975,7 @@ paths: application/json: schema: type: array - items: &212 + items: &215 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -30393,7 +31008,7 @@ paths: source: type: string description: The name of the source - enforcement: &208 + enforcement: &211 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -30406,7 +31021,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &209 + items: &212 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -30471,7 +31086,7 @@ paths: conditions: nullable: true anyOf: - - &206 + - &209 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -30495,7 +31110,7 @@ paths: match. items: type: string - - &210 + - &213 title: Organization ruleset conditions type: object description: |- @@ -30508,7 +31123,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *206 + - *209 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -30542,7 +31157,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *206 + - *209 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -30564,7 +31179,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *206 + - *209 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -30577,7 +31192,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &207 + items: &210 title: Repository ruleset property targeting definition type: object @@ -30610,17 +31225,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *207 + items: *210 required: - repository_property rules: type: array - items: &211 + items: &214 title: Repository Rule type: object description: A repository rule. oneOf: - - &496 + - &499 title: creation description: Only allow users with bypass permission to create matching refs. @@ -30632,7 +31247,7 @@ paths: type: string enum: - creation - - &497 + - &500 title: update description: Only allow users with bypass permission to update matching refs. @@ -30653,7 +31268,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &499 + - &502 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -30665,7 +31280,7 @@ paths: type: string enum: - deletion - - &500 + - &503 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -30677,7 +31292,7 @@ paths: type: string enum: - required_linear_history - - &501 + - &504 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -30755,7 +31370,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &502 + - &505 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -30779,7 +31394,7 @@ paths: type: string required: - required_deployment_environments - - &503 + - &506 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -30791,7 +31406,7 @@ paths: type: string enum: - required_signatures - - &504 + - &507 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -30837,7 +31452,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &505 + - &508 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -30885,7 +31500,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &506 + - &509 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -30897,7 +31512,7 @@ paths: type: string enum: - non_fast_forward - - &507 + - &510 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -30933,7 +31548,7 @@ paths: required: - operator - pattern - - &508 + - &511 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -30969,7 +31584,7 @@ paths: required: - operator - pattern - - &509 + - &512 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -31005,7 +31620,7 @@ paths: required: - operator - pattern - - &510 + - &513 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -31041,7 +31656,7 @@ paths: required: - operator - pattern - - &511 + - &514 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -31167,7 +31782,7 @@ paths: maximum: 100 required: - max_file_size - - &512 + - &515 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -31217,7 +31832,7 @@ paths: - repository_id required: - workflows - - &513 + - &516 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -31330,7 +31945,7 @@ paths: category: orgs subcategory: rules parameters: - - *91 + - *94 requestBody: description: Request body required: true @@ -31350,16 +31965,16 @@ paths: - tag - push default: branch - enforcement: *208 + enforcement: *211 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *209 - conditions: *210 + items: *212 + conditions: *213 rules: type: array description: An array of rules within the ruleset. - items: *211 + items: *214 required: - name - enforcement @@ -31397,9 +32012,9 @@ paths: description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: &213 + default: &216 value: id: 21 name: super cool ruleset @@ -31453,8 +32068,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *91 - - &515 + - *94 + - &518 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 @@ -31470,7 +32085,7 @@ paths: in: query schema: type: integer - - &516 + - &519 name: time_period description: |- The time period to filter by. @@ -31486,14 +32101,14 @@ paths: - week - month default: day - - &517 + - &520 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 - - &518 + - &521 name: rule_suite_result description: The rule results to filter on. When specified, only suites with this result will be returned. @@ -31513,7 +32128,7 @@ paths: description: Response content: application/json: - schema: &519 + schema: &522 title: Rule Suites description: Response type: array @@ -31568,7 +32183,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &520 + default: &523 value: - id: 21 actor_id: 12 @@ -31611,8 +32226,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *91 - - &521 + - *94 + - &524 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -31628,7 +32243,7 @@ paths: description: Response content: application/json: - schema: &522 + schema: &525 title: Rule Suite description: Response type: object @@ -31727,7 +32342,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &523 + default: &526 value: id: 21 actor_id: 12 @@ -31788,7 +32403,7 @@ paths: category: orgs subcategory: rules parameters: - - *91 + - *94 - name: ruleset_id description: The ID of the ruleset. in: path @@ -31800,9 +32415,9 @@ paths: description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: *213 + default: *216 '404': *7 '500': *41 put: @@ -31820,7 +32435,7 @@ paths: category: orgs subcategory: rules parameters: - - *91 + - *94 - name: ruleset_id description: The ID of the ruleset. in: path @@ -31845,16 +32460,16 @@ paths: - branch - tag - push - enforcement: *208 + enforcement: *211 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *209 - conditions: *210 + items: *212 + conditions: *213 rules: description: An array of rules within the ruleset. type: array - items: *211 + items: *214 examples: default: value: @@ -31889,9 +32504,9 @@ paths: description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: *213 + default: *216 '404': *7 '500': *41 delete: @@ -31909,7 +32524,7 @@ paths: category: orgs subcategory: rules parameters: - - *91 + - *94 - name: ruleset_id description: The ID of the ruleset. in: path @@ -31937,15 +32552,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *91 - - *214 - - *215 - - *216 + - *94 - *217 + - *218 + - *219 + - *220 - *42 - *20 - *18 - - &525 + - &528 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 @@ -31955,7 +32570,7 @@ paths: required: false schema: type: string - - &526 + - &529 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 @@ -31965,9 +32580,9 @@ paths: required: false schema: type: string - - *218 - - *219 - - *220 + - *221 + - *222 + - *223 responses: '200': description: Response @@ -31975,13 +32590,13 @@ paths: application/json: schema: type: array - items: *221 + items: *224 examples: - default: *222 + default: *225 headers: Link: *39 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32003,7 +32618,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *91 + - *94 - *42 - name: sort description: The property to sort the results by. @@ -32047,7 +32662,7 @@ paths: application/json: schema: type: array - items: &532 + items: &535 description: A repository security advisory. type: object properties: @@ -32267,7 +32882,7 @@ paths: login: type: string description: The username of the user credited. - type: *223 + type: *226 credits_detailed: type: array nullable: true @@ -32277,7 +32892,7 @@ paths: type: object properties: user: *19 - type: *223 + type: *226 state: type: string description: The state of the user's acceptance of the @@ -32301,7 +32916,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *166 + items: *169 private_fork: readOnly: true nullable: true @@ -32338,7 +32953,7 @@ paths: - private_fork additionalProperties: false examples: - default: &533 + default: &536 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -32720,7 +33335,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *91 + - *94 responses: '200': description: Response @@ -32728,15 +33343,15 @@ paths: application/json: schema: type: array - items: &475 + items: &478 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *181 - required: *182 + properties: *184 + required: *185 examples: - default: *183 + default: *186 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32759,8 +33374,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *91 - - *178 + - *94 + - *181 responses: '204': description: Response @@ -32785,8 +33400,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *91 - - *178 + - *94 + - *181 responses: '204': description: Response @@ -32812,13 +33427,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: &592 + schema: &595 type: object properties: total_minutes_used: @@ -32888,7 +33503,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &593 + default: &596 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -32918,13 +33533,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: &594 + schema: &597 type: object properties: total_gigabytes_bandwidth_used: @@ -32942,7 +33557,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &595 + default: &598 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -32968,13 +33583,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: &596 + schema: &599 type: object properties: days_left_in_billing_cycle: @@ -32992,7 +33607,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &597 + default: &600 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -33002,6 +33617,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: + - *94 + - *181 + - 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 + - *20 + - 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: *53 + examples: + default: *54 + '500': *41 + '403': *29 + '404': *7 + '422': *55 + 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 @@ -33030,8 +33714,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: - - *91 - - *178 + - *94 + - *181 - 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`). @@ -33063,9 +33747,9 @@ paths: application/json: schema: type: array - items: *53 + items: *56 examples: - default: *138 + default: *141 '500': *41 '401': *25 '403': *29 @@ -33087,7 +33771,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *91 + - *94 - *18 - *20 responses: @@ -33097,9 +33781,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - default: *183 + default: *186 headers: Link: *39 '403': *29 @@ -33121,7 +33805,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *91 + - *94 requestBody: required: true content: @@ -33193,7 +33877,7 @@ paths: description: Response content: application/json: - schema: &224 + schema: &227 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -33256,8 +33940,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *181 - required: *182 + properties: *184 + required: *185 nullable: true members_count: type: integer @@ -33503,7 +34187,7 @@ paths: - repos_count - organization examples: - default: &225 + default: &228 value: id: 1 node_id: MDQ6VGVhbTE= @@ -33573,16 +34257,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *91 - - *178 + - *94 + - *181 responses: '200': description: Response content: application/json: - schema: *224 + schema: *227 examples: - default: *225 + default: *228 '404': *7 x-github: githubCloudOnly: false @@ -33603,8 +34287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *91 - - *178 + - *94 + - *181 requestBody: required: false content: @@ -33666,16 +34350,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *224 + schema: *227 examples: - default: *225 + default: *228 '201': description: Response content: application/json: - schema: *224 + schema: *227 examples: - default: *225 + default: *228 '404': *7 '422': *16 '403': *29 @@ -33700,8 +34384,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *91 - - *178 + - *94 + - *181 responses: '204': description: Response @@ -33727,8 +34411,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *91 - - *178 + - *94 + - *181 - *42 - *18 - *20 @@ -33745,7 +34429,7 @@ paths: application/json: schema: type: array - items: &226 + items: &229 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -33824,7 +34508,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *59 + reactions: *62 required: - author - body @@ -33844,7 +34528,7 @@ paths: - updated_at - url examples: - default: &547 + default: &550 value: - author: login: octocat @@ -33918,8 +34602,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *91 - - *178 + - *94 + - *181 requestBody: required: true content: @@ -33953,9 +34637,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: &227 + default: &230 value: author: login: octocat @@ -34027,9 +34711,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *91 - - *178 - - &228 + - *94 + - *181 + - &231 name: discussion_number description: The number that identifies the discussion. in: path @@ -34041,9 +34725,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: *227 + default: *230 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34065,9 +34749,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *91 - - *178 - - *228 + - *94 + - *181 + - *231 requestBody: required: false content: @@ -34090,9 +34774,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: &548 + default: &551 value: author: login: octocat @@ -34162,9 +34846,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *91 - - *178 - - *228 + - *94 + - *181 + - *231 responses: '204': description: Response @@ -34190,9 +34874,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *91 - - *178 - - *228 + - *94 + - *181 + - *231 - *42 - *18 - *20 @@ -34203,7 +34887,7 @@ paths: application/json: schema: type: array - items: &229 + items: &232 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -34260,7 +34944,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *59 + reactions: *62 required: - author - body @@ -34275,7 +34959,7 @@ paths: - updated_at - url examples: - default: &549 + default: &552 value: - author: login: octocat @@ -34343,9 +35027,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *91 - - *178 - - *228 + - *94 + - *181 + - *231 requestBody: required: true content: @@ -34367,9 +35051,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *232 examples: - default: &230 + default: &233 value: author: login: octocat @@ -34435,10 +35119,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *91 - - *178 - - *228 - - &231 + - *94 + - *181 + - *231 + - &234 name: comment_number description: The number that identifies the comment. in: path @@ -34450,9 +35134,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *232 examples: - default: *230 + default: *233 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34474,10 +35158,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *91 - - *178 - - *228 + - *94 + - *181 - *231 + - *234 requestBody: required: true content: @@ -34499,9 +35183,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *232 examples: - default: &550 + default: &553 value: author: login: octocat @@ -34565,10 +35249,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *91 - - *178 - - *228 + - *94 + - *181 - *231 + - *234 responses: '204': description: Response @@ -34594,10 +35278,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *91 - - *178 - - *228 + - *94 + - *181 - *231 + - *234 - 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. @@ -34623,7 +35307,7 @@ paths: application/json: schema: type: array - items: &232 + items: &235 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -34666,7 +35350,7 @@ paths: - content - created_at examples: - default: &234 + default: &237 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -34716,10 +35400,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *91 - - *178 - - *228 + - *94 + - *181 - *231 + - *234 requestBody: required: true content: @@ -34752,9 +35436,9 @@ paths: team discussion comment content: application/json: - schema: *232 + schema: *235 examples: - default: &233 + default: &236 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -34783,9 +35467,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34808,11 +35492,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *91 - - *178 - - *228 + - *94 + - *181 - *231 - - &235 + - *234 + - &238 name: reaction_id description: The unique identifier of the reaction. in: path @@ -34844,9 +35528,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *91 - - *178 - - *228 + - *94 + - *181 + - *231 - 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. @@ -34872,9 +35556,9 @@ paths: application/json: schema: type: array - items: *232 + items: *235 examples: - default: *234 + default: *237 headers: Link: *39 x-github: @@ -34900,9 +35584,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *91 - - *178 - - *228 + - *94 + - *181 + - *231 requestBody: required: true content: @@ -34934,16 +35618,16 @@ paths: description: Response content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '201': description: Response content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -34966,10 +35650,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *91 - - *178 - - *228 - - *235 + - *94 + - *181 + - *231 + - *238 responses: '204': description: Response @@ -34993,8 +35677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *91 - - *178 + - *94 + - *181 - *18 - *20 responses: @@ -35004,9 +35688,9 @@ paths: application/json: schema: type: array - items: *163 + items: *166 examples: - default: *164 + default: *167 headers: Link: *39 x-github: @@ -35028,8 +35712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *91 - - *178 + - *94 + - *181 - name: role description: Filters members returned by their role in the team. in: query @@ -35052,7 +35736,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 x-github: @@ -35082,15 +35766,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - - *91 - - *178 - - *123 + - *94 + - *181 + - *126 responses: '200': description: Response content: application/json: - schema: &236 + schema: &239 title: Team Membership description: Team Membership type: object @@ -35117,7 +35801,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &551 + response-if-user-is-a-team-maintainer: &554 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -35153,9 +35837,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *91 - - *178 - - *123 + - *94 + - *181 + - *126 requestBody: required: false content: @@ -35180,9 +35864,9 @@ paths: description: Response content: application/json: - schema: *236 + schema: *239 examples: - response-if-users-membership-with-team-is-now-pending: &552 + response-if-users-membership-with-team-is-now-pending: &555 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -35217,9 +35901,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - - *91 - - *178 - - *123 + - *94 + - *181 + - *126 responses: '204': description: Response @@ -35245,8 +35929,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects parameters: - - *91 - - *178 + - *94 + - *181 - *18 - *20 responses: @@ -35256,7 +35940,7 @@ paths: application/json: schema: type: array - items: &237 + items: &240 title: Team Project description: A team's access to a project. type: object @@ -35324,7 +36008,7 @@ paths: - updated_at - permissions examples: - default: &553 + default: &556 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -35385,9 +36069,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project parameters: - - *91 - - *178 - - &238 + - *94 + - *181 + - &241 name: project_id description: The unique identifier of the project. in: path @@ -35399,9 +36083,9 @@ paths: description: Response content: application/json: - schema: *237 + schema: *240 examples: - default: &554 + default: &557 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -35461,9 +36145,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions parameters: - - *91 - - *178 - - *238 + - *94 + - *181 + - *241 requestBody: required: false content: @@ -35527,9 +36211,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team parameters: - - *91 - - *178 - - *238 + - *94 + - *181 + - *241 responses: '204': description: Response @@ -35553,8 +36237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *91 - - *178 + - *94 + - *181 - *18 - *20 responses: @@ -35564,9 +36248,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 x-github: @@ -35595,16 +36279,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *91 - - *178 - - *239 - - *240 + - *94 + - *181 + - *242 + - *243 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &555 + schema: &558 title: Team Repository description: A team's access to a repository. type: object @@ -35627,8 +36311,8 @@ paths: title: License Simple description: License Simple type: object - properties: *73 - required: *74 + properties: *76 + required: *77 nullable: true forks: type: integer @@ -36173,10 +36857,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *91 - - *178 - - *239 - - *240 + - *94 + - *181 + - *242 + - *243 requestBody: required: false content: @@ -36221,10 +36905,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *91 - - *178 - - *239 - - *240 + - *94 + - *181 + - *242 + - *243 responses: '204': description: Response @@ -36248,8 +36932,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *91 - - *178 + - *94 + - *181 - *18 - *20 responses: @@ -36259,9 +36943,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - response-if-child-teams-exist: &556 + response-if-child-teams-exist: &559 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -36314,7 +36998,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *91 + - *94 - name: security_product in: path description: The security feature to enable or disable. @@ -36385,7 +37069,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#get-a-project-card parameters: - - &241 + - &244 name: card_id description: The unique identifier of the card. in: path @@ -36397,7 +37081,7 @@ paths: description: Response content: application/json: - schema: &242 + schema: &245 title: Project Card description: Project cards represent a scope of work. type: object @@ -36464,7 +37148,7 @@ paths: - created_at - updated_at examples: - default: &243 + default: &246 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -36514,7 +37198,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#update-an-existing-project-card parameters: - - *241 + - *244 requestBody: required: false content: @@ -36541,9 +37225,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *245 examples: - default: *243 + default: *246 '304': *37 '403': *29 '401': *25 @@ -36564,7 +37248,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#delete-a-project-card parameters: - - *241 + - *244 responses: '204': description: Response @@ -36602,7 +37286,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#move-a-project-card parameters: - - *241 + - *244 requestBody: required: true content: @@ -36707,7 +37391,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#get-a-project-column parameters: - - &244 + - &247 name: column_id description: The unique identifier of the column. in: path @@ -36719,7 +37403,7 @@ paths: description: Response content: application/json: - schema: &245 + schema: &248 title: Project Column description: Project columns contain cards of work. type: object @@ -36765,7 +37449,7 @@ paths: - created_at - updated_at examples: - default: &246 + default: &249 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -36794,7 +37478,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#update-an-existing-project-column parameters: - - *244 + - *247 requestBody: required: true content: @@ -36818,9 +37502,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *248 examples: - default: *246 + default: *249 '304': *37 '403': *29 '401': *25 @@ -36839,7 +37523,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#delete-a-project-column parameters: - - *244 + - *247 responses: '204': description: Response @@ -36862,7 +37546,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#list-project-cards parameters: - - *244 + - *247 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -36883,7 +37567,7 @@ paths: application/json: schema: type: array - items: *242 + items: *245 examples: default: value: @@ -36936,7 +37620,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#create-a-project-card parameters: - - *244 + - *247 requestBody: required: true content: @@ -36976,9 +37660,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *245 examples: - default: *243 + default: *246 '304': *37 '403': *29 '401': *25 @@ -36988,8 +37672,8 @@ paths: application/json: schema: oneOf: - - *94 - - *95 + - *97 + - *98 '503': description: Response content: @@ -37028,7 +37712,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#move-a-project-column parameters: - - *244 + - *247 requestBody: required: true content: @@ -37084,15 +37768,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-a-project parameters: - - *238 + - *241 responses: '200': description: Response content: application/json: - schema: *197 + schema: *200 examples: - default: &247 + default: &250 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -37145,7 +37829,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#update-a-project parameters: - - *238 + - *241 requestBody: required: false content: @@ -37191,9 +37875,9 @@ paths: description: Response content: application/json: - schema: *197 + schema: *200 examples: - default: *247 + default: *250 '404': description: Not Found if the authenticated user does not have access to the project @@ -37214,7 +37898,7 @@ paths: items: type: string '401': *25 - '410': *248 + '410': *251 '422': *8 x-github: githubCloudOnly: false @@ -37232,7 +37916,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#delete-a-project parameters: - - *238 + - *241 responses: '204': description: Delete Success @@ -37253,7 +37937,7 @@ paths: items: type: string '401': *25 - '410': *248 + '410': *251 '404': *7 x-github: githubCloudOnly: false @@ -37276,7 +37960,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#list-project-collaborators parameters: - - *238 + - *241 - 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 @@ -37303,7 +37987,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 '404': *7 @@ -37328,8 +38012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#add-project-collaborator parameters: - - *238 - - *123 + - *241 + - *126 requestBody: required: false content: @@ -37376,8 +38060,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator parameters: - - *238 - - *123 + - *241 + - *126 responses: '204': description: Response @@ -37405,8 +38089,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user parameters: - - *238 - - *123 + - *241 + - *126 responses: '200': description: Response @@ -37473,7 +38157,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#list-project-columns parameters: - - *238 + - *241 - *18 - *20 responses: @@ -37483,7 +38167,7 @@ paths: application/json: schema: type: array - items: *245 + items: *248 examples: default: value: @@ -37515,7 +38199,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#create-a-project-column parameters: - - *238 + - *241 requestBody: required: true content: @@ -37538,7 +38222,7 @@ paths: description: Response content: application/json: - schema: *245 + schema: *248 examples: default: value: @@ -37599,7 +38283,7 @@ paths: resources: type: object properties: - core: &249 + core: &252 title: Rate Limit type: object properties: @@ -37616,19 +38300,19 @@ paths: - remaining - reset - used - graphql: *249 - search: *249 - code_search: *249 - source_import: *249 - integration_manifest: *249 - code_scanning_upload: *249 - actions_runner_registration: *249 - scim: *249 - dependency_snapshots: *249 + graphql: *252 + search: *252 + code_search: *252 + source_import: *252 + integration_manifest: *252 + code_scanning_upload: *252 + actions_runner_registration: *252 + scim: *252 + dependency_snapshots: *252 required: - core - search - rate: *249 + rate: *252 required: - rate - resources @@ -37727,14 +38411,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *250 + schema: *253 examples: default-response: summary: Default response @@ -38235,7 +38919,7 @@ paths: status: disabled '403': *29 '404': *7 - '301': *251 + '301': *254 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38253,8 +38937,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: false content: @@ -38490,10 +39174,10 @@ paths: description: Response content: application/json: - schema: *250 + schema: *253 examples: - default: *252 - '307': &253 + default: *255 + '307': &256 description: Temporary Redirect content: application/json: @@ -38522,8 +39206,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -38545,7 +39229,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *253 + '307': *256 '404': *7 x-github: githubCloudOnly: false @@ -38568,11 +39252,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 - - &279 + - &282 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -38595,7 +39279,7 @@ paths: type: integer artifacts: type: array - items: &254 + items: &257 title: Artifact description: An artifact type: object @@ -38666,7 +39350,7 @@ paths: - expires_at - updated_at examples: - default: &280 + default: &283 value: total_count: 2 artifacts: @@ -38725,9 +39409,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *239 - - *240 - - &255 + - *242 + - *243 + - &258 name: artifact_id description: The unique identifier of the artifact. in: path @@ -38739,7 +39423,7 @@ paths: description: Response content: application/json: - schema: *254 + schema: *257 examples: default: value: @@ -38776,9 +39460,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *239 - - *240 - - *255 + - *242 + - *243 + - *258 responses: '204': description: Response @@ -38802,9 +39486,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *239 - - *240 - - *255 + - *242 + - *243 + - *258 - name: archive_format in: path required: true @@ -38818,7 +39502,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': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38841,14 +39525,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *256 + schema: *259 examples: default: value: @@ -38874,11 +39558,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 - - &257 + - &260 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 @@ -38912,7 +39596,7 @@ paths: description: Response content: application/json: - schema: &258 + schema: &261 title: Repository actions caches description: Repository actions caches type: object @@ -38954,7 +39638,7 @@ paths: - total_count - actions_caches examples: - default: &259 + default: &262 value: total_count: 1 actions_caches: @@ -38986,23 +39670,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: - - *239 - - *240 + - *242 + - *243 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *257 + - *260 responses: '200': description: Response content: application/json: - schema: *258 + schema: *261 examples: - default: *259 + default: *262 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39022,8 +39706,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: - - *239 - - *240 + - *242 + - *243 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -39054,9 +39738,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *239 - - *240 - - &260 + - *242 + - *243 + - &263 name: job_id description: The unique identifier of the job. in: path @@ -39068,7 +39752,7 @@ paths: description: Response content: application/json: - schema: &283 + schema: &286 title: Job description: Information of a job execution in a workflow run type: object @@ -39375,9 +40059,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *239 - - *240 - - *260 + - *242 + - *243 + - *263 responses: '302': description: Response @@ -39405,9 +40089,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *239 - - *240 - - *260 + - *242 + - *243 + - *263 requestBody: required: false content: @@ -39428,7 +40112,7 @@ paths: description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -39452,8 +40136,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: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Status response @@ -39503,8 +40187,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: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -39538,7 +40222,7 @@ paths: description: Empty response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -39567,8 +40251,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -39586,7 +40270,7 @@ paths: type: integer secrets: type: array - items: &285 + items: &288 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -39606,7 +40290,7 @@ paths: - created_at - updated_at examples: - default: &286 + default: &289 value: total_count: 2 secrets: @@ -39639,9 +40323,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *239 - - *240 - - *261 + - *242 + - *243 + - *264 - *20 responses: '200': @@ -39658,7 +40342,7 @@ paths: type: integer variables: type: array - items: &289 + items: &292 title: Actions Variable type: object properties: @@ -39688,7 +40372,7 @@ paths: - created_at - updated_at examples: - default: &290 + default: &293 value: total_count: 2 variables: @@ -39721,8 +40405,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -39731,11 +40415,11 @@ paths: schema: type: object properties: - enabled: &263 + enabled: &266 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *100 - selected_actions_url: *262 + allowed_actions: *103 + selected_actions_url: *265 required: - enabled examples: @@ -39762,8 +40446,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -39774,8 +40458,8 @@ paths: schema: type: object properties: - enabled: *263 - allowed_actions: *100 + enabled: *266 + allowed_actions: *103 required: - enabled examples: @@ -39804,14 +40488,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: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: &264 + schema: &267 type: object properties: access_level: @@ -39828,7 +40512,7 @@ paths: required: - access_level examples: - default: &265 + default: &268 value: access_level: organization x-github: @@ -39852,15 +40536,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: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: application/json: - schema: *264 + schema: *267 examples: - default: *265 + default: *268 responses: '204': description: Response @@ -39884,16 +40568,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *102 + schema: *105 examples: - default: *103 + default: *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -39912,8 +40596,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -39921,9 +40605,9 @@ paths: required: false content: application/json: - schema: *102 + schema: *105 examples: - selected_actions: *103 + selected_actions: *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -39945,16 +40629,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *266 + schema: *269 examples: - default: *106 + default: *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39975,8 +40659,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Success response @@ -39987,9 +40671,9 @@ paths: required: true content: application/json: - schema: *267 + schema: *270 examples: - default: *106 + default: *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40016,8 +40700,8 @@ paths: in: query schema: type: string - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -40035,9 +40719,9 @@ paths: type: integer runners: type: array - items: *112 + items: *115 examples: - default: *113 + default: *116 headers: Link: *39 x-github: @@ -40061,8 +40745,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -40070,9 +40754,9 @@ paths: application/json: schema: type: array - items: *268 + items: *271 examples: - default: *269 + default: *272 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40094,8 +40778,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: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -40138,7 +40822,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *270 + '201': *273 '404': *7 '422': *8 x-github: @@ -40168,16 +40852,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '201': description: Response content: application/json: - schema: *114 + schema: *117 examples: - default: *271 + default: *274 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40205,16 +40889,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '201': description: Response content: application/json: - schema: *114 + schema: *117 examples: - default: *272 + default: *275 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40236,17 +40920,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: - - *239 - - *240 - - *111 + - *242 + - *243 + - *114 responses: '200': description: Response content: application/json: - schema: *112 + schema: *115 examples: - default: *273 + default: *276 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40267,9 +40951,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: - - *239 - - *240 - - *111 + - *242 + - *243 + - *114 responses: '204': description: Response @@ -40294,11 +40978,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: - - *239 - - *240 - - *111 + - *242 + - *243 + - *114 responses: - '200': *116 + '200': *119 '404': *7 x-github: githubCloudOnly: false @@ -40320,9 +41004,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: - - *239 - - *240 - - *111 + - *242 + - *243 + - *114 requestBody: required: true content: @@ -40346,7 +41030,7 @@ paths: - gpu - accelerated responses: - '200': *116 + '200': *119 '404': *7 '422': *8 x-github: @@ -40370,9 +41054,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: - - *239 - - *240 - - *111 + - *242 + - *243 + - *114 requestBody: required: true content: @@ -40397,7 +41081,7 @@ paths: - gpu - accelerated responses: - '200': *116 + '200': *119 '404': *7 '422': *8 x-github: @@ -40421,11 +41105,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: - - *239 - - *240 - - *111 + - *242 + - *243 + - *114 responses: - '200': *274 + '200': *277 '404': *7 x-github: githubCloudOnly: false @@ -40452,12 +41136,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: - - *239 - - *240 - - *111 - - *275 + - *242 + - *243 + - *114 + - *278 responses: - '200': *116 + '200': *119 '404': *7 '422': *8 x-github: @@ -40483,9 +41167,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *239 - - *240 - - &293 + - *242 + - *243 + - &296 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. @@ -40493,7 +41177,7 @@ paths: required: false schema: type: string - - &294 + - &297 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -40501,7 +41185,7 @@ paths: required: false schema: type: string - - &295 + - &298 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -40510,7 +41194,7 @@ paths: required: false schema: type: string - - &296 + - &299 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 @@ -40537,7 +41221,7 @@ paths: - pending - *18 - *20 - - &297 + - &300 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)." @@ -40546,7 +41230,7 @@ paths: schema: type: string format: date-time - - &276 + - &279 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -40555,13 +41239,13 @@ paths: schema: type: boolean default: false - - &298 + - &301 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &299 + - &302 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -40584,7 +41268,7 @@ paths: type: integer workflow_runs: type: array - items: &277 + items: &280 title: Workflow Run description: An invocation of a workflow type: object @@ -40679,7 +41363,7 @@ paths: that triggered the run. type: array nullable: true - items: &318 + items: &321 title: Pull Request Minimal type: object properties: @@ -40798,7 +41482,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &322 + properties: &325 id: type: string description: SHA for the commit @@ -40849,7 +41533,7 @@ paths: - name - email nullable: true - required: &323 + required: &326 - id - tree_id - message @@ -40857,8 +41541,8 @@ paths: - author - committer nullable: true - repository: *110 - head_repository: *110 + repository: *113 + head_repository: *113 head_repository_id: type: integer example: 5 @@ -40896,7 +41580,7 @@ paths: - workflow_url - pull_requests examples: - default: &300 + default: &303 value: total_count: 1 workflow_runs: @@ -41132,24 +41816,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *239 - - *240 - - &278 + - *242 + - *243 + - &281 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *276 + - *279 responses: '200': description: Response content: application/json: - schema: *277 + schema: *280 examples: - default: &281 + default: &284 value: id: 30433642 name: Build @@ -41390,9 +42074,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '204': description: Response @@ -41415,9 +42099,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '200': description: Response @@ -41536,15 +42220,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: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '201': description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -41571,12 +42255,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 - *18 - *20 - - *279 + - *282 responses: '200': description: Response @@ -41592,9 +42276,9 @@ paths: type: integer artifacts: type: array - items: *254 + items: *257 examples: - default: *280 + default: *283 headers: Link: *39 x-github: @@ -41618,25 +42302,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *239 - - *240 - - *278 - - &282 + - *242 + - *243 + - *281 + - &285 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *276 + - *279 responses: '200': description: Response content: application/json: - schema: *277 + schema: *280 examples: - default: *281 + default: *284 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41659,10 +42343,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *239 - - *240 - - *278 - - *282 + - *242 + - *243 + - *281 + - *285 - *18 - *20 responses: @@ -41680,9 +42364,9 @@ paths: type: integer jobs: type: array - items: *283 + items: *286 examples: - default: &284 + default: &287 value: total_count: 1 jobs: @@ -41795,10 +42479,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *239 - - *240 - - *278 - - *282 + - *242 + - *243 + - *281 + - *285 responses: '302': description: Response @@ -41826,19 +42510,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '202': description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41861,9 +42545,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: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 requestBody: required: true content: @@ -41930,19 +42614,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '202': description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41965,9 +42649,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 - 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 @@ -41997,9 +42681,9 @@ paths: type: integer jobs: type: array - items: *283 + items: *286 examples: - default: *284 + default: *287 headers: Link: *39 x-github: @@ -42024,9 +42708,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '302': description: Response @@ -42053,9 +42737,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '204': description: Response @@ -42082,9 +42766,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '200': description: Response @@ -42144,7 +42828,7 @@ paths: items: type: object properties: - type: &399 + type: &402 type: string description: The type of reviewer. enum: @@ -42154,7 +42838,7 @@ paths: reviewer: anyOf: - *19 - - *166 + - *169 required: - environment - wait_timer @@ -42229,9 +42913,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 requestBody: required: true content: @@ -42278,7 +42962,7 @@ paths: application/json: schema: type: array - items: &394 + items: &397 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -42366,8 +43050,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 required: - id - node_id @@ -42384,7 +43068,7 @@ paths: - created_at - updated_at examples: - default: &395 + default: &398 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -42440,9 +43124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 requestBody: required: false content: @@ -42463,7 +43147,7 @@ paths: description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -42486,9 +43170,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 requestBody: required: false content: @@ -42509,7 +43193,7 @@ paths: description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -42534,9 +43218,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '200': description: Response @@ -42673,8 +43357,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -42692,9 +43376,9 @@ paths: type: integer secrets: type: array - items: *285 + items: *288 examples: - default: *286 + default: *289 headers: Link: *39 x-github: @@ -42719,16 +43403,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *287 + schema: *290 examples: - default: *288 + default: *291 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42750,17 +43434,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 responses: '200': description: Response content: application/json: - schema: *285 + schema: *288 examples: - default: &412 + default: &415 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -42786,9 +43470,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 requestBody: required: true content: @@ -42816,7 +43500,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -42842,9 +43526,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 responses: '204': description: Response @@ -42869,9 +43553,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *239 - - *240 - - *261 + - *242 + - *243 + - *264 - *20 responses: '200': @@ -42888,9 +43572,9 @@ paths: type: integer variables: type: array - items: *289 + items: *292 examples: - default: *290 + default: *293 headers: Link: *39 x-github: @@ -42913,8 +43597,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -42941,7 +43625,7 @@ paths: description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -42966,17 +43650,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *239 - - *240 - - *121 + - *242 + - *243 + - *124 responses: '200': description: Response content: application/json: - schema: *289 + schema: *292 examples: - default: &413 + default: &416 value: name: USERNAME value: octocat @@ -43002,9 +43686,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *239 - - *240 - - *121 + - *242 + - *243 + - *124 requestBody: required: true content: @@ -43046,9 +43730,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *239 - - *240 - - *121 + - *242 + - *243 + - *124 responses: '204': description: Response @@ -43073,8 +43757,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -43092,7 +43776,7 @@ paths: type: integer workflows: type: array - items: &291 + items: &294 title: Workflow description: A GitHub Actions workflow type: object @@ -43199,9 +43883,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *239 - - *240 - - &292 + - *242 + - *243 + - &295 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -43216,7 +43900,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *294 examples: default: value: @@ -43249,9 +43933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *239 - - *240 - - *292 + - *242 + - *243 + - *295 responses: '204': description: Response @@ -43276,9 +43960,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *239 - - *240 - - *292 + - *242 + - *243 + - *295 responses: '204': description: Response @@ -43329,9 +44013,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *239 - - *240 - - *292 + - *242 + - *243 + - *295 responses: '204': description: Response @@ -43356,19 +44040,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *239 - - *240 - - *292 - - *293 - - *294 + - *242 + - *243 - *295 - *296 - - *18 - - *20 - *297 - - *276 - *298 - *299 + - *18 + - *20 + - *300 + - *279 + - *301 + - *302 responses: '200': description: Response @@ -43384,9 +44068,9 @@ paths: type: integer workflow_runs: type: array - items: *277 + items: *280 examples: - default: *300 + default: *303 headers: Link: *39 x-github: @@ -43412,9 +44096,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *239 - - *240 - - *292 + - *242 + - *243 + - *295 responses: '200': description: Response @@ -43475,8 +44159,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *239 - - *240 + - *242 + - *243 - *42 - *18 - *43 @@ -43640,8 +44324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -43653,7 +44337,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 '404': *7 @@ -43678,8 +44362,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *239 - - *240 + - *242 + - *243 - name: assignee in: path required: true @@ -43715,8 +44399,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -43828,8 +44512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *43 - *44 @@ -43873,7 +44557,7 @@ paths: repository_id: type: integer examples: - default: *301 + default: *304 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43893,8 +44577,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -43902,7 +44586,7 @@ paths: application/json: schema: type: array - items: &302 + items: &305 title: Autolink reference description: An autolink reference. type: object @@ -43952,8 +44636,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -43992,9 +44676,9 @@ paths: description: response content: application/json: - schema: *302 + schema: *305 examples: - default: &303 + default: &306 value: id: 1 key_prefix: TICKET- @@ -44025,9 +44709,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *239 - - *240 - - &304 + - *242 + - *243 + - &307 name: autolink_id description: The unique identifier of the autolink. in: path @@ -44039,9 +44723,9 @@ paths: description: Response content: application/json: - schema: *302 + schema: *305 examples: - default: *303 + default: *306 '404': *7 x-github: githubCloudOnly: false @@ -44061,9 +44745,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *239 - - *240 - - *304 + - *242 + - *243 + - *307 responses: '204': description: Response @@ -44087,8 +44771,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: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response if Dependabot is enabled @@ -44136,8 +44820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-automated-security-fixes parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -44158,8 +44842,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-automated-security-fixes parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -44179,8 +44863,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *239 - - *240 + - *242 + - *243 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -44218,7 +44902,7 @@ paths: - url protected: type: boolean - protection: &306 + protection: &309 title: Branch Protection description: Branch Protection type: object @@ -44260,7 +44944,7 @@ paths: required: - contexts - checks - enforce_admins: &309 + enforce_admins: &312 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -44275,7 +44959,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &311 + required_pull_request_reviews: &314 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -44296,7 +44980,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *166 + items: *169 apps: description: The list of apps with review dismissal access. @@ -44325,7 +45009,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *166 + items: *169 apps: description: The list of apps allowed to bypass pull request requirements. @@ -44351,7 +45035,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &308 + restrictions: &311 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -44658,9 +45342,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *239 - - *240 - - &307 + - *242 + - *243 + - &310 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). @@ -44674,14 +45358,14 @@ paths: description: Response content: application/json: - schema: &317 + schema: &320 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &367 + commit: &370 title: Commit description: Commit type: object @@ -44715,7 +45399,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &305 + properties: &308 name: type: string example: '"Chris Wanstrath"' @@ -44730,7 +45414,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *305 + properties: *308 nullable: true message: type: string @@ -44751,7 +45435,7 @@ paths: required: - sha - url - verification: &419 + verification: &422 title: Verification type: object properties: @@ -44781,12 +45465,12 @@ paths: nullable: true oneOf: - *19 - - *119 + - *122 committer: nullable: true oneOf: - *19 - - *119 + - *122 parents: type: array items: @@ -44817,7 +45501,7 @@ paths: type: integer files: type: array - items: &382 + items: &385 title: Diff Entry description: Diff Entry type: object @@ -44900,7 +45584,7 @@ paths: - self protected: type: boolean - protection: *306 + protection: *309 protection_url: type: string format: uri @@ -45006,7 +45690,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *251 + '301': *254 '404': *7 x-github: githubCloudOnly: false @@ -45028,15 +45712,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response content: application/json: - schema: *306 + schema: *309 examples: default: value: @@ -45230,9 +45914,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: true content: @@ -45487,7 +46171,7 @@ paths: url: type: string format: uri - required_status_checks: &314 + required_status_checks: &317 title: Status Check Policy description: Status Check Policy type: object @@ -45563,7 +46247,7 @@ paths: items: *19 teams: type: array - items: *166 + items: *169 apps: type: array items: *6 @@ -45581,7 +46265,7 @@ paths: items: *19 teams: type: array - items: *166 + items: *169 apps: type: array items: *6 @@ -45639,7 +46323,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *308 + restrictions: *311 required_conversation_resolution: type: object properties: @@ -45751,9 +46435,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '204': description: Response @@ -45778,17 +46462,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response content: application/json: - schema: *309 + schema: *312 examples: - default: &310 + default: &313 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -45810,17 +46494,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response content: application/json: - schema: *309 + schema: *312 examples: - default: *310 + default: *313 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45839,9 +46523,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '204': description: Response @@ -45866,17 +46550,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response content: application/json: - schema: *311 + schema: *314 examples: - default: &312 + default: &315 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -45972,9 +46656,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: false content: @@ -46072,9 +46756,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *314 examples: - default: *312 + default: *315 '422': *16 x-github: githubCloudOnly: false @@ -46095,9 +46779,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '204': description: Response @@ -46124,17 +46808,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response content: application/json: - schema: *309 + schema: *312 examples: - default: &313 + default: &316 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -46157,17 +46841,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response content: application/json: - schema: *309 + schema: *312 examples: - default: *313 + default: *316 '404': *7 x-github: githubCloudOnly: false @@ -46187,9 +46871,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '204': description: Response @@ -46214,17 +46898,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response content: application/json: - schema: *314 + schema: *317 examples: - default: &315 + default: &318 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -46250,9 +46934,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: false content: @@ -46304,9 +46988,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *317 examples: - default: *315 + default: *318 '404': *7 '422': *16 x-github: @@ -46328,9 +47012,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '204': description: Response @@ -46354,9 +47038,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response @@ -46390,9 +47074,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: false content: @@ -46459,9 +47143,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: false content: @@ -46525,9 +47209,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: content: application/json: @@ -46593,15 +47277,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response content: application/json: - schema: *308 + schema: *311 examples: default: value: @@ -46692,9 +47376,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '204': description: Response @@ -46717,9 +47401,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response @@ -46729,7 +47413,7 @@ paths: type: array items: *6 examples: - default: &316 + default: &319 value: - id: 1 slug: octoapp @@ -46786,9 +47470,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: true content: @@ -46822,7 +47506,7 @@ paths: type: array items: *6 examples: - default: *316 + default: *319 '422': *16 x-github: githubCloudOnly: false @@ -46843,9 +47527,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: true content: @@ -46879,7 +47563,7 @@ paths: type: array items: *6 examples: - default: *316 + default: *319 '422': *16 x-github: githubCloudOnly: false @@ -46900,9 +47584,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: true content: @@ -46936,7 +47620,7 @@ paths: type: array items: *6 examples: - default: *316 + default: *319 '422': *16 x-github: githubCloudOnly: false @@ -46958,9 +47642,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response @@ -46968,9 +47652,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - default: *183 + default: *186 '404': *7 x-github: githubCloudOnly: false @@ -46990,9 +47674,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: false content: @@ -47028,9 +47712,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - default: *183 + default: *186 '422': *16 x-github: githubCloudOnly: false @@ -47051,9 +47735,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: false content: @@ -47089,9 +47773,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - default: *183 + default: *186 '422': *16 x-github: githubCloudOnly: false @@ -47112,9 +47796,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: content: application/json: @@ -47149,9 +47833,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - default: *183 + default: *186 '422': *16 x-github: githubCloudOnly: false @@ -47173,9 +47857,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response @@ -47185,7 +47869,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 '404': *7 x-github: githubCloudOnly: false @@ -47209,9 +47893,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: true content: @@ -47244,7 +47928,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 '422': *16 x-github: githubCloudOnly: false @@ -47269,9 +47953,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: true content: @@ -47304,7 +47988,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 '422': *16 x-github: githubCloudOnly: false @@ -47329,9 +48013,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: true content: @@ -47364,7 +48048,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 '422': *16 x-github: githubCloudOnly: false @@ -47391,9 +48075,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: true content: @@ -47415,7 +48099,7 @@ paths: description: Response content: application/json: - schema: *317 + schema: *320 examples: default: value: @@ -47530,8 +48214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -47810,7 +48494,7 @@ paths: description: Response content: application/json: - schema: &319 + schema: &322 title: CheckRun description: A check performed on the code of a given code change type: object @@ -47921,16 +48605,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *318 - deployment: &606 + items: *321 + deployment: &609 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -47997,8 +48681,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 required: - id - node_id @@ -48210,9 +48894,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *239 - - *240 - - &320 + - *242 + - *243 + - &323 name: check_run_id description: The unique identifier of the check run. in: path @@ -48224,9 +48908,9 @@ paths: description: Response content: application/json: - schema: *319 + schema: *322 examples: - default: &321 + default: &324 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -48326,9 +49010,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *239 - - *240 - - *320 + - *242 + - *243 + - *323 requestBody: required: true content: @@ -48568,9 +49252,9 @@ paths: description: Response content: application/json: - schema: *319 + schema: *322 examples: - default: *321 + default: *324 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48590,9 +49274,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *239 - - *240 - - *320 + - *242 + - *243 + - *323 - *18 - *20 responses: @@ -48689,15 +49373,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *239 - - *240 - - *320 + - *242 + - *243 + - *323 responses: '201': description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -48735,8 +49419,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -48758,7 +49442,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &324 + schema: &327 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -48821,7 +49505,7 @@ paths: nullable: true pull_requests: type: array - items: *318 + items: *321 nullable: true app: title: GitHub app @@ -48832,9 +49516,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 - repository: *110 + properties: *59 + required: *60 + repository: *113 created_at: type: string format: date-time @@ -48843,12 +49527,12 @@ paths: type: string format: date-time nullable: true - head_commit: &632 + head_commit: &635 title: Simple Commit description: A commit. type: object - properties: *322 - required: *323 + properties: *325 + required: *326 latest_check_runs_count: type: integer check_runs_url: @@ -48876,7 +49560,7 @@ paths: - check_runs_url - pull_requests examples: - default: &325 + default: &328 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -49167,9 +49851,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *324 + schema: *327 examples: - default: *325 + default: *328 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49188,8 +49872,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -49250,7 +49934,7 @@ paths: required: - app_id - setting - repository: *110 + repository: *113 examples: default: value: @@ -49498,9 +50182,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *239 - - *240 - - &326 + - *242 + - *243 + - &329 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -49512,9 +50196,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *327 examples: - default: *325 + default: *328 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49537,17 +50221,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *239 - - *240 - - *326 - - &375 + - *242 + - *243 + - *329 + - &378 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &376 + - &379 name: status description: Returns check runs with the specified `status`. in: query @@ -49586,9 +50270,9 @@ paths: type: integer check_runs: type: array - items: *319 + items: *322 examples: - default: &377 + default: &380 value: total_count: 1 check_runs: @@ -49690,15 +50374,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *239 - - *240 - - *326 + - *242 + - *243 + - *329 responses: '201': description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -49725,21 +50409,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *239 - - *240 - - *327 - - *328 + - *242 + - *243 + - *330 + - *331 - *20 - *18 - - &341 + - &344 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: *329 - - &342 + schema: *332 + - &345 name: pr description: The number of the pull request for the results you want to list. in: query @@ -49764,13 +50448,13 @@ paths: be returned. in: query required: false - schema: *330 + schema: *333 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *331 + schema: *334 responses: '200': description: Response @@ -49783,12 +50467,12 @@ paths: properties: number: *48 created_at: *49 - updated_at: *124 + updated_at: *127 url: *50 html_url: *51 - instances_url: *332 - state: *129 - fixed_at: *125 + instances_url: *335 + state: *132 + fixed_at: *128 dismissed_by: title: Simple User description: A GitHub user. @@ -49796,12 +50480,12 @@ paths: properties: *4 required: *5 nullable: true - dismissed_at: *126 - dismissed_reason: *333 - dismissed_comment: *334 - rule: *335 - tool: *336 - most_recent_instance: *337 + dismissed_at: *129 + dismissed_reason: *336 + dismissed_comment: *337 + rule: *338 + tool: *339 + most_recent_instance: *340 required: - number - created_at @@ -49917,14 +50601,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &338 + '403': &341 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49944,9 +50628,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *239 - - *240 - - &339 + - *242 + - *243 + - &342 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -49960,17 +50644,17 @@ paths: description: Response content: application/json: - schema: &340 + schema: &343 type: object properties: number: *48 created_at: *49 - updated_at: *124 + updated_at: *127 url: *50 html_url: *51 - instances_url: *332 - state: *129 - fixed_at: *125 + instances_url: *335 + state: *132 + fixed_at: *128 dismissed_by: title: Simple User description: A GitHub user. @@ -49978,9 +50662,9 @@ paths: properties: *4 required: *5 nullable: true - dismissed_at: *126 - dismissed_reason: *333 - dismissed_comment: *334 + dismissed_at: *129 + dismissed_reason: *336 + dismissed_comment: *337 rule: type: object properties: @@ -50034,8 +50718,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *336 - most_recent_instance: *337 + tool: *339 + most_recent_instance: *340 required: - number - created_at @@ -50124,9 +50808,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *338 + '403': *341 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50144,9 +50828,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *239 - - *240 - - *339 + - *242 + - *243 + - *342 requestBody: required: true content: @@ -50161,8 +50845,8 @@ paths: enum: - open - dismissed - dismissed_reason: *333 - dismissed_comment: *334 + dismissed_reason: *336 + dismissed_comment: *337 required: - state examples: @@ -50177,7 +50861,7 @@ paths: description: Response content: application/json: - schema: *340 + schema: *343 examples: default: value: @@ -50252,14 +50936,14 @@ paths: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '403': &347 + '403': &350 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *7 - '503': *60 + '503': *63 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50279,13 +50963,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *239 - - *240 - - *339 + - *242 + - *243 + - *342 - *20 - *18 - - *341 - - *342 + - *344 + - *345 responses: '200': description: Response @@ -50293,7 +50977,7 @@ paths: application/json: schema: type: array - items: *337 + items: *340 examples: default: value: @@ -50332,9 +51016,9 @@ paths: end_column: 50 classifications: - source - '403': *338 + '403': *341 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50366,25 +51050,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *239 - - *240 - - *327 - - *328 + - *242 + - *243 + - *330 + - *331 - *20 - *18 - - *342 + - *345 - 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: *329 + schema: *332 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &345 + schema: &348 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -50405,23 +51089,23 @@ paths: application/json: schema: type: array - items: &346 + items: &349 type: object properties: - ref: *329 - commit_sha: &355 + ref: *332 + commit_sha: &358 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: *343 + analysis_key: *346 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *344 + category: *347 error: type: string example: error reading field xyz @@ -50445,8 +51129,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *345 - tool: *336 + sarif_id: *348 + tool: *339 deletable: type: boolean warning: @@ -50507,9 +51191,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *338 + '403': *341 '404': *7 - '503': *60 + '503': *63 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50543,8 +51227,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: - - *239 - - *240 + - *242 + - *243 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -50557,7 +51241,7 @@ paths: description: Response content: application/json: - schema: *346 + schema: *349 examples: response: summary: application/json response @@ -50611,9 +51295,9 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *338 + '403': *341 '404': *7 - '503': *60 + '503': *63 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50693,8 +51377,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: - - *239 - - *240 + - *242 + - *243 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -50747,9 +51431,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': *15 - '403': *347 + '403': *350 '404': *7 - '503': *60 + '503': *63 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50769,8 +51453,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -50778,7 +51462,7 @@ paths: application/json: schema: type: array - items: &348 + items: &351 title: CodeQL Database description: A CodeQL database. type: object @@ -50889,9 +51573,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': *338 + '403': *341 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50918,8 +51602,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 - name: language in: path description: The language of the CodeQL database. @@ -50931,7 +51615,7 @@ paths: description: Response content: application/json: - schema: *348 + schema: *351 examples: default: value: @@ -50963,11 +51647,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': &384 + '302': &387 description: Found - '403': *338 + '403': *341 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50993,8 +51677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -51003,7 +51687,7 @@ paths: type: object additionalProperties: false properties: - language: &349 + language: &352 type: string description: The language targeted by the CodeQL query enum: @@ -51081,7 +51765,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &353 + schema: &356 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -51091,7 +51775,7 @@ paths: description: The ID of the variant analysis. controller_repo: *52 actor: *19 - query_language: *349 + query_language: *352 query_pack_url: type: string description: The download url for the query pack. @@ -51138,7 +51822,7 @@ paths: items: type: object properties: - repository: &350 + repository: &353 title: Repository Identifier description: Repository Identifier type: object @@ -51174,7 +51858,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &354 + analysis_status: &357 type: string description: The new status of the CodeQL variant analysis repository task. @@ -51206,7 +51890,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &351 + access_mismatch_repos: &354 type: object properties: repository_count: @@ -51220,7 +51904,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: *350 + items: *353 required: - repository_count - repositories @@ -51242,8 +51926,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *351 - over_limit_repos: *351 + no_codeql_db_repos: *354 + over_limit_repos: *354 required: - access_mismatch_repos - not_found_repos @@ -51259,7 +51943,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &352 + value: &355 summary: Default response value: id: 1 @@ -51411,17 +52095,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *352 + value: *355 repository_lists: summary: Response for a successful variant analysis submission - value: *352 + value: *355 '404': *7 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51442,8 +52126,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: - - *239 - - *240 + - *242 + - *243 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -51455,11 +52139,11 @@ paths: description: Response content: application/json: - schema: *353 + schema: *356 examples: - default: *352 + default: *355 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51480,7 +52164,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: - - *239 + - *242 - name: repo in: path description: The name of the controller repository. @@ -51515,7 +52199,7 @@ paths: type: object properties: repository: *52 - analysis_status: *354 + analysis_status: *357 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -51619,7 +52303,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51640,8 +52324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -51702,9 +52386,9 @@ paths: query_suite: default updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *338 + '403': *341 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51723,8 +52407,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -51769,7 +52453,7 @@ paths: description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -51794,7 +52478,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *347 + '403': *350 '404': *7 '409': description: Response if there is already a validation run in progress with @@ -51802,7 +52486,7 @@ paths: content: application/json: schema: *3 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51859,8 +52543,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -51868,7 +52552,7 @@ paths: schema: type: object properties: - commit_sha: *355 + commit_sha: *358 ref: type: string description: |- @@ -51926,7 +52610,7 @@ paths: schema: type: object properties: - id: *345 + id: *348 url: type: string description: The REST API URL for checking the status of the upload. @@ -51940,11 +52624,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': *347 + '403': *350 '404': *7 '413': description: Payload Too Large if the sarif field is too large - '503': *60 + '503': *63 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -51963,8 +52647,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *239 - - *240 + - *242 + - *243 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -52010,10 +52694,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': *338 + '403': *341 '404': description: Not Found if the sarif id does not match any upload - '503': *60 + '503': *63 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52035,8 +52719,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: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -52060,7 +52744,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *130 + configuration: *133 examples: default: value: @@ -52089,7 +52773,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': *134 + '204': *137 '304': *37 '403': *29 '404': *7 @@ -52114,8 +52798,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *239 - - *240 + - *242 + - *243 - 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 @@ -52235,8 +52919,8 @@ paths: parameters: - *18 - *20 - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -52252,7 +52936,7 @@ paths: type: integer codespaces: type: array - items: *170 + items: *173 examples: default: value: @@ -52550,8 +53234,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -52614,22 +53298,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '400': *15 '401': *25 '403': *29 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -52653,8 +53337,8 @@ paths: parameters: - *18 - *20 - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -52718,8 +53402,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -52754,14 +53438,14 @@ paths: type: integer machines: type: array - items: &563 + items: &566 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *357 - required: *358 + properties: *360 + required: *361 examples: - default: &564 + default: &567 value: total_count: 2 machines: @@ -52801,8 +53485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *239 - - *240 + - *242 + - *243 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -52886,8 +53570,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: - - *239 - - *240 + - *242 + - *243 - 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 @@ -52932,7 +53616,7 @@ paths: '403': *29 '404': *7 '422': *16 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52953,8 +53637,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -52972,7 +53656,7 @@ paths: type: integer secrets: type: array - items: &362 + items: &365 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -52992,7 +53676,7 @@ paths: - created_at - updated_at examples: - default: *359 + default: *362 headers: Link: *39 x-github: @@ -53015,16 +53699,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *360 + schema: *363 examples: - default: *361 + default: *364 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -53044,17 +53728,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 responses: '200': description: Response content: application/json: - schema: *362 + schema: *365 examples: - default: *363 + default: *366 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53074,9 +53758,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 requestBody: required: true content: @@ -53104,7 +53788,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -53128,9 +53812,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 responses: '204': description: Response @@ -53158,8 +53842,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *239 - - *240 + - *242 + - *243 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -53201,7 +53885,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &364 + properties: &367 login: type: string example: octocat @@ -53294,7 +53978,7 @@ paths: user_view_type: type: string example: public - required: &365 + required: &368 - avatar_url - events_url - followers_url @@ -53368,9 +54052,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *239 - - *240 - - *123 + - *242 + - *243 + - *126 responses: '204': description: Response if user is a collaborator @@ -53412,9 +54096,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *239 - - *240 - - *123 + - *242 + - *243 + - *126 requestBody: required: false content: @@ -53440,7 +54124,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &432 + schema: &435 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -53451,7 +54135,7 @@ paths: example: 42 type: integer format: int64 - repository: *110 + repository: *113 invitee: title: Simple User description: A GitHub user. @@ -53662,9 +54346,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *239 - - *240 - - *123 + - *242 + - *243 + - *126 responses: '204': description: No Content when collaborator was removed from the repository. @@ -53693,9 +54377,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *239 - - *240 - - *123 + - *242 + - *243 + - *126 responses: '200': description: if user has admin permissions @@ -53715,8 +54399,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *364 - required: *365 + properties: *367 + required: *368 nullable: true required: - permission @@ -53771,8 +54455,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -53782,7 +54466,7 @@ paths: application/json: schema: type: array - items: &366 + items: &369 title: Commit Comment description: Commit Comment type: object @@ -53823,8 +54507,8 @@ paths: updated_at: type: string format: date-time - author_association: *58 - reactions: *59 + author_association: *61 + reactions: *62 required: - url - html_url @@ -53840,7 +54524,7 @@ paths: - created_at - updated_at examples: - default: &369 + default: &372 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -53899,17 +54583,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 responses: '200': description: Response content: application/json: - schema: *366 + schema: *369 examples: - default: &370 + default: &373 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -53966,9 +54650,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 requestBody: required: true content: @@ -53990,7 +54674,7 @@ paths: description: Response content: application/json: - schema: *366 + schema: *369 examples: default: value: @@ -54041,9 +54725,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 responses: '204': description: Response @@ -54064,9 +54748,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 - 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. @@ -54092,9 +54776,9 @@ paths: application/json: schema: type: array - items: *232 + items: *235 examples: - default: *234 + default: *237 headers: Link: *39 '404': *7 @@ -54115,9 +54799,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 requestBody: required: true content: @@ -54149,16 +54833,16 @@ paths: description: Reaction exists content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '201': description: Reaction created content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '422': *16 x-github: githubCloudOnly: false @@ -54180,10 +54864,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *239 - - *240 - - *71 - - *235 + - *242 + - *243 + - *74 + - *238 responses: '204': description: Response @@ -54231,8 +54915,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *239 - - *240 + - *242 + - *243 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -54288,9 +54972,9 @@ paths: application/json: schema: type: array - items: *367 + items: *370 examples: - default: &483 + default: &486 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -54363,7 +55047,7 @@ paths: '500': *41 '400': *15 '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54383,9 +55067,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *239 - - *240 - - &368 + - *242 + - *243 + - &371 name: commit_sha description: The SHA of the commit. in: path @@ -54432,7 +55116,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *16 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54457,9 +55141,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *239 - - *240 - - *368 + - *242 + - *243 + - *371 - *18 - *20 responses: @@ -54469,9 +55153,9 @@ paths: application/json: schema: type: array - items: *366 + items: *369 examples: - default: *369 + default: *372 headers: Link: *39 x-github: @@ -54499,9 +55183,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *239 - - *240 - - *368 + - *242 + - *243 + - *371 requestBody: required: true content: @@ -54536,9 +55220,9 @@ paths: description: Response content: application/json: - schema: *366 + schema: *369 examples: - default: *370 + default: *373 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -54566,9 +55250,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *239 - - *240 - - *368 + - *242 + - *243 + - *371 - *18 - *20 responses: @@ -54578,7 +55262,7 @@ paths: application/json: schema: type: array - items: &473 + items: &476 title: Pull Request Simple description: Pull Request Simple type: object @@ -54684,8 +55368,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *371 - required: *372 + properties: *374 + required: *375 nullable: true active_lock_reason: type: string @@ -54730,7 +55414,7 @@ paths: nullable: true requested_teams: type: array - items: *166 + items: *169 nullable: true head: type: object @@ -54739,7 +55423,7 @@ paths: type: string ref: type: string - repo: *55 + repo: *58 sha: type: string user: @@ -54762,7 +55446,7 @@ paths: type: string ref: type: string - repo: *55 + repo: *58 sha: type: string user: @@ -54781,7 +55465,7 @@ paths: _links: type: object properties: - comments: &373 + comments: &376 title: Link description: Hypermedia Link type: object @@ -54790,13 +55474,13 @@ paths: type: string required: - href - commits: *373 - statuses: *373 - html: *373 - issue: *373 - review_comments: *373 - review_comment: *373 - self: *373 + commits: *376 + statuses: *376 + html: *376 + issue: *376 + review_comments: *376 + review_comment: *376 + self: *376 required: - comments - commits @@ -54806,8 +55490,8 @@ paths: - review_comments - review_comment - self - author_association: *58 - auto_merge: &476 + author_association: *61 + auto_merge: &479 title: Auto merge description: The status of auto merging a pull request. type: object @@ -54870,7 +55554,7 @@ paths: - author_association - auto_merge examples: - default: &474 + default: &477 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -55350,7 +56034,7 @@ paths: draft: false headers: Link: *39 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55406,11 +56090,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *239 - - *240 + - *242 + - *243 - *20 - *18 - - &374 + - &377 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)" @@ -55425,9 +56109,9 @@ paths: description: Response content: application/json: - schema: *367 + schema: *370 examples: - default: &460 + default: &463 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -55513,8 +56197,8 @@ paths: '422': *16 '404': *7 '500': *41 - '503': *60 - '409': *131 + '503': *63 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55539,11 +56223,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *239 - - *240 - - *374 - - *375 - - *376 + - *242 + - *243 + - *377 + - *378 + - *379 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -55577,9 +56261,9 @@ paths: type: integer check_runs: type: array - items: *319 + items: *322 examples: - default: *377 + default: *380 headers: Link: *39 x-github: @@ -55604,9 +56288,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *239 - - *240 - - *374 + - *242 + - *243 + - *377 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -55614,7 +56298,7 @@ paths: schema: type: integer example: 1 - - *375 + - *378 - *18 - *20 responses: @@ -55632,7 +56316,7 @@ paths: type: integer check_suites: type: array - items: *324 + items: *327 examples: default: value: @@ -55832,9 +56516,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *239 - - *240 - - *374 + - *242 + - *243 + - *377 - *18 - *20 responses: @@ -55901,7 +56585,7 @@ paths: type: string total_count: type: integer - repository: *110 + repository: *113 commit_url: type: string format: uri @@ -56032,9 +56716,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *239 - - *240 - - *374 + - *242 + - *243 + - *377 - *18 - *20 responses: @@ -56044,7 +56728,7 @@ paths: application/json: schema: type: array - items: &537 + items: &540 title: Status description: The status of a commit. type: object @@ -56125,7 +56809,7 @@ paths: site_admin: false headers: Link: *39 - '301': *251 + '301': *254 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56153,8 +56837,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -56183,20 +56867,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *378 - required: *379 + properties: *381 + required: *382 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &380 + properties: &383 url: type: string format: uri html_url: type: string format: uri - required: &381 + required: &384 - url - html_url nullable: true @@ -56204,32 +56888,32 @@ paths: title: License Simple description: License Simple type: object - properties: *73 - required: *74 + properties: *76 + required: *77 nullable: true contributing: title: Community Health File type: object - properties: *380 - required: *381 + properties: *383 + required: *384 nullable: true readme: title: Community Health File type: object - properties: *380 - required: *381 + properties: *383 + required: *384 nullable: true issue_template: title: Community Health File type: object - properties: *380 - required: *381 + properties: *383 + required: *384 nullable: true pull_request_template: title: Community Health File type: object - properties: *380 - required: *381 + properties: *383 + required: *384 nullable: true required: - code_of_conduct @@ -56355,8 +57039,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *239 - - *240 + - *242 + - *243 - *20 - *18 - name: basehead @@ -56399,8 +57083,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *367 - merge_base_commit: *367 + base_commit: *370 + merge_base_commit: *370 status: type: string enum: @@ -56420,10 +57104,10 @@ paths: example: 6 commits: type: array - items: *367 + items: *370 files: type: array - items: *382 + items: *385 required: - url - html_url @@ -56664,7 +57348,7 @@ paths: module Test" '404': *7 '500': *41 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56706,8 +57390,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *239 - - *240 + - *242 + - *243 - name: path description: path parameter in: path @@ -56848,7 +57532,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &383 + response-if-content-is-a-file: &386 summary: Response if content is a file value: type: file @@ -56980,7 +57664,7 @@ paths: - size - type - url - - &488 + - &491 title: Content File description: Content File type: object @@ -57181,7 +57865,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *383 + response-if-content-is-a-file: *386 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -57250,7 +57934,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *7 '403': *29 - '302': *384 + '302': *387 '304': *37 x-github: githubCloudOnly: false @@ -57273,8 +57957,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *239 - - *240 + - *242 + - *243 - name: path description: path parameter in: path @@ -57367,7 +58051,7 @@ paths: description: Response content: application/json: - schema: &385 + schema: &388 title: File Commit description: File Commit type: object @@ -57515,7 +58199,7 @@ paths: description: Response content: application/json: - schema: *385 + schema: *388 examples: example-for-creating-a-file: value: @@ -57568,7 +58252,7 @@ paths: schema: oneOf: - *3 - - &414 + - &417 description: Repository rule violation was detected type: object properties: @@ -57589,7 +58273,7 @@ paths: items: type: object properties: - placeholder_id: &530 + placeholder_id: &533 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -57621,8 +58305,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *239 - - *240 + - *242 + - *243 - name: path description: path parameter in: path @@ -57683,7 +58367,7 @@ paths: description: Response content: application/json: - schema: *385 + schema: *388 examples: default: value: @@ -57716,8 +58400,8 @@ paths: payload: '422': *16 '404': *7 - '409': *131 - '503': *60 + '409': *134 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57737,8 +58421,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *239 - - *240 + - *242 + - *243 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -57861,20 +58545,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *239 - - *240 - - *139 - - *140 - - *141 + - *242 + - *243 - *142 + - *143 + - *144 + - *145 - 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 - - *143 - - *144 + - *146 + - *147 - *42 - name: page description: "**Closing down notice**. Page number of the results to fetch. @@ -57894,8 +58578,8 @@ paths: default: 30 - *43 - *44 - - *145 - - *146 + - *148 + - *149 responses: '200': description: Response @@ -57903,7 +58587,7 @@ paths: application/json: schema: type: array - items: &388 + items: &391 type: object description: A Dependabot alert. properties: @@ -57936,13 +58620,13 @@ paths: enum: - development - runtime - security_advisory: *386 + security_advisory: *389 security_vulnerability: *47 url: *50 html_url: *51 created_at: *49 - updated_at: *124 - dismissed_at: *126 + updated_at: *127 + dismissed_at: *129 dismissed_by: title: Simple User description: A GitHub user. @@ -57966,8 +58650,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *125 - auto_dismissed_at: *387 + fixed_at: *128 + auto_dismissed_at: *390 required: - number - state @@ -58194,9 +58878,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *239 - - *240 - - &389 + - *242 + - *243 + - &392 name: alert_number in: path description: |- @@ -58211,7 +58895,7 @@ paths: description: Response content: application/json: - schema: *388 + schema: *391 examples: default: value: @@ -58321,9 +59005,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *239 - - *240 - - *389 + - *242 + - *243 + - *392 requestBody: required: true content: @@ -58368,7 +59052,7 @@ paths: description: Response content: application/json: - schema: *388 + schema: *391 examples: default: value: @@ -58474,7 +59158,7 @@ paths: '400': *15 '403': *29 '404': *7 - '409': *131 + '409': *134 '422': *8 x-github: githubCloudOnly: false @@ -58497,8 +59181,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -58516,7 +59200,7 @@ paths: type: integer secrets: type: array - items: &392 + items: &395 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -58569,16 +59253,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *390 + schema: *393 examples: - default: *391 + default: *394 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58598,15 +59282,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 responses: '200': description: Response content: application/json: - schema: *392 + schema: *395 examples: default: value: @@ -58632,9 +59316,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 requestBody: required: true content: @@ -58662,7 +59346,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -58686,9 +59370,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 responses: '204': description: Response @@ -58710,8 +59394,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: - - *239 - - *240 + - *242 + - *243 - 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 @@ -58871,8 +59555,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: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -59075,8 +59759,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: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -59151,7 +59835,7 @@ paths: - version - url additionalProperties: false - metadata: &393 + metadata: &396 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -59184,7 +59868,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *393 + metadata: *396 resolved: type: object description: A collection of resolved package dependencies. @@ -59197,7 +59881,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *393 + metadata: *396 relationship: type: string description: A notation of whether a dependency is requested @@ -59326,8 +60010,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *239 - - *240 + - *242 + - *243 - name: sha description: The SHA recorded at creation time. in: query @@ -59367,9 +60051,9 @@ paths: application/json: schema: type: array - items: *394 + items: *397 examples: - default: *395 + default: *398 headers: Link: *39 x-github: @@ -59435,8 +60119,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -59517,7 +60201,7 @@ paths: description: Response content: application/json: - schema: *394 + schema: *397 examples: simple-example: summary: Simple example @@ -59590,9 +60274,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *239 - - *240 - - &396 + - *242 + - *243 + - &399 name: deployment_id description: deployment_id parameter in: path @@ -59604,7 +60288,7 @@ paths: description: Response content: application/json: - schema: *394 + schema: *397 examples: default: value: @@ -59669,9 +60353,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *239 - - *240 - - *396 + - *242 + - *243 + - *399 responses: '204': description: Response @@ -59693,9 +60377,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *239 - - *240 - - *396 + - *242 + - *243 + - *399 - *18 - *20 responses: @@ -59705,7 +60389,7 @@ paths: application/json: schema: type: array - items: &397 + items: &400 title: Deployment Status description: The status of a deployment. type: object @@ -59796,8 +60480,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 required: - id - node_id @@ -59866,9 +60550,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *239 - - *240 - - *396 + - *242 + - *243 + - *399 requestBody: required: true content: @@ -59943,9 +60627,9 @@ paths: description: Response content: application/json: - schema: *397 + schema: *400 examples: - default: &398 + default: &401 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -60001,9 +60685,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *239 - - *240 - - *396 + - *242 + - *243 + - *399 - name: status_id in: path required: true @@ -60014,9 +60698,9 @@ paths: description: Response content: application/json: - schema: *397 + schema: *400 examples: - default: *398 + default: *401 '404': *7 x-github: githubCloudOnly: false @@ -60041,8 +60725,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -60099,8 +60783,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -60117,7 +60801,7 @@ paths: type: integer environments: type: array - items: &400 + items: &403 title: Environment description: Details of a deployment environment type: object @@ -60169,7 +60853,7 @@ paths: type: type: string example: wait_timer - wait_timer: &402 + wait_timer: &405 type: integer example: 30 description: The amount of time to delay a job after @@ -60206,11 +60890,11 @@ paths: items: type: object properties: - type: *399 + type: *402 reviewer: anyOf: - *19 - - *166 + - *169 required: - id - node_id @@ -60230,7 +60914,7 @@ paths: - id - node_id - type - deployment_branch_policy: &403 + deployment_branch_policy: &406 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -60346,9 +61030,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *239 - - *240 - - &401 + - *242 + - *243 + - &404 name: environment_name in: path required: true @@ -60361,9 +61045,9 @@ paths: description: Response content: application/json: - schema: *400 + schema: *403 examples: - default: &404 + default: &407 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -60447,9 +61131,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *239 - - *240 - - *401 + - *242 + - *243 + - *404 requestBody: required: false content: @@ -60458,7 +61142,7 @@ paths: type: object nullable: true properties: - wait_timer: *402 + wait_timer: *405 prevent_self_review: type: boolean example: false @@ -60475,13 +61159,13 @@ paths: items: type: object properties: - type: *399 + type: *402 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *403 + deployment_branch_policy: *406 additionalProperties: false examples: default: @@ -60501,9 +61185,9 @@ paths: description: Response content: application/json: - schema: *400 + schema: *403 examples: - default: *404 + default: *407 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -60527,9 +61211,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *239 - - *240 - - *401 + - *242 + - *243 + - *404 responses: '204': description: Default response @@ -60554,9 +61238,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *239 - - *240 - - *401 + - *242 + - *243 + - *404 - *18 - *20 responses: @@ -60574,7 +61258,7 @@ paths: example: 2 branch_policies: type: array - items: &405 + items: &408 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -60631,9 +61315,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *239 - - *240 - - *401 + - *242 + - *243 + - *404 requestBody: required: true content: @@ -60679,9 +61363,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *408 examples: - example-wildcard: &406 + example-wildcard: &409 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -60723,10 +61407,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *239 - - *240 - - *401 - - &407 + - *242 + - *243 + - *404 + - &410 name: branch_policy_id in: path required: true @@ -60738,9 +61422,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *408 examples: - default: *406 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60759,10 +61443,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *239 - - *240 - - *401 - - *407 + - *242 + - *243 + - *404 + - *410 requestBody: required: true content: @@ -60790,9 +61474,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *408 examples: - default: *406 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60811,10 +61495,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *239 - - *240 - - *401 - - *407 + - *242 + - *243 + - *404 + - *410 responses: '204': description: Response @@ -60839,9 +61523,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *401 - - *240 - - *239 + - *404 + - *243 + - *242 responses: '200': description: List of deployment protection rules @@ -60857,7 +61541,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &408 + items: &411 title: Deployment protection rule description: Deployment protection rule type: object @@ -60876,7 +61560,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &409 + app: &412 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -60975,9 +61659,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: - - *401 - - *240 - - *239 + - *404 + - *243 + - *242 requestBody: content: application/json: @@ -60998,9 +61682,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *408 + schema: *411 examples: - default: &410 + default: &413 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -61035,9 +61719,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: - - *401 - - *240 - - *239 + - *404 + - *243 + - *242 - *20 - *18 responses: @@ -61056,7 +61740,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *409 + items: *412 examples: default: value: @@ -61091,10 +61775,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *239 - - *240 - - *401 - - &411 + - *242 + - *243 + - *404 + - &414 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -61106,9 +61790,9 @@ paths: description: Response content: application/json: - schema: *408 + schema: *411 examples: - default: *410 + default: *413 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61129,10 +61813,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *401 - - *240 - - *239 - - *411 + - *404 + - *243 + - *242 + - *414 responses: '204': description: Response @@ -61158,9 +61842,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *239 - - *240 - - *401 + - *242 + - *243 + - *404 - *18 - *20 responses: @@ -61178,9 +61862,9 @@ paths: type: integer secrets: type: array - items: *285 + items: *288 examples: - default: *286 + default: *289 headers: Link: *39 x-github: @@ -61205,17 +61889,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *239 - - *240 - - *401 + - *242 + - *243 + - *404 responses: '200': description: Response content: application/json: - schema: *287 + schema: *290 examples: - default: *288 + default: *291 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61237,18 +61921,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *239 - - *240 - - *401 - - *118 + - *242 + - *243 + - *404 + - *121 responses: '200': description: Response content: application/json: - schema: *285 + schema: *288 examples: - default: *412 + default: *415 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61270,10 +61954,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *239 - - *240 - - *401 - - *118 + - *242 + - *243 + - *404 + - *121 requestBody: required: true content: @@ -61304,7 +61988,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -61330,10 +62014,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *239 - - *240 - - *401 - - *118 + - *242 + - *243 + - *404 + - *121 responses: '204': description: Default response @@ -61358,10 +62042,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *239 - - *240 - - *401 - - *261 + - *242 + - *243 + - *404 + - *264 - *20 responses: '200': @@ -61378,9 +62062,9 @@ paths: type: integer variables: type: array - items: *289 + items: *292 examples: - default: *290 + default: *293 headers: Link: *39 x-github: @@ -61403,9 +62087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *239 - - *240 - - *401 + - *242 + - *243 + - *404 requestBody: required: true content: @@ -61432,7 +62116,7 @@ paths: description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -61457,18 +62141,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *239 - - *240 - - *401 - - *121 + - *242 + - *243 + - *404 + - *124 responses: '200': description: Response content: application/json: - schema: *289 + schema: *292 examples: - default: *413 + default: *416 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61489,10 +62173,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *239 - - *240 - - *121 - - *401 + - *242 + - *243 + - *124 + - *404 requestBody: required: true content: @@ -61534,10 +62218,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *239 - - *240 - - *121 - - *401 + - *242 + - *243 + - *124 + - *404 responses: '204': description: Response @@ -61559,8 +62243,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -61570,7 +62254,7 @@ paths: application/json: schema: type: array - items: *84 + items: *87 examples: 200-response: value: @@ -61637,8 +62321,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *239 - - *240 + - *242 + - *243 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -61660,7 +62344,7 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: default: value: @@ -61797,8 +62481,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: false content: @@ -61830,9 +62514,9 @@ paths: description: Response content: application/json: - schema: *250 + schema: *253 examples: - default: *252 + default: *255 '400': *15 '422': *16 '403': *29 @@ -61853,8 +62537,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -61905,7 +62589,7 @@ paths: schema: type: string '404': *7 - '409': *131 + '409': *134 '403': *29 '422': description: Validation failed @@ -61913,8 +62597,8 @@ paths: application/json: schema: oneOf: - - *94 - - *414 + - *97 + - *417 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61939,8 +62623,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *239 - - *240 + - *242 + - *243 - name: file_sha in: path required: true @@ -61991,7 +62675,7 @@ paths: '404': *7 '422': *16 '403': *29 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62038,8 +62722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -62148,7 +62832,7 @@ paths: description: Response content: application/json: - schema: &415 + schema: &418 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -62307,7 +62991,7 @@ paths: type: string '422': *16 '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62356,15 +63040,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *239 - - *240 - - *368 + - *242 + - *243 + - *371 responses: '200': description: Response content: application/json: - schema: *415 + schema: *418 examples: default: value: @@ -62394,7 +63078,7 @@ paths: signature: payload: '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62419,9 +63103,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *239 - - *240 - - &416 + - *242 + - *243 + - &419 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. @@ -62438,7 +63122,7 @@ paths: application/json: schema: type: array - items: &417 + items: &420 title: Git Reference description: Git references within a repository type: object @@ -62492,7 +63176,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *39 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62513,17 +63197,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *239 - - *240 - - *416 + - *242 + - *243 + - *419 responses: '200': description: Response content: application/json: - schema: *417 + schema: *420 examples: - default: &418 + default: &421 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -62533,7 +63217,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62552,8 +63236,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -62582,16 +63266,16 @@ paths: description: Response content: application/json: - schema: *417 + schema: *420 examples: - default: *418 + default: *421 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *16 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62610,9 +63294,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *239 - - *240 - - *416 + - *242 + - *243 + - *419 requestBody: required: true content: @@ -62641,11 +63325,11 @@ paths: description: Response content: application/json: - schema: *417 + schema: *420 examples: - default: *418 + default: *421 '422': *16 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62661,14 +63345,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *239 - - *240 - - *416 + - *242 + - *243 + - *419 responses: '204': description: Response '422': *16 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62715,8 +63399,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -62783,7 +63467,7 @@ paths: description: Response content: application/json: - schema: &420 + schema: &423 title: Git Tag description: Metadata for a Git tag type: object @@ -62834,7 +63518,7 @@ paths: - sha - type - url - verification: *419 + verification: *422 required: - sha - url @@ -62844,7 +63528,7 @@ paths: - tag - message examples: - default: &421 + default: &424 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -62870,7 +63554,7 @@ paths: schema: type: string '422': *16 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62915,8 +63599,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *239 - - *240 + - *242 + - *243 - name: tag_sha in: path required: true @@ -62927,11 +63611,11 @@ paths: description: Response content: application/json: - schema: *420 + schema: *423 examples: - default: *421 + default: *424 '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62953,8 +63637,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -63027,7 +63711,7 @@ paths: description: Response content: application/json: - schema: &422 + schema: &425 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -63116,7 +63800,7 @@ paths: '422': *16 '404': *7 '403': *29 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63139,8 +63823,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *239 - - *240 + - *242 + - *243 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -63163,7 +63847,7 @@ paths: description: Response content: application/json: - schema: *422 + schema: *425 examples: default-response: summary: Default response @@ -63204,7 +63888,7 @@ paths: truncated: false '422': *16 '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63222,8 +63906,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -63233,7 +63917,7 @@ paths: application/json: schema: type: array - items: &423 + items: &426 title: Webhook description: Webhooks for repositories. type: object @@ -63287,7 +63971,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &640 + last_response: &643 title: Hook Response type: object properties: @@ -63361,8 +64045,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: false content: @@ -63414,9 +64098,9 @@ paths: description: Response content: application/json: - schema: *423 + schema: *426 examples: - default: &424 + default: &427 value: type: Repository id: 12345678 @@ -63464,17 +64148,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 responses: '200': description: Response content: application/json: - schema: *423 + schema: *426 examples: - default: *424 + default: *427 '404': *7 x-github: githubCloudOnly: false @@ -63494,9 +64178,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 requestBody: required: true content: @@ -63541,9 +64225,9 @@ paths: description: Response content: application/json: - schema: *423 + schema: *426 examples: - default: *424 + default: *427 '422': *16 '404': *7 x-github: @@ -63561,9 +64245,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 responses: '204': description: Response @@ -63587,9 +64271,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 responses: '200': description: Response @@ -63616,9 +64300,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 requestBody: required: false content: @@ -63662,11 +64346,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 - *18 - - *155 + - *158 - name: redelivery in: query required: false @@ -63679,9 +64363,9 @@ paths: application/json: schema: type: array - items: *156 + items: *159 examples: - default: *157 + default: *160 '400': *15 '422': *16 x-github: @@ -63700,18 +64384,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 - *17 responses: '200': description: Response content: application/json: - schema: *158 + schema: *161 examples: - default: *159 + default: *162 '400': *15 '422': *16 x-github: @@ -63730,12 +64414,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 - *17 responses: - '202': *96 + '202': *99 '400': *15 '422': *16 x-github: @@ -63755,9 +64439,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 responses: '204': description: Response @@ -63782,9 +64466,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 responses: '204': description: Response @@ -63842,14 +64526,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: &425 + schema: &428 title: Import description: A repository import from an external source. type: object @@ -63948,7 +64632,7 @@ paths: - html_url - authors_url examples: - default: &428 + default: &431 value: vcs: subversion use_lfs: true @@ -63964,7 +64648,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *7 - '503': &426 + '503': &429 description: Unavailable due to service under maintenance. content: application/json: @@ -63993,8 +64677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -64042,7 +64726,7 @@ paths: description: Response content: application/json: - schema: *425 + schema: *428 examples: default: value: @@ -64067,7 +64751,7 @@ paths: type: string '422': *16 '404': *7 - '503': *426 + '503': *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64095,8 +64779,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: false content: @@ -64145,7 +64829,7 @@ paths: description: Response content: application/json: - schema: *425 + schema: *428 examples: example-1: summary: Example 1 @@ -64193,7 +64877,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': *426 + '503': *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64216,12 +64900,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response - '503': *426 + '503': *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64247,9 +64931,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *239 - - *240 - - &587 + - *242 + - *243 + - &590 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -64263,7 +64947,7 @@ paths: application/json: schema: type: array - items: &427 + items: &430 title: Porter Author description: Porter Author type: object @@ -64317,7 +65001,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *7 - '503': *426 + '503': *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64342,8 +65026,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *239 - - *240 + - *242 + - *243 - name: author_id in: path required: true @@ -64373,7 +65057,7 @@ paths: description: Response content: application/json: - schema: *427 + schema: *430 examples: default: value: @@ -64386,7 +65070,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *16 '404': *7 - '503': *426 + '503': *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64410,8 +65094,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -64452,7 +65136,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *426 + '503': *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64480,8 +65164,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -64508,11 +65192,11 @@ paths: description: Response content: application/json: - schema: *425 + schema: *428 examples: - default: *428 + default: *431 '422': *16 - '503': *426 + '503': *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64535,8 +65219,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -64544,8 +65228,8 @@ paths: application/json: schema: *22 examples: - default: *429 - '301': *251 + default: *432 + '301': *254 '404': *7 x-github: githubCloudOnly: false @@ -64565,8 +65249,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -64574,12 +65258,12 @@ paths: application/json: schema: anyOf: - - *161 + - *164 - type: object properties: {} additionalProperties: false examples: - default: &431 + default: &434 value: limit: collaborators_only origin: repository @@ -64604,13 +65288,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: application/json: - schema: *430 + schema: *433 examples: default: summary: Example request body @@ -64622,9 +65306,9 @@ paths: description: Response content: application/json: - schema: *161 + schema: *164 examples: - default: *431 + default: *434 '409': description: Response x-github: @@ -64646,8 +65330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -64670,8 +65354,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -64681,9 +65365,9 @@ paths: application/json: schema: type: array - items: *432 + items: *435 examples: - default: &580 + default: &583 value: - id: 1 repository: @@ -64814,9 +65498,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *239 - - *240 - - *165 + - *242 + - *243 + - *168 requestBody: required: false content: @@ -64845,7 +65529,7 @@ paths: description: Response content: application/json: - schema: *432 + schema: *435 examples: default: value: @@ -64976,9 +65660,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *239 - - *240 - - *165 + - *242 + - *243 + - *168 responses: '204': description: Response @@ -65009,8 +65693,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *239 - - *240 + - *242 + - *243 - 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 @@ -65050,7 +65734,7 @@ paths: required: false schema: type: string - - *167 + - *170 - name: sort description: What to sort results by. in: query @@ -65063,7 +65747,7 @@ paths: - comments default: created - *42 - - *62 + - *65 - *18 - *20 responses: @@ -65073,7 +65757,7 @@ paths: application/json: schema: type: array - items: *72 + items: *75 examples: default: value: @@ -65223,7 +65907,7 @@ paths: state_reason: completed headers: Link: *39 - '301': *251 + '301': *254 '422': *16 '404': *7 x-github: @@ -65252,8 +65936,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -65328,9 +66012,9 @@ paths: description: Response content: application/json: - schema: *72 + schema: *75 examples: - default: &438 + default: &441 value: id: 1 node_id: MDU6SXNzdWUx @@ -65484,9 +66168,9 @@ paths: '400': *15 '403': *29 '422': *16 - '503': *60 + '503': *63 '404': *7 - '410': *248 + '410': *251 x-github: triggersNotification: true githubCloudOnly: false @@ -65514,9 +66198,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *239 - - *240 - - *82 + - *242 + - *243 + - *85 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -65526,7 +66210,7 @@ paths: enum: - asc - desc - - *62 + - *65 - *18 - *20 responses: @@ -65536,9 +66220,9 @@ paths: application/json: schema: type: array - items: *433 + items: *436 examples: - default: &440 + default: &443 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -65596,17 +66280,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 responses: '200': description: Response content: application/json: - schema: *433 + schema: *436 examples: - default: &434 + default: &437 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -65660,9 +66344,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 requestBody: required: true content: @@ -65684,9 +66368,9 @@ paths: description: Response content: application/json: - schema: *433 + schema: *436 examples: - default: *434 + default: *437 '422': *16 x-github: githubCloudOnly: false @@ -65704,9 +66388,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 responses: '204': description: Response @@ -65726,9 +66410,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 - 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. @@ -65754,9 +66438,9 @@ paths: application/json: schema: type: array - items: *232 + items: *235 examples: - default: *234 + default: *237 headers: Link: *39 '404': *7 @@ -65777,9 +66461,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 requestBody: required: true content: @@ -65811,16 +66495,16 @@ paths: description: Reaction exists content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '201': description: Reaction created content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '422': *16 x-github: githubCloudOnly: false @@ -65842,10 +66526,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *239 - - *240 - - *71 - - *235 + - *242 + - *243 + - *74 + - *238 responses: '204': description: Response @@ -65865,8 +66549,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -65876,7 +66560,7 @@ paths: application/json: schema: type: array - items: &437 + items: &440 title: Issue Event description: Issue Event type: object @@ -65919,8 +66603,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *435 - required: *436 + properties: *438 + required: *439 nullable: true label: title: Issue Event Label @@ -65964,7 +66648,7 @@ paths: properties: *4 required: *5 nullable: true - requested_team: *166 + requested_team: *169 dismissed_review: title: Issue Event Dismissed Review type: object @@ -66029,7 +66713,7 @@ paths: required: - from - to - author_association: *58 + author_association: *61 lock_reason: type: string nullable: true @@ -66042,8 +66726,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 required: - id - node_id @@ -66227,8 +66911,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *239 - - *240 + - *242 + - *243 - name: event_id in: path required: true @@ -66239,7 +66923,7 @@ paths: description: Response content: application/json: - schema: *437 + schema: *440 examples: default: value: @@ -66432,7 +67116,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *7 - '410': *248 + '410': *251 '403': *29 x-github: githubCloudOnly: false @@ -66466,9 +67150,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *239 - - *240 - - &439 + - *242 + - *243 + - &442 name: issue_number description: The number that identifies the issue. in: path @@ -66480,12 +67164,12 @@ paths: description: Response content: application/json: - schema: *72 + schema: *75 examples: - default: *438 - '301': *251 + default: *441 + '301': *254 '404': *7 - '410': *248 + '410': *251 '304': *37 x-github: githubCloudOnly: false @@ -66510,9 +67194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 requestBody: required: false content: @@ -66607,15 +67291,15 @@ paths: description: Response content: application/json: - schema: *72 + schema: *75 examples: - default: *438 + default: *441 '422': *16 - '503': *60 + '503': *63 '403': *29 - '301': *251 + '301': *254 '404': *7 - '410': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66633,9 +67317,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 requestBody: required: false content: @@ -66661,9 +67345,9 @@ paths: description: Response content: application/json: - schema: *72 + schema: *75 examples: - default: *438 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66679,9 +67363,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 requestBody: content: application/json: @@ -66706,9 +67390,9 @@ paths: description: Response content: application/json: - schema: *72 + schema: *75 examples: - default: *438 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66730,9 +67414,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: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 - name: assignee in: path required: true @@ -66772,10 +67456,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *239 - - *240 - - *439 - - *62 + - *242 + - *243 + - *442 + - *65 - *18 - *20 responses: @@ -66785,13 +67469,13 @@ paths: application/json: schema: type: array - items: *433 + items: *436 examples: - default: *440 + default: *443 headers: Link: *39 '404': *7 - '410': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66820,9 +67504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 requestBody: required: true content: @@ -66844,16 +67528,16 @@ paths: description: Response content: application/json: - schema: *433 + schema: *436 examples: - default: *434 + default: *437 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *248 + '410': *251 '422': *16 '404': *7 x-github: @@ -66873,9 +67557,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 - *18 - *20 responses: @@ -66889,7 +67573,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &443 + - &446 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -66920,8 +67604,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 label: type: object properties: @@ -66943,7 +67627,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &444 + - &447 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -66974,8 +67658,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 label: type: object properties: @@ -67063,8 +67747,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 assignee: *19 assigner: *19 required: @@ -67079,7 +67763,7 @@ paths: - performed_via_github_app - assignee - assigner - - &445 + - &448 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -67110,8 +67794,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 milestone: type: object properties: @@ -67130,7 +67814,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &446 + - &449 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -67161,8 +67845,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 milestone: type: object properties: @@ -67181,7 +67865,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &447 + - &450 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -67212,8 +67896,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 rename: type: object properties: @@ -67235,7 +67919,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &448 + - &451 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -67266,10 +67950,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 review_requester: *19 - requested_team: *166 + requested_team: *169 requested_reviewer: *19 required: - review_requester @@ -67282,7 +67966,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &449 + - &452 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -67313,10 +67997,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 review_requester: *19 - requested_team: *166 + requested_team: *169 requested_reviewer: *19 required: - review_requester @@ -67329,7 +68013,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &450 + - &453 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -67360,8 +68044,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 dismissed_review: type: object properties: @@ -67389,7 +68073,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &451 + - &454 title: Locked Issue Event description: Locked Issue Event type: object @@ -67420,8 +68104,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 lock_reason: type: string example: '"off-topic"' @@ -67437,7 +68121,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &452 + - &455 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -67468,8 +68152,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 project_card: type: object properties: @@ -67503,7 +68187,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &453 + - &456 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -67534,8 +68218,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 project_card: type: object properties: @@ -67569,7 +68253,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &454 + - &457 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -67600,8 +68284,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 project_card: type: object properties: @@ -67635,7 +68319,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &455 + - &458 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -67726,7 +68410,7 @@ paths: color: red headers: Link: *39 - '410': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67743,9 +68427,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 - *18 - *20 responses: @@ -67755,7 +68439,7 @@ paths: application/json: schema: type: array - items: &441 + items: &444 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -67802,7 +68486,7 @@ paths: - color - default examples: - default: &442 + default: &445 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -67820,9 +68504,9 @@ paths: default: false headers: Link: *39 - '301': *251 + '301': *254 '404': *7 - '410': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67839,9 +68523,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 requestBody: required: false content: @@ -67900,12 +68584,12 @@ paths: application/json: schema: type: array - items: *441 + items: *444 examples: - default: *442 - '301': *251 + default: *445 + '301': *254 '404': *7 - '410': *248 + '410': *251 '422': *16 x-github: githubCloudOnly: false @@ -67922,9 +68606,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 requestBody: required: false content: @@ -67984,12 +68668,12 @@ paths: application/json: schema: type: array - items: *441 + items: *444 examples: - default: *442 - '301': *251 + default: *445 + '301': *254 '404': *7 - '410': *248 + '410': *251 '422': *16 x-github: githubCloudOnly: false @@ -68006,15 +68690,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 responses: '204': description: Response - '301': *251 + '301': *254 '404': *7 - '410': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68033,9 +68717,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 - name: name in: path required: true @@ -68048,7 +68732,7 @@ paths: application/json: schema: type: array - items: *441 + items: *444 examples: default: value: @@ -68059,9 +68743,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *251 + '301': *254 '404': *7 - '410': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68081,9 +68765,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 requestBody: required: false content: @@ -68111,7 +68795,7 @@ paths: '204': description: Response '403': *29 - '410': *248 + '410': *251 '404': *7 '422': *16 x-github: @@ -68129,9 +68813,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 responses: '204': description: Response @@ -68153,9 +68837,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 - 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. @@ -68181,13 +68865,13 @@ paths: application/json: schema: type: array - items: *232 + items: *235 examples: - default: *234 + default: *237 headers: Link: *39 '404': *7 - '410': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68205,9 +68889,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 requestBody: required: true content: @@ -68239,16 +68923,16 @@ paths: description: Response content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '201': description: Response content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '422': *16 x-github: githubCloudOnly: false @@ -68270,10 +68954,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *239 - - *240 - - *439 - - *235 + - *242 + - *243 + - *442 + - *238 responses: '204': description: Response @@ -68293,9 +68977,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 - *18 - *20 responses: @@ -68310,9 +68994,6 @@ paths: description: Timeline Event type: object anyOf: - - *443 - - *444 - - *445 - *446 - *447 - *448 @@ -68323,6 +69004,9 @@ paths: - *453 - *454 - *455 + - *456 + - *457 + - *458 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -68365,7 +69049,7 @@ paths: issue_url: type: string format: uri - author_association: *58 + author_association: *61 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -68375,9 +69059,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 - reactions: *59 + properties: *59 + required: *60 + reactions: *62 required: - event - actor @@ -68408,7 +69092,7 @@ paths: properties: type: type: string - issue: *72 + issue: *75 required: - event - created_at @@ -68600,7 +69284,7 @@ paths: type: string body_text: type: string - author_association: *58 + author_association: *61 required: - event - id @@ -68623,7 +69307,7 @@ paths: type: string comments: type: array - items: &477 + items: &480 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -68712,7 +69396,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *58 + author_association: *61 _links: type: object properties: @@ -68796,7 +69480,7 @@ paths: enum: - line - file - reactions: *59 + reactions: *62 body_html: type: string example: '"

comment body

"' @@ -68832,7 +69516,7 @@ paths: type: string comments: type: array - items: *366 + items: *369 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -68863,8 +69547,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 assignee: *19 required: - id @@ -68907,8 +69591,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 assignee: *19 required: - id @@ -68951,8 +69635,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 state_reason: type: string nullable: true @@ -69121,7 +69805,7 @@ paths: headers: Link: *39 '404': *7 - '410': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69138,8 +69822,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -69149,7 +69833,7 @@ paths: application/json: schema: type: array - items: &456 + items: &459 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -69211,8 +69895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -69248,9 +69932,9 @@ paths: description: Response content: application/json: - schema: *456 + schema: *459 examples: - default: &457 + default: &460 value: id: 1 key: ssh-rsa AAA... @@ -69283,9 +69967,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *239 - - *240 - - &458 + - *242 + - *243 + - &461 name: key_id description: The unique identifier of the key. in: path @@ -69297,9 +69981,9 @@ paths: description: Response content: application/json: - schema: *456 + schema: *459 examples: - default: *457 + default: *460 '404': *7 x-github: githubCloudOnly: false @@ -69317,9 +70001,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *239 - - *240 - - *458 + - *242 + - *243 + - *461 responses: '204': description: Response @@ -69339,8 +70023,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -69350,9 +70034,9 @@ paths: application/json: schema: type: array - items: *441 + items: *444 examples: - default: *442 + default: *445 headers: Link: *39 '404': *7 @@ -69373,8 +70057,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -69410,9 +70094,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *444 examples: - default: &459 + default: &462 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -69444,8 +70128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *239 - - *240 + - *242 + - *243 - name: name in: path required: true @@ -69456,9 +70140,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *444 examples: - default: *459 + default: *462 '404': *7 x-github: githubCloudOnly: false @@ -69475,8 +70159,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *239 - - *240 + - *242 + - *243 - name: name in: path required: true @@ -69515,7 +70199,7 @@ paths: description: Response content: application/json: - schema: *441 + schema: *444 examples: default: value: @@ -69541,8 +70225,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *239 - - *240 + - *242 + - *243 - name: name in: path required: true @@ -69568,8 +70252,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -69608,9 +70292,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *239 - - *240 - - *341 + - *242 + - *243 + - *344 responses: '200': description: Response @@ -69672,8 +70356,8 @@ paths: title: License Simple description: License Simple type: object - properties: *73 - required: *74 + properties: *76 + required: *77 nullable: true required: - _links @@ -69755,8 +70439,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -69821,8 +70505,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -69856,9 +70540,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *367 + schema: *370 examples: - default: *460 + default: *463 '204': description: Response when already merged '404': @@ -69883,8 +70567,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *239 - - *240 + - *242 + - *243 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -69925,12 +70609,12 @@ paths: application/json: schema: type: array - items: &461 + items: &464 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *371 - required: *372 + properties: *374 + required: *375 examples: default: value: @@ -69986,8 +70670,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -70027,9 +70711,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *464 examples: - default: &462 + default: &465 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -70088,9 +70772,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *239 - - *240 - - &463 + - *242 + - *243 + - &466 name: milestone_number description: The number that identifies the milestone. in: path @@ -70102,9 +70786,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *464 examples: - default: *462 + default: *465 '404': *7 x-github: githubCloudOnly: false @@ -70121,9 +70805,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *239 - - *240 - - *463 + - *242 + - *243 + - *466 requestBody: required: false content: @@ -70161,9 +70845,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *464 examples: - default: *462 + default: *465 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70179,9 +70863,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *239 - - *240 - - *463 + - *242 + - *243 + - *466 responses: '204': description: Response @@ -70202,9 +70886,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *239 - - *240 - - *463 + - *242 + - *243 + - *466 - *18 - *20 responses: @@ -70214,9 +70898,9 @@ paths: application/json: schema: type: array - items: *441 + items: *444 examples: - default: *442 + default: *445 headers: Link: *39 x-github: @@ -70235,12 +70919,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *239 - - *240 - - *464 - - *465 - - *62 - - *466 + - *242 + - *243 + - *467 + - *468 + - *65 + - *469 - *18 - *20 responses: @@ -70250,9 +70934,9 @@ paths: application/json: schema: type: array - items: *85 + items: *88 examples: - default: *467 + default: *470 headers: Link: *39 x-github: @@ -70276,8 +70960,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: false content: @@ -70335,14 +71019,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: &468 + schema: &471 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -70467,7 +71151,7 @@ paths: - custom_404 - public examples: - default: &469 + default: &472 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -70508,8 +71192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -70563,11 +71247,11 @@ paths: description: Response content: application/json: - schema: *468 + schema: *471 examples: - default: *469 + default: *472 '422': *16 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70588,8 +71272,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -70667,7 +71351,7 @@ paths: description: Response '422': *16 '400': *15 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70688,14 +71372,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response '422': *16 '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70715,8 +71399,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -70726,7 +71410,7 @@ paths: application/json: schema: type: array - items: &470 + items: &473 title: Page Build description: Page Build type: object @@ -70820,8 +71504,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *239 - - *240 + - *242 + - *243 responses: '201': description: Response @@ -70866,16 +71550,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *470 + schema: *473 examples: - default: &471 + default: &474 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -70923,8 +71607,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *239 - - *240 + - *242 + - *243 - name: build_id in: path required: true @@ -70935,9 +71619,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *473 examples: - default: *471 + default: *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70957,8 +71641,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -71064,9 +71748,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *239 - - *240 - - &472 + - *242 + - *243 + - &475 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -71124,11 +71808,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *239 - - *240 - - *472 + - *242 + - *243 + - *475 responses: - '204': *134 + '204': *137 '404': *7 x-github: githubCloudOnly: false @@ -71153,8 +71837,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -71385,7 +72069,7 @@ paths: description: Empty response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -71412,8 +72096,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: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Private vulnerability reporting status @@ -71450,10 +72134,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: - '204': *134 + '204': *137 '422': *15 x-github: githubCloudOnly: false @@ -71472,10 +72156,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: - '204': *134 + '204': *137 '422': *15 x-github: githubCloudOnly: false @@ -71496,8 +72180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-repository-projects parameters: - - *239 - - *240 + - *242 + - *243 - name: state description: Indicates the state of the projects to return. in: query @@ -71518,7 +72202,7 @@ paths: application/json: schema: type: array - items: *197 + items: *200 examples: default: value: @@ -71558,7 +72242,7 @@ paths: '401': *25 '403': *29 '404': *7 - '410': *248 + '410': *251 '422': *8 x-github: githubCloudOnly: false @@ -71578,8 +72262,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#create-a-repository-project parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -71605,13 +72289,13 @@ paths: description: Response content: application/json: - schema: *197 + schema: *200 examples: - default: *247 + default: *250 '401': *25 '403': *29 '404': *7 - '410': *248 + '410': *251 '422': *8 x-github: githubCloudOnly: false @@ -71631,8 +72315,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -71640,7 +72324,7 @@ paths: application/json: schema: type: array - items: *202 + items: *205 examples: default: value: @@ -71671,8 +72355,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: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -71684,7 +72368,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *202 + items: *205 required: - properties examples: @@ -71734,8 +72418,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *239 - - *240 + - *242 + - *243 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -71795,9 +72479,9 @@ paths: application/json: schema: type: array - items: *473 + items: *476 examples: - default: *474 + default: *477 headers: Link: *39 '304': *37 @@ -71829,8 +72513,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -71895,7 +72579,7 @@ paths: description: Response content: application/json: - schema: &479 + schema: &482 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -72006,8 +72690,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *371 - required: *372 + properties: *374 + required: *375 nullable: true active_lock_reason: type: string @@ -72052,7 +72736,7 @@ paths: nullable: true requested_teams: type: array - items: *475 + items: *478 nullable: true head: type: object @@ -72061,7 +72745,7 @@ paths: type: string ref: type: string - repo: *55 + repo: *58 sha: type: string user: *19 @@ -72078,7 +72762,7 @@ paths: type: string ref: type: string - repo: *55 + repo: *58 sha: type: string user: *19 @@ -72091,14 +72775,14 @@ paths: _links: type: object properties: - comments: *373 - commits: *373 - statuses: *373 - html: *373 - issue: *373 - review_comments: *373 - review_comment: *373 - self: *373 + comments: *376 + commits: *376 + statuses: *376 + html: *376 + issue: *376 + review_comments: *376 + review_comment: *376 + self: *376 required: - comments - commits @@ -72108,8 +72792,8 @@ paths: - review_comments - review_comment - self - author_association: *58 - auto_merge: *476 + author_association: *61 + auto_merge: *479 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -72201,7 +72885,7 @@ paths: - merged_by - review_comments examples: - default: &480 + default: &483 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -72728,8 +73412,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *239 - - *240 + - *242 + - *243 - name: sort in: query required: false @@ -72748,7 +73432,7 @@ paths: enum: - asc - desc - - *62 + - *65 - *18 - *20 responses: @@ -72758,9 +73442,9 @@ paths: application/json: schema: type: array - items: *477 + items: *480 examples: - default: &482 + default: &485 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -72837,17 +73521,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 responses: '200': description: Response content: application/json: - schema: *477 + schema: *480 examples: - default: &478 + default: &481 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -72922,9 +73606,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 requestBody: required: true content: @@ -72946,9 +73630,9 @@ paths: description: Response content: application/json: - schema: *477 + schema: *480 examples: - default: *478 + default: *481 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72964,9 +73648,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 responses: '204': description: Response @@ -72987,9 +73671,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 - 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. @@ -73015,9 +73699,9 @@ paths: application/json: schema: type: array - items: *232 + items: *235 examples: - default: *234 + default: *237 headers: Link: *39 '404': *7 @@ -73038,9 +73722,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 requestBody: required: true content: @@ -73072,16 +73756,16 @@ paths: description: Reaction exists content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '201': description: Reaction created content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '422': *16 x-github: githubCloudOnly: false @@ -73103,10 +73787,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *239 - - *240 - - *71 - - *235 + - *242 + - *243 + - *74 + - *238 responses: '204': description: Response @@ -73149,9 +73833,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *239 - - *240 - - &481 + - *242 + - *243 + - &484 name: pull_number description: The number that identifies the pull request. in: path @@ -73164,9 +73848,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *479 + schema: *482 examples: - default: *480 + default: *483 '304': *37 '404': *7 '406': @@ -73175,7 +73859,7 @@ paths: application/json: schema: *3 '500': *41 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73201,9 +73885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 requestBody: required: false content: @@ -73245,9 +73929,9 @@ paths: description: Response content: application/json: - schema: *479 + schema: *482 examples: - default: *480 + default: *483 '422': *16 '403': *29 x-github: @@ -73269,9 +73953,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 requestBody: required: true content: @@ -73331,21 +74015,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '401': *25 '403': *29 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -73371,10 +74055,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *239 - - *240 - - *481 - - *82 + - *242 + - *243 + - *484 + - *85 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -73384,7 +74068,7 @@ paths: enum: - asc - desc - - *62 + - *65 - *18 - *20 responses: @@ -73394,9 +74078,9 @@ paths: application/json: schema: type: array - items: *477 + items: *480 examples: - default: *482 + default: *485 headers: Link: *39 x-github: @@ -73429,9 +74113,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 requestBody: required: true content: @@ -73536,7 +74220,7 @@ paths: description: Response content: application/json: - schema: *477 + schema: *480 examples: example-for-a-multi-line-comment: value: @@ -73624,10 +74308,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *239 - - *240 - - *481 - - *71 + - *242 + - *243 + - *484 + - *74 requestBody: required: true content: @@ -73649,7 +74333,7 @@ paths: description: Response content: application/json: - schema: *477 + schema: *480 examples: default: value: @@ -73735,9 +74419,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 - *18 - *20 responses: @@ -73747,9 +74431,9 @@ paths: application/json: schema: type: array - items: *367 + items: *370 examples: - default: *483 + default: *486 headers: Link: *39 x-github: @@ -73779,9 +74463,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 - *18 - *20 responses: @@ -73791,7 +74475,7 @@ paths: application/json: schema: type: array - items: *382 + items: *385 examples: default: value: @@ -73810,7 +74494,7 @@ paths: Link: *39 '422': *16 '500': *41 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73829,9 +74513,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 responses: '204': description: Response if pull request has been merged @@ -73854,9 +74538,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 requestBody: required: false content: @@ -73967,9 +74651,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 responses: '200': description: Response @@ -73985,7 +74669,7 @@ paths: items: *19 teams: type: array - items: *166 + items: *169 required: - users - teams @@ -74044,9 +74728,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 requestBody: required: false content: @@ -74083,7 +74767,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *476 examples: default: value: @@ -74619,9 +75303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 requestBody: required: true content: @@ -74655,7 +75339,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *476 examples: default: value: @@ -75160,9 +75844,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 - *18 - *20 responses: @@ -75172,7 +75856,7 @@ paths: application/json: schema: type: array - items: &484 + items: &487 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -75241,7 +75925,7 @@ paths: type: string body_text: type: string - author_association: *58 + author_association: *61 required: - id - node_id @@ -75323,9 +76007,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 requestBody: required: false content: @@ -75411,9 +76095,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *487 examples: - default: &486 + default: &489 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -75476,10 +76160,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *239 - - *240 - - *481 - - &485 + - *242 + - *243 + - *484 + - &488 name: review_id description: The unique identifier of the review. in: path @@ -75491,9 +76175,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *487 examples: - default: &487 + default: &490 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -75552,10 +76236,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *239 - - *240 - - *481 - - *485 + - *242 + - *243 + - *484 + - *488 requestBody: required: true content: @@ -75578,7 +76262,7 @@ paths: description: Response content: application/json: - schema: *484 + schema: *487 examples: default: value: @@ -75640,18 +76324,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *239 - - *240 - - *481 - - *485 + - *242 + - *243 + - *484 + - *488 responses: '200': description: Response content: application/json: - schema: *484 + schema: *487 examples: - default: *486 + default: *489 '422': *8 '404': *7 x-github: @@ -75678,10 +76362,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *239 - - *240 - - *481 - - *485 + - *242 + - *243 + - *484 + - *488 - *18 - *20 responses: @@ -75760,13 +76444,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *58 + author_association: *61 _links: type: object properties: - self: *373 - html: *373 - pull_request: *373 + self: *376 + html: *376 + pull_request: *376 required: - self - html @@ -75775,7 +76459,7 @@ paths: type: string body_html: type: string - reactions: *59 + reactions: *62 side: description: The side of the first line of the range for a multi-line comment. @@ -75909,10 +76593,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *239 - - *240 - - *481 - - *485 + - *242 + - *243 + - *484 + - *488 requestBody: required: true content: @@ -75940,7 +76624,7 @@ paths: description: Response content: application/json: - schema: *484 + schema: *487 examples: default: value: @@ -76003,10 +76687,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *239 - - *240 - - *481 - - *485 + - *242 + - *243 + - *484 + - *488 requestBody: required: true content: @@ -76041,9 +76725,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *487 examples: - default: *487 + default: *490 '404': *7 '422': *8 '403': *29 @@ -76065,9 +76749,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 requestBody: required: false content: @@ -76130,8 +76814,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *239 - - *240 + - *242 + - *243 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -76144,9 +76828,9 @@ paths: description: Response content: application/json: - schema: *488 + schema: *491 examples: - default: &489 + default: &492 value: type: file encoding: base64 @@ -76188,8 +76872,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *239 - - *240 + - *242 + - *243 - name: dir description: The alternate path to look for a README file in: path @@ -76209,9 +76893,9 @@ paths: description: Response content: application/json: - schema: *488 + schema: *491 examples: - default: *489 + default: *492 '404': *7 '422': *16 x-github: @@ -76233,8 +76917,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -76244,7 +76928,7 @@ paths: application/json: schema: type: array - items: &490 + items: &493 title: Release description: A release. type: object @@ -76307,7 +76991,7 @@ paths: author: *19 assets: type: array - items: &491 + items: &494 title: Release Asset description: Data related to a release. type: object @@ -76378,7 +77062,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *59 + reactions: *62 required: - assets_url - upload_url @@ -76488,8 +77172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -76565,9 +77249,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *493 examples: - default: &494 + default: &497 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -76668,9 +77352,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *239 - - *240 - - &492 + - *242 + - *243 + - &495 name: asset_id description: The unique identifier of the asset. in: path @@ -76682,9 +77366,9 @@ paths: description: Response content: application/json: - schema: *491 + schema: *494 examples: - default: &493 + default: &496 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 @@ -76718,7 +77402,7 @@ paths: type: User site_admin: false '404': *7 - '302': *384 + '302': *387 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76734,9 +77418,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *239 - - *240 - - *492 + - *242 + - *243 + - *495 requestBody: required: false content: @@ -76764,9 +77448,9 @@ paths: description: Response content: application/json: - schema: *491 + schema: *494 examples: - default: *493 + default: *496 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76782,9 +77466,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *239 - - *240 - - *492 + - *242 + - *243 + - *495 responses: '204': description: Response @@ -76808,8 +77492,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -76894,16 +77578,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *490 + schema: *493 examples: - default: *494 + default: *497 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76920,8 +77604,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *239 - - *240 + - *242 + - *243 - name: tag description: tag parameter in: path @@ -76934,9 +77618,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *493 examples: - default: *494 + default: *497 '404': *7 x-github: githubCloudOnly: false @@ -76958,9 +77642,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *239 - - *240 - - &495 + - *242 + - *243 + - &498 name: release_id description: The unique identifier of the release. in: path @@ -76974,9 +77658,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: *490 + schema: *493 examples: - default: *494 + default: *497 '401': description: Unauthorized x-github: @@ -76994,9 +77678,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *239 - - *240 - - *495 + - *242 + - *243 + - *498 requestBody: required: false content: @@ -77060,9 +77744,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *493 examples: - default: *494 + default: *497 '404': description: Not Found if the discussion category name is invalid content: @@ -77083,9 +77767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *239 - - *240 - - *495 + - *242 + - *243 + - *498 responses: '204': description: Response @@ -77105,9 +77789,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *239 - - *240 - - *495 + - *242 + - *243 + - *498 - *18 - *20 responses: @@ -77117,7 +77801,7 @@ paths: application/json: schema: type: array - items: *491 + items: *494 examples: default: value: @@ -77197,9 +77881,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: - - *239 - - *240 - - *495 + - *242 + - *243 + - *498 - name: name in: query required: true @@ -77225,7 +77909,7 @@ paths: description: Response for successful upload content: application/json: - schema: *491 + schema: *494 examples: response-for-successful-upload: value: @@ -77279,9 +77963,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *239 - - *240 - - *495 + - *242 + - *243 + - *498 - 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. @@ -77305,9 +77989,9 @@ paths: application/json: schema: type: array - items: *232 + items: *235 examples: - default: *234 + default: *237 headers: Link: *39 '404': *7 @@ -77328,9 +78012,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *239 - - *240 - - *495 + - *242 + - *243 + - *498 requestBody: required: true content: @@ -77360,16 +78044,16 @@ paths: description: Reaction exists content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '201': description: Reaction created content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '422': *16 x-github: githubCloudOnly: false @@ -77391,10 +78075,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *239 - - *240 - - *495 - - *235 + - *242 + - *243 + - *498 + - *238 responses: '204': description: Response @@ -77418,9 +78102,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 - *18 - *20 responses: @@ -77436,8 +78120,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *496 - - &498 + - *499 + - &501 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -77456,54 +78140,54 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *497 - - *498 - - allOf: - - *499 - - *498 - allOf: - *500 - - *498 - - allOf: - *501 - - *498 - allOf: - *502 - - *498 + - *501 - allOf: - *503 - - *498 + - *501 - allOf: - *504 - - *498 + - *501 - allOf: - *505 - - *498 + - *501 - allOf: - *506 - - *498 + - *501 - allOf: - *507 - - *498 + - *501 - allOf: - *508 - - *498 + - *501 - allOf: - *509 - - *498 + - *501 - allOf: - *510 - - *498 + - *501 - allOf: - *511 - - *498 + - *501 - allOf: - *512 - - *498 + - *501 - allOf: - *513 - - *498 + - *501 + - allOf: + - *514 + - *501 + - allOf: + - *515 + - *501 + - allOf: + - *516 + - *501 examples: default: value: @@ -77542,8 +78226,8 @@ paths: category: repos subcategory: rules parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 - name: includes_parents @@ -77554,7 +78238,7 @@ paths: schema: type: boolean default: true - - *514 + - *517 responses: '200': description: Response @@ -77562,7 +78246,7 @@ paths: application/json: schema: type: array - items: *212 + items: *215 examples: default: value: @@ -77609,8 +78293,8 @@ paths: category: repos subcategory: rules parameters: - - *239 - - *240 + - *242 + - *243 requestBody: description: Request body required: true @@ -77630,16 +78314,16 @@ paths: - tag - push default: branch - enforcement: *208 + enforcement: *211 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *209 - conditions: *206 + items: *212 + conditions: *209 rules: type: array description: An array of rules within the ruleset. - items: *211 + items: *214 required: - name - enforcement @@ -77670,9 +78354,9 @@ paths: description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: &524 + default: &527 value: id: 42 name: super cool ruleset @@ -77719,12 +78403,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *239 - - *240 - - *515 - - *516 - - *517 + - *242 + - *243 - *518 + - *519 + - *520 + - *521 - *18 - *20 responses: @@ -77732,9 +78416,9 @@ paths: description: Response content: application/json: - schema: *519 + schema: *522 examples: - default: *520 + default: *523 '404': *7 '500': *41 x-github: @@ -77755,17 +78439,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *239 - - *240 - - *521 + - *242 + - *243 + - *524 responses: '200': description: Response content: application/json: - schema: *522 + schema: *525 examples: - default: *523 + default: *526 '404': *7 '500': *41 x-github: @@ -77793,8 +78477,8 @@ paths: category: repos subcategory: rules parameters: - - *239 - - *240 + - *242 + - *243 - name: ruleset_id description: The ID of the ruleset. in: path @@ -77814,9 +78498,9 @@ paths: description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: *524 + default: *527 '404': *7 '500': *41 put: @@ -77834,8 +78518,8 @@ paths: category: repos subcategory: rules parameters: - - *239 - - *240 + - *242 + - *243 - name: ruleset_id description: The ID of the ruleset. in: path @@ -77860,16 +78544,16 @@ paths: - branch - tag - push - enforcement: *208 + enforcement: *211 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *209 - conditions: *206 + items: *212 + conditions: *209 rules: description: An array of rules within the ruleset. type: array - items: *211 + items: *214 examples: default: value: @@ -77897,9 +78581,9 @@ paths: description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: *524 + default: *527 '404': *7 '500': *41 delete: @@ -77917,8 +78601,8 @@ paths: category: repos subcategory: rules parameters: - - *239 - - *240 + - *242 + - *243 - name: ruleset_id description: The ID of the ruleset. in: path @@ -77946,20 +78630,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *239 - - *240 - - *214 - - *215 - - *216 + - *242 + - *243 - *217 - - *42 - - *20 - - *18 - - *525 - - *526 - *218 - *219 - *220 + - *42 + - *20 + - *18 + - *528 + - *529 + - *221 + - *222 + - *223 responses: '200': description: Response @@ -77967,7 +78651,7 @@ paths: application/json: schema: type: array - items: &529 + items: &532 type: object properties: number: *48 @@ -77986,8 +78670,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *527 - resolution: *528 + state: *530 + resolution: *531 resolved_at: type: string format: date-time @@ -78130,7 +78814,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78152,15 +78836,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *239 - - *240 - - *339 + - *242 + - *243 + - *342 responses: '200': description: Response content: application/json: - schema: *529 + schema: *532 examples: default: value: @@ -78187,7 +78871,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78208,9 +78892,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *239 - - *240 - - *339 + - *242 + - *243 + - *342 requestBody: required: true content: @@ -78218,8 +78902,8 @@ paths: schema: type: object properties: - state: *527 - resolution: *528 + state: *530 + resolution: *531 resolution_comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -78237,7 +78921,7 @@ paths: description: Response content: application/json: - schema: *529 + schema: *532 examples: default: value: @@ -78286,7 +78970,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *60 + '503': *63 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -78308,9 +78992,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *239 - - *240 - - *339 + - *242 + - *243 + - *342 - *20 - *18 responses: @@ -78321,7 +79005,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &661 + items: &664 type: object properties: type: @@ -78658,7 +79342,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78680,8 +79364,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -78689,14 +79373,14 @@ paths: schema: type: object properties: - reason: &531 + reason: &534 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *530 + placeholder_id: *533 required: - reason - placeholder_id @@ -78713,7 +79397,7 @@ paths: schema: type: object properties: - reason: *531 + reason: *534 expire_at: type: string format: date-time @@ -78736,7 +79420,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *60 + '503': *63 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -78758,8 +79442,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *239 - - *240 + - *242 + - *243 - *42 - name: sort description: The property to sort the results by. @@ -78803,9 +79487,9 @@ paths: application/json: schema: type: array - items: *532 + items: *535 examples: - default: *533 + default: *536 '400': *15 '404': *7 x-github: @@ -78828,8 +79512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -78902,7 +79586,7 @@ paths: login: type: string description: The username of the user credited. - type: *223 + type: *226 required: - login - type @@ -78989,9 +79673,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *535 examples: - default: &535 + default: &538 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -79224,8 +79908,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -79329,7 +80013,7 @@ paths: description: Response content: application/json: - schema: *532 + schema: *535 examples: default: value: @@ -79476,17 +80160,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *239 - - *240 - - *534 + - *242 + - *243 + - *537 responses: '200': description: Response content: application/json: - schema: *532 + schema: *535 examples: - default: *535 + default: *538 '403': *29 '404': *7 x-github: @@ -79510,9 +80194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *239 - - *240 - - *534 + - *242 + - *243 + - *537 requestBody: required: true content: @@ -79585,7 +80269,7 @@ paths: login: type: string description: The username of the user credited. - type: *223 + type: *226 required: - login - type @@ -79671,17 +80355,17 @@ paths: description: Response content: application/json: - schema: *532 + schema: *535 examples: - default: *535 - add_credit: *535 + default: *538 + add_credit: *538 '403': *29 '404': *7 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *94 + schema: *97 examples: invalid_state_transition: value: @@ -79712,11 +80396,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: - - *239 - - *240 - - *534 + - *242 + - *243 + - *537 responses: - '202': *96 + '202': *99 '400': *15 '403': *29 '404': *7 @@ -79741,17 +80425,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *239 - - *240 - - *534 + - *242 + - *243 + - *537 responses: '202': description: Response content: application/json: - schema: *250 + schema: *253 examples: - default: *252 + default: *255 '400': *15 '422': *16 '403': *29 @@ -79777,8 +80461,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -79877,8 +80561,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -79887,7 +80571,7 @@ paths: application/json: schema: type: array - items: &536 + items: &539 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -79899,8 +80583,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *96 - '204': *134 + '202': *99 + '204': *137 '422': description: Repository contains more than 10,000 commits x-github: @@ -79920,8 +80604,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -79969,8 +80653,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *96 - '204': *134 + '202': *99 + '204': *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79997,8 +80681,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -80071,8 +80755,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *96 - '204': *134 + '202': *99 + '204': *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80094,8 +80778,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -80249,8 +80933,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -80260,7 +80944,7 @@ paths: application/json: schema: type: array - items: *536 + items: *539 examples: default: value: @@ -80273,7 +80957,7 @@ paths: - - 0 - 2 - 21 - '204': *134 + '204': *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80293,8 +80977,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *239 - - *240 + - *242 + - *243 - name: sha in: path required: true @@ -80348,7 +81032,7 @@ paths: description: Response content: application/json: - schema: *537 + schema: *540 examples: default: value: @@ -80402,8 +81086,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -80415,7 +81099,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 x-github: @@ -80435,14 +81119,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &538 + schema: &541 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -80510,8 +81194,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: false content: @@ -80537,7 +81221,7 @@ paths: description: Response content: application/json: - schema: *538 + schema: *541 examples: default: value: @@ -80564,8 +81248,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -80585,8 +81269,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -80665,8 +81349,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -80674,7 +81358,7 @@ paths: application/json: schema: type: array - items: &539 + items: &542 title: Tag protection description: Tag protection type: object @@ -80726,8 +81410,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: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -80750,7 +81434,7 @@ paths: description: Response content: application/json: - schema: *539 + schema: *542 examples: default: value: @@ -80781,8 +81465,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: - - *239 - - *240 + - *242 + - *243 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -80819,8 +81503,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *239 - - *240 + - *242 + - *243 - name: ref in: path required: true @@ -80856,8 +81540,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -80867,9 +81551,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - default: *183 + default: *186 headers: Link: *39 '404': *7 @@ -80889,8 +81573,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *239 - - *240 + - *242 + - *243 - *20 - *18 responses: @@ -80898,7 +81582,7 @@ paths: description: Response content: application/json: - schema: &540 + schema: &543 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -80910,7 +81594,7 @@ paths: required: - names examples: - default: &541 + default: &544 value: names: - octocat @@ -80933,8 +81617,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -80965,9 +81649,9 @@ paths: description: Response content: application/json: - schema: *540 + schema: *543 examples: - default: *541 + default: *544 '404': *7 '422': *8 x-github: @@ -80988,9 +81672,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *239 - - *240 - - &542 + - *242 + - *243 + - &545 name: per description: The time frame to display results for. in: query @@ -81019,7 +81703,7 @@ paths: example: 128 clones: type: array - items: &543 + items: &546 title: Traffic type: object properties: @@ -81106,8 +81790,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -81197,8 +81881,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -81258,9 +81942,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *239 - - *240 - - *542 + - *242 + - *243 + - *545 responses: '200': description: Response @@ -81279,7 +81963,7 @@ paths: example: 3782 views: type: array - items: *543 + items: *546 required: - uniques - count @@ -81356,8 +82040,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -81393,7 +82077,7 @@ paths: description: Response content: application/json: - schema: *110 + schema: *113 examples: default: value: @@ -81631,8 +82315,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -81655,8 +82339,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -81678,8 +82362,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -81705,8 +82389,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *239 - - *240 + - *242 + - *243 - name: ref in: path required: true @@ -81798,9 +82482,9 @@ paths: description: Response content: application/json: - schema: *250 + schema: *253 examples: - default: *252 + default: *255 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -81841,7 +82525,7 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: default: value: @@ -82030,7 +82714,7 @@ paths: html_url: type: string format: uri - repository: *110 + repository: *113 score: type: number file_size: @@ -82048,7 +82732,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &544 + text_matches: &547 title: Search Result Text Matches type: array items: @@ -82162,7 +82846,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *60 + '503': *63 '422': *16 '403': *29 x-github: @@ -82210,7 +82894,7 @@ paths: enum: - author-date - committer-date - - &545 + - &548 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 @@ -82281,7 +82965,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *305 + properties: *308 nullable: true comment_count: type: integer @@ -82301,7 +82985,7 @@ paths: url: type: string format: uri - verification: *419 + verification: *422 required: - author - committer @@ -82320,7 +83004,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *305 + properties: *308 nullable: true parents: type: array @@ -82333,12 +83017,12 @@ paths: type: string sha: type: string - repository: *110 + repository: *113 score: type: number node_id: type: string - text_matches: *544 + text_matches: *547 required: - sha - node_id @@ -82530,7 +83214,7 @@ paths: - interactions - created - updated - - *545 + - *548 - *18 - *20 responses: @@ -82635,8 +83319,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *371 - required: *372 + properties: *374 + required: *375 nullable: true comments: type: integer @@ -82650,7 +83334,7 @@ paths: type: string format: date-time nullable: true - text_matches: *544 + text_matches: *547 pull_request: type: object properties: @@ -82683,10 +83367,10 @@ paths: type: string score: type: number - author_association: *58 + author_association: *61 draft: type: boolean - repository: *55 + repository: *58 body_html: type: string body_text: @@ -82703,9 +83387,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 - reactions: *59 + properties: *59 + required: *60 + reactions: *62 required: - assignee - closed_at @@ -82821,7 +83505,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *60 + '503': *63 '422': *16 '304': *37 '403': *29 @@ -82874,7 +83558,7 @@ paths: enum: - created - updated - - *545 + - *548 - *18 - *20 responses: @@ -82918,7 +83602,7 @@ paths: nullable: true score: type: number - text_matches: *544 + text_matches: *547 required: - id - node_id @@ -83003,7 +83687,7 @@ paths: - forks - help-wanted-issues - updated - - *545 + - *548 - *18 - *20 responses: @@ -83222,8 +83906,8 @@ paths: title: License Simple description: License Simple type: object - properties: *73 - required: *74 + properties: *76 + required: *77 nullable: true permissions: type: object @@ -83242,7 +83926,7 @@ paths: - admin - pull - push - text_matches: *544 + text_matches: *547 temp_clone_token: type: string allow_merge_commit: @@ -83444,7 +84128,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *60 + '503': *63 '422': *16 '304': *37 x-github: @@ -83542,7 +84226,7 @@ paths: type: string format: uri nullable: true - text_matches: *544 + text_matches: *547 related: type: array nullable: true @@ -83733,7 +84417,7 @@ paths: - followers - repositories - joined - - *545 + - *548 - *18 - *20 responses: @@ -83837,7 +84521,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *544 + text_matches: *547 blog: type: string nullable: true @@ -83896,7 +84580,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *60 + '503': *63 '422': *16 x-github: githubCloudOnly: false @@ -83916,7 +84600,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &546 + - &549 name: team_id description: The unique identifier of the team. in: path @@ -83928,9 +84612,9 @@ paths: description: Response content: application/json: - schema: *224 + schema: *227 examples: - default: *225 + default: *228 '404': *7 x-github: githubCloudOnly: false @@ -83957,7 +84641,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *546 + - *549 requestBody: required: true content: @@ -84020,16 +84704,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *224 + schema: *227 examples: - default: *225 + default: *228 '201': description: Response content: application/json: - schema: *224 + schema: *227 examples: - default: *225 + default: *228 '404': *7 '422': *16 '403': *29 @@ -84057,7 +84741,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *546 + - *549 responses: '204': description: Response @@ -84088,7 +84772,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *546 + - *549 - *42 - *18 - *20 @@ -84099,9 +84783,9 @@ paths: application/json: schema: type: array - items: *226 + items: *229 examples: - default: *547 + default: *550 headers: Link: *39 x-github: @@ -84130,7 +84814,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *546 + - *549 requestBody: required: true content: @@ -84164,9 +84848,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: *227 + default: *230 x-github: triggersNotification: true githubCloudOnly: false @@ -84193,16 +84877,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *546 - - *228 + - *549 + - *231 responses: '200': description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: *227 + default: *230 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84227,8 +84911,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *546 - - *228 + - *549 + - *231 requestBody: required: false content: @@ -84251,9 +84935,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: *548 + default: *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84278,8 +84962,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *546 - - *228 + - *549 + - *231 responses: '204': description: Response @@ -84308,8 +84992,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *546 - - *228 + - *549 + - *231 - *42 - *18 - *20 @@ -84320,9 +85004,9 @@ paths: application/json: schema: type: array - items: *229 + items: *232 examples: - default: *549 + default: *552 headers: Link: *39 x-github: @@ -84351,8 +85035,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *546 - - *228 + - *549 + - *231 requestBody: required: true content: @@ -84374,9 +85058,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *232 examples: - default: *230 + default: *233 x-github: triggersNotification: true githubCloudOnly: false @@ -84403,17 +85087,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *546 - - *228 + - *549 - *231 + - *234 responses: '200': description: Response content: application/json: - schema: *229 + schema: *232 examples: - default: *230 + default: *233 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84438,9 +85122,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *546 - - *228 + - *549 - *231 + - *234 requestBody: required: true content: @@ -84462,9 +85146,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *232 examples: - default: *550 + default: *553 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84489,9 +85173,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *546 - - *228 + - *549 - *231 + - *234 responses: '204': description: Response @@ -84520,9 +85204,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *546 - - *228 + - *549 - *231 + - *234 - 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. @@ -84548,9 +85232,9 @@ paths: application/json: schema: type: array - items: *232 + items: *235 examples: - default: *234 + default: *237 headers: Link: *39 x-github: @@ -84579,9 +85263,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *546 - - *228 + - *549 - *231 + - *234 requestBody: required: true content: @@ -84613,9 +85297,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84641,8 +85325,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *546 - - *228 + - *549 + - *231 - 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. @@ -84668,9 +85352,9 @@ paths: application/json: schema: type: array - items: *232 + items: *235 examples: - default: *234 + default: *237 headers: Link: *39 x-github: @@ -84699,8 +85383,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *546 - - *228 + - *549 + - *231 requestBody: required: true content: @@ -84732,9 +85416,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -84758,7 +85442,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *546 + - *549 - *18 - *20 responses: @@ -84768,9 +85452,9 @@ paths: application/json: schema: type: array - items: *163 + items: *166 examples: - default: *164 + default: *167 headers: Link: *39 x-github: @@ -84796,7 +85480,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *546 + - *549 - name: role description: Filters members returned by their role in the team. in: query @@ -84819,7 +85503,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 '404': *7 @@ -84847,8 +85531,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *546 - - *123 + - *549 + - *126 responses: '204': description: if user is a member @@ -84884,8 +85568,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *546 - - *123 + - *549 + - *126 responses: '204': description: Response @@ -84924,8 +85608,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *546 - - *123 + - *549 + - *126 responses: '204': description: Response @@ -84961,16 +85645,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *546 - - *123 + - *549 + - *126 responses: '200': description: Response content: application/json: - schema: *236 + schema: *239 examples: - response-if-user-is-a-team-maintainer: *551 + response-if-user-is-a-team-maintainer: *554 '404': *7 x-github: githubCloudOnly: false @@ -85003,8 +85687,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *546 - - *123 + - *549 + - *126 requestBody: required: false content: @@ -85029,9 +85713,9 @@ paths: description: Response content: application/json: - schema: *236 + schema: *239 examples: - response-if-users-membership-with-team-is-now-pending: *552 + response-if-users-membership-with-team-is-now-pending: *555 '403': description: Forbidden if team synchronization is set up '422': @@ -85065,8 +85749,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *546 - - *123 + - *549 + - *126 responses: '204': description: Response @@ -85095,7 +85779,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *546 + - *549 - *18 - *20 responses: @@ -85105,9 +85789,9 @@ paths: application/json: schema: type: array - items: *237 + items: *240 examples: - default: *553 + default: *556 headers: Link: *39 '404': *7 @@ -85134,16 +85818,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *546 - - *238 + - *549 + - *241 responses: '200': description: Response content: application/json: - schema: *237 + schema: *240 examples: - default: *554 + default: *557 '404': description: Not Found if project is not managed by this team x-github: @@ -85168,8 +85852,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *546 - - *238 + - *549 + - *241 requestBody: required: false content: @@ -85237,8 +85921,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *546 - - *238 + - *549 + - *241 responses: '204': description: Response @@ -85265,7 +85949,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *546 + - *549 - *18 - *20 responses: @@ -85275,9 +85959,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 '404': *7 @@ -85307,15 +85991,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *546 - - *239 - - *240 + - *549 + - *242 + - *243 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *555 + schema: *558 examples: alternative-response-with-extra-repository-information: value: @@ -85466,9 +86150,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *546 - - *239 - - *240 + - *549 + - *242 + - *243 requestBody: required: false content: @@ -85518,9 +86202,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *546 - - *239 - - *240 + - *549 + - *242 + - *243 responses: '204': description: Response @@ -85545,7 +86229,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *546 + - *549 - *18 - *20 responses: @@ -85555,9 +86239,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - response-if-child-teams-exist: *556 + response-if-child-teams-exist: *559 headers: Link: *39 '404': *7 @@ -85590,7 +86274,7 @@ paths: application/json: schema: oneOf: - - &558 + - &561 title: Private User description: Private User type: object @@ -85793,7 +86477,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *557 + - *560 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -85946,7 +86630,7 @@ paths: description: Response content: application/json: - schema: *558 + schema: *561 examples: default: value: @@ -86025,7 +86709,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 '304': *37 '404': *7 '403': *29 @@ -86048,7 +86732,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: - - *123 + - *126 responses: '204': description: If the user is blocked @@ -86076,7 +86760,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *123 + - *126 responses: '204': description: Response @@ -86100,7 +86784,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *123 + - *126 responses: '204': description: Response @@ -86149,9 +86833,9 @@ paths: type: integer codespaces: type: array - items: *170 + items: *173 examples: - default: *171 + default: *174 '304': *37 '500': *41 '401': *25 @@ -86290,21 +86974,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '401': *25 '403': *29 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -86344,7 +87028,7 @@ paths: type: integer secrets: type: array - items: &559 + items: &562 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -86384,7 +87068,7 @@ paths: - visibility - selected_repositories_url examples: - default: *359 + default: *362 headers: Link: *39 x-github: @@ -86454,13 +87138,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *118 + - *121 responses: '200': description: Response content: application/json: - schema: *559 + schema: *562 examples: default: value: @@ -86490,7 +87174,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *118 + - *121 requestBody: required: true content: @@ -86535,7 +87219,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -86563,7 +87247,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *118 + - *121 responses: '204': description: Response @@ -86588,7 +87272,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *118 + - *121 responses: '200': description: Response @@ -86604,9 +87288,9 @@ paths: type: integer repositories: type: array - items: *110 + items: *113 examples: - default: *560 + default: *563 '401': *25 '403': *29 '404': *7 @@ -86631,7 +87315,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *118 + - *121 requestBody: required: true content: @@ -86685,7 +87369,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *118 + - *121 - name: repository_id in: path required: true @@ -86718,7 +87402,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *118 + - *121 - name: repository_id in: path required: true @@ -86750,15 +87434,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *172 + - *175 responses: '200': description: Response content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '304': *37 '500': *41 '401': *25 @@ -86784,7 +87468,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *172 + - *175 requestBody: required: false content: @@ -86814,9 +87498,9 @@ paths: description: Response content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '401': *25 '403': *29 '404': *7 @@ -86838,9 +87522,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *172 + - *175 responses: - '202': *96 + '202': *99 '304': *37 '500': *41 '401': *25 @@ -86867,13 +87551,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *172 + - *175 responses: '202': description: Response content: application/json: - schema: &561 + schema: &564 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -86914,7 +87598,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &562 + default: &565 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -86946,7 +87630,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *172 + - *175 - name: export_id in: path required: true @@ -86959,9 +87643,9 @@ paths: description: Response content: application/json: - schema: *561 + schema: *564 examples: - default: *562 + default: *565 '404': *7 x-github: githubCloudOnly: false @@ -86982,7 +87666,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *172 + - *175 responses: '200': description: Response @@ -86998,9 +87682,9 @@ paths: type: integer machines: type: array - items: *563 + items: *566 examples: - default: *564 + default: *567 '304': *37 '500': *41 '401': *25 @@ -87029,7 +87713,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *172 + - *175 requestBody: required: true content: @@ -87079,13 +87763,13 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *250 + repository: *253 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *357 - required: *358 + properties: *360 + required: *361 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -87859,15 +88543,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *172 + - *175 responses: '200': description: Response content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '304': *37 '500': *41 '400': *15 @@ -87879,7 +88563,7 @@ paths: schema: *3 '403': *29 '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -87899,15 +88583,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *172 + - *175 responses: '200': description: Response content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '500': *41 '401': *25 '403': *29 @@ -87937,9 +88621,9 @@ paths: application/json: schema: type: array - items: *184 + items: *187 examples: - default: &577 + default: &580 value: - id: 197 name: hello_docker @@ -88040,7 +88724,7 @@ paths: application/json: schema: type: array - items: &565 + items: &568 title: Email description: Email type: object @@ -88105,9 +88789,9 @@ paths: application/json: schema: type: array - items: *565 + items: *568 examples: - default: &579 + default: &582 value: - email: octocat@github.com verified: true @@ -88182,7 +88866,7 @@ paths: application/json: schema: type: array - items: *565 + items: *568 examples: default: value: @@ -88292,7 +88976,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 '304': *37 @@ -88325,7 +89009,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 '304': *37 @@ -88347,7 +89031,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: - - *123 + - *126 responses: '204': description: if the person is followed by the authenticated user @@ -88377,7 +89061,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *123 + - *126 responses: '204': description: Response @@ -88401,7 +89085,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *123 + - *126 responses: '204': description: Response @@ -88437,7 +89121,7 @@ paths: application/json: schema: type: array - items: &566 + items: &569 title: GPG Key description: A unique encryption key type: object @@ -88568,7 +89252,7 @@ paths: - subkeys - revoked examples: - default: &590 + default: &593 value: - id: 3 name: Octocat's GPG Key @@ -88653,9 +89337,9 @@ paths: description: Response content: application/json: - schema: *566 + schema: *569 examples: - default: &567 + default: &570 value: id: 3 name: Octocat's GPG Key @@ -88712,7 +89396,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &568 + - &571 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -88724,9 +89408,9 @@ paths: description: Response content: application/json: - schema: *566 + schema: *569 examples: - default: *567 + default: *570 '404': *7 '304': *37 '403': *29 @@ -88749,7 +89433,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *568 + - *571 responses: '204': description: Response @@ -88938,9 +89622,9 @@ paths: type: string repositories: type: array - items: *55 + items: *58 examples: - default: *569 + default: *572 headers: Link: *39 '404': *7 @@ -88965,7 +89649,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *101 + - *104 responses: '204': description: Response @@ -88991,7 +89675,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *101 + - *104 responses: '204': description: Response @@ -89025,12 +89709,12 @@ paths: application/json: schema: anyOf: - - *161 + - *164 - type: object properties: {} additionalProperties: false examples: - default: *162 + default: *165 '204': description: Response when there are no restrictions x-github: @@ -89054,7 +89738,7 @@ paths: required: true content: application/json: - schema: *430 + schema: *433 examples: default: value: @@ -89065,7 +89749,7 @@ paths: description: Response content: application/json: - schema: *161 + schema: *164 examples: default: value: @@ -89146,7 +89830,7 @@ paths: - closed - all default: open - - *167 + - *170 - name: sort description: What to sort results by. in: query @@ -89159,7 +89843,7 @@ paths: - comments default: created - *42 - - *62 + - *65 - *18 - *20 responses: @@ -89169,9 +89853,9 @@ paths: application/json: schema: type: array - items: *72 + items: *75 examples: - default: *168 + default: *171 headers: Link: *39 '404': *7 @@ -89204,7 +89888,7 @@ paths: application/json: schema: type: array - items: &570 + items: &573 title: Key description: Key type: object @@ -89301,9 +89985,9 @@ paths: description: Response content: application/json: - schema: *570 + schema: *573 examples: - default: &571 + default: &574 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -89336,15 +90020,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *458 + - *461 responses: '200': description: Response content: application/json: - schema: *570 + schema: *573 examples: - default: *571 + default: *574 '404': *7 '304': *37 '403': *29 @@ -89367,7 +90051,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *458 + - *461 responses: '204': description: Response @@ -89400,7 +90084,7 @@ paths: application/json: schema: type: array - items: &572 + items: &575 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -89457,7 +90141,7 @@ paths: - id - type - login - plan: *76 + plan: *79 required: - billing_cycle - next_billing_date @@ -89468,7 +90152,7 @@ paths: - account - plan examples: - default: &573 + default: &576 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -89530,9 +90214,9 @@ paths: application/json: schema: type: array - items: *572 + items: *575 examples: - default: *573 + default: *576 headers: Link: *39 '304': *37 @@ -89572,7 +90256,7 @@ paths: application/json: schema: type: array - items: *174 + items: *177 examples: default: value: @@ -89674,13 +90358,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: *174 + schema: *177 examples: default: value: @@ -89738,7 +90422,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *91 + - *94 requestBody: required: true content: @@ -89763,7 +90447,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *177 examples: default: value: @@ -89831,7 +90515,7 @@ paths: application/json: schema: type: array - items: *176 + items: *179 examples: default: value: @@ -90084,7 +90768,7 @@ paths: description: Response content: application/json: - schema: *176 + schema: *179 examples: default: value: @@ -90264,7 +90948,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *177 + - *180 - name: exclude in: query required: false @@ -90277,7 +90961,7 @@ paths: description: Response content: application/json: - schema: *176 + schema: *179 examples: default: value: @@ -90471,7 +91155,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *177 + - *180 responses: '302': description: Response @@ -90497,7 +91181,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *177 + - *180 responses: '204': description: Response @@ -90526,8 +91210,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *177 - - *574 + - *180 + - *577 responses: '204': description: Response @@ -90551,7 +91235,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *177 + - *180 - *18 - *20 responses: @@ -90561,9 +91245,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 '404': *7 @@ -90598,9 +91282,9 @@ paths: application/json: schema: type: array - items: *173 + items: *176 examples: - default: *575 + default: *578 headers: Link: *39 '304': *37 @@ -90642,7 +91326,7 @@ paths: - docker - nuget - container - - *576 + - *579 - *20 - *18 responses: @@ -90652,10 +91336,10 @@ paths: application/json: schema: type: array - items: *184 + items: *187 examples: - default: *577 - '400': *578 + default: *580 + '400': *581 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -90675,16 +91359,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *186 - - *187 + - *189 + - *190 responses: '200': description: Response content: application/json: - schema: *184 + schema: *187 examples: - default: &591 + default: &594 value: id: 40201 name: octo-name @@ -90797,8 +91481,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *186 - - *187 + - *189 + - *190 responses: '204': description: Response @@ -90828,8 +91512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *186 - - *187 + - *189 + - *190 - name: token description: package token schema: @@ -90861,8 +91545,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: - - *186 - - *187 + - *189 + - *190 - *20 - *18 - name: state @@ -90882,7 +91566,7 @@ paths: application/json: schema: type: array - items: *188 + items: *191 examples: default: value: @@ -90931,15 +91615,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *186 - - *187 - *189 + - *190 + - *192 responses: '200': description: Response content: application/json: - schema: *188 + schema: *191 examples: default: value: @@ -90975,9 +91659,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *186 - - *187 - *189 + - *190 + - *192 responses: '204': description: Response @@ -91007,9 +91691,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *186 - - *187 - *189 + - *190 + - *192 responses: '204': description: Response @@ -91065,7 +91749,7 @@ paths: description: Response content: application/json: - schema: *197 + schema: *200 examples: default: value: @@ -91134,9 +91818,9 @@ paths: application/json: schema: type: array - items: *565 + items: *568 examples: - default: *579 + default: *582 headers: Link: *39 '304': *37 @@ -91247,9 +91931,9 @@ paths: application/json: schema: type: array - items: *55 + items: *58 examples: - default: &586 + default: &589 summary: Default response value: - id: 1296269 @@ -91551,9 +92235,9 @@ paths: description: Response content: application/json: - schema: *250 + schema: *253 examples: - default: *252 + default: *255 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -91591,9 +92275,9 @@ paths: application/json: schema: type: array - items: *432 + items: *435 examples: - default: *580 + default: *583 headers: Link: *39 '304': *37 @@ -91616,12 +92300,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *165 + - *168 responses: '204': description: Response '403': *29 - '409': *131 + '409': *134 '404': *7 '304': *37 x-github: @@ -91639,11 +92323,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *165 + - *168 responses: '204': description: Response - '409': *131 + '409': *134 '304': *37 '404': *7 '403': *29 @@ -91672,7 +92356,7 @@ paths: application/json: schema: type: array - items: &581 + items: &584 title: Social account description: Social media account type: object @@ -91687,7 +92371,7 @@ paths: - provider - url examples: - default: &582 + default: &585 value: - provider: twitter url: https://twitter.com/github @@ -91749,9 +92433,9 @@ paths: application/json: schema: type: array - items: *581 + items: *584 examples: - default: *582 + default: *585 '422': *16 '304': *37 '404': *7 @@ -91838,7 +92522,7 @@ paths: application/json: schema: type: array - items: &583 + items: &586 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -91858,7 +92542,7 @@ paths: - title - created_at examples: - default: &598 + default: &601 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -91924,9 +92608,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *586 examples: - default: &584 + default: &587 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -91957,7 +92641,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: - - &585 + - &588 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -91969,9 +92653,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *586 examples: - default: *584 + default: *587 '404': *7 '304': *37 '403': *29 @@ -91994,7 +92678,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: - - *585 + - *588 responses: '204': description: Response @@ -92023,7 +92707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &599 + - &602 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 @@ -92046,13 +92730,13 @@ paths: application/json: schema: type: array - items: *55 + items: *58 examples: - default-response: *586 + default-response: *589 application/vnd.github.v3.star+json: schema: type: array - items: &600 + items: &603 title: Starred Repository description: Starred Repository type: object @@ -92060,7 +92744,7 @@ paths: starred_at: type: string format: date-time - repo: *55 + repo: *58 required: - starred_at - repo @@ -92208,8 +92892,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: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response if this repository is starred by you @@ -92237,8 +92921,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -92262,8 +92946,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -92296,9 +92980,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 '304': *37 @@ -92335,7 +93019,7 @@ paths: application/json: schema: type: array - items: *224 + items: *227 examples: default: value: @@ -92411,7 +93095,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *78 + - *81 responses: '200': description: Response @@ -92419,10 +93103,10 @@ paths: application/json: schema: oneOf: - - *558 - - *557 + - *561 + - *560 examples: - default-response: &588 + default-response: &591 summary: Default response value: login: octocat @@ -92457,7 +93141,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &589 + response-with-git-hub-plan-information: &592 summary: Response with GitHub plan information value: login: octocat @@ -92517,7 +93201,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *587 + - *590 - *18 responses: '200': @@ -92528,7 +93212,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: example: ; rel="next" @@ -92556,7 +93240,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *123 + - *126 responses: '200': description: Response @@ -92564,11 +93248,11 @@ paths: application/json: schema: oneOf: - - *558 - - *557 + - *561 + - *560 examples: - default-response: *588 - response-with-git-hub-plan-information: *589 + default-response: *591 + response-with-git-hub-plan-information: *592 '404': *7 x-github: githubCloudOnly: false @@ -92594,7 +93278,7 @@ paths: - *18 - *43 - *44 - - *123 + - *126 - name: subject_digest description: Subject Digest in: path @@ -92694,7 +93378,7 @@ paths: description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -92720,7 +93404,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: - - *123 + - *126 responses: '200': description: Response @@ -92728,9 +93412,9 @@ paths: application/json: schema: type: array - items: *184 + items: *187 examples: - default: *577 + default: *580 '403': *29 '401': *25 x-github: @@ -92753,7 +93437,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -92763,7 +93447,7 @@ paths: application/json: schema: type: array - items: *84 + items: *87 examples: default: value: @@ -92834,8 +93518,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *123 - - *91 + - *126 + - *94 - *18 - *20 responses: @@ -92845,7 +93529,7 @@ paths: application/json: schema: type: array - items: *84 + items: *87 examples: default: value: @@ -92924,7 +93608,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -92934,7 +93618,7 @@ paths: application/json: schema: type: array - items: *84 + items: *87 examples: default: value: @@ -93001,7 +93685,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -93013,7 +93697,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 x-github: @@ -93032,7 +93716,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *123 + - *126 - *18 - *20 responses: @@ -93044,7 +93728,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 x-github: @@ -93063,7 +93747,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *123 + - *126 - name: target_user in: path required: true @@ -93090,8 +93774,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *123 - - *62 + - *126 + - *65 - *18 - *20 responses: @@ -93101,9 +93785,9 @@ paths: application/json: schema: type: array - items: *63 + items: *66 examples: - default: *64 + default: *67 headers: Link: *39 '422': *16 @@ -93124,7 +93808,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -93134,9 +93818,9 @@ paths: application/json: schema: type: array - items: *566 + items: *569 examples: - default: *590 + default: *593 headers: Link: *39 x-github: @@ -93160,7 +93844,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *123 + - *126 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -93232,7 +93916,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *123 + - *126 responses: '200': description: Response @@ -93240,7 +93924,7 @@ paths: application/json: schema: *22 examples: - default: *429 + default: *432 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -93258,7 +93942,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -93306,7 +93990,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -93316,9 +94000,9 @@ paths: application/json: schema: type: array - items: *173 + items: *176 examples: - default: *575 + default: *578 headers: Link: *39 x-github: @@ -93357,8 +94041,8 @@ paths: - docker - nuget - container - - *576 - - *123 + - *579 + - *126 - *20 - *18 responses: @@ -93368,12 +94052,12 @@ paths: application/json: schema: type: array - items: *184 + items: *187 examples: - default: *577 + default: *580 '403': *29 '401': *25 - '400': *578 + '400': *581 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -93393,17 +94077,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *186 - - *187 - - *123 + - *189 + - *190 + - *126 responses: '200': description: Response content: application/json: - schema: *184 + schema: *187 examples: - default: *591 + default: *594 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -93424,9 +94108,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *186 - - *187 - - *123 + - *189 + - *190 + - *126 responses: '204': description: Response @@ -93458,9 +94142,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *186 - - *187 - - *123 + - *189 + - *190 + - *126 - name: token description: package token schema: @@ -93492,9 +94176,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: - - *186 - - *187 - - *123 + - *189 + - *190 + - *126 responses: '200': description: Response @@ -93502,7 +94186,7 @@ paths: application/json: schema: type: array - items: *188 + items: *191 examples: default: value: @@ -93560,16 +94244,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *186 - - *187 - *189 - - *123 + - *190 + - *192 + - *126 responses: '200': description: Response content: application/json: - schema: *188 + schema: *191 examples: default: value: @@ -93604,10 +94288,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *186 - - *187 - - *123 - *189 + - *190 + - *126 + - *192 responses: '204': description: Response @@ -93639,10 +94323,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *186 - - *187 - - *123 - *189 + - *190 + - *126 + - *192 responses: '204': description: Response @@ -93665,7 +94349,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-user-projects parameters: - - *123 + - *126 - name: state description: Indicates the state of the projects to return. in: query @@ -93686,7 +94370,7 @@ paths: application/json: schema: type: array - items: *197 + items: *200 examples: default: value: @@ -93745,7 +94429,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -93755,7 +94439,7 @@ paths: application/json: schema: type: array - items: *84 + items: *87 examples: default: value: @@ -93834,7 +94518,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -93844,7 +94528,7 @@ paths: application/json: schema: type: array - items: *84 + items: *87 examples: default: value: @@ -93921,7 +94605,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *123 + - *126 - name: type description: Limit results to repositories of the specified type. in: query @@ -93964,9 +94648,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 x-github: @@ -93990,15 +94674,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *123 + - *126 responses: '200': description: Response content: application/json: - schema: *592 + schema: *595 examples: - default: *593 + default: *596 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -94020,15 +94704,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *123 + - *126 responses: '200': description: Response content: application/json: - schema: *594 + schema: *597 examples: - default: *595 + default: *598 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -94050,15 +94734,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *123 + - *126 responses: '200': description: Response content: application/json: - schema: *596 + schema: *599 examples: - default: *597 + default: *600 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -94076,7 +94760,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -94086,9 +94770,9 @@ paths: application/json: schema: type: array - items: *581 + items: *584 examples: - default: *582 + default: *585 headers: Link: *39 x-github: @@ -94108,7 +94792,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -94118,9 +94802,9 @@ paths: application/json: schema: type: array - items: *583 + items: *586 examples: - default: *598 + default: *601 headers: Link: *39 x-github: @@ -94144,8 +94828,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *123 - - *599 + - *126 + - *602 - *42 - *18 - *20 @@ -94157,11 +94841,11 @@ paths: schema: anyOf: - type: array - items: *600 + items: *603 - type: array - items: *55 + items: *58 examples: - default-response: *586 + default-response: *589 headers: Link: *39 x-github: @@ -94180,7 +94864,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -94190,9 +94874,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 x-github: @@ -94320,7 +95004,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &601 + enterprise: &604 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -94378,7 +95062,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &602 + installation: &605 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -94397,7 +95081,7 @@ x-webhooks: required: - id - node_id - organization: &603 + organization: &606 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -94457,13 +95141,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &604 + repository: &607 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &634 + properties: &637 id: description: Unique identifier of the repository example: 42 @@ -94483,8 +95167,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *73 - required: *74 + properties: *76 + required: *77 nullable: true organization: title: Simple User @@ -95146,7 +95830,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &635 + required: &638 - archive_url - assignees_url - blobs_url @@ -95297,10 +95981,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -95376,11 +96060,11 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - rule: &605 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + rule: &608 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) @@ -95603,11 +96287,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - rule: *605 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + rule: *608 sender: *19 required: - action @@ -95790,11 +96474,11 @@ x-webhooks: - everyone required: - from - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - rule: *605 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + rule: *608 sender: *19 required: - action @@ -95878,7 +96562,7 @@ x-webhooks: type: string enum: - completed - check_run: &607 + check_run: &610 title: CheckRun description: A check performed on the code of a given code change type: object @@ -95892,8 +96576,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 check_suite: description: A suite of checks performed on the code of a given code change @@ -95941,8 +96625,8 @@ x-webhooks: type: string pull_requests: type: array - items: *318 - repository: *110 + items: *321 + repository: *113 status: example: completed type: string @@ -95979,7 +96663,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *606 + deployment: *609 details_url: example: https://example.com type: string @@ -96029,7 +96713,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *318 + items: *321 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -96064,9 +96748,9 @@ x-webhooks: - output - app - pull_requests - installation: *602 - organization: *603 - repository: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - check_run @@ -96459,10 +97143,10 @@ x-webhooks: type: string enum: - created - check_run: *607 - installation: *602 - organization: *603 - repository: *604 + check_run: *610 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - check_run @@ -96858,10 +97542,10 @@ x-webhooks: type: string enum: - requested_action - check_run: *607 - installation: *602 - organization: *603 - repository: *604 + check_run: *610 + installation: *605 + organization: *606 + repository: *607 requested_action: description: The action requested by the user. type: object @@ -97266,10 +97950,10 @@ x-webhooks: type: string enum: - rerequested - check_run: *607 - installation: *602 - organization: *603 - repository: *604 + check_run: *610 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - check_run @@ -98246,10 +98930,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -98919,10 +99603,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -99586,10 +100270,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -99889,20 +100573,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &608 + commit_oid: &611 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: *601 - installation: *602 - organization: *603 - ref: &609 + enterprise: *604 + installation: *605 + organization: *606 + ref: &612 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: *604 + repository: *607 sender: *19 required: - action @@ -100220,12 +100904,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *608 - enterprise: *601 - installation: *602 - organization: *603 - ref: *609 - repository: *604 + commit_oid: *611 + enterprise: *604 + installation: *605 + organization: *606 + ref: *612 + repository: *607 sender: *19 required: - action @@ -100320,7 +101004,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *334 + dismissed_comment: *337 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -100482,12 +101166,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *608 - enterprise: *601 - installation: *602 - organization: *603 - ref: *609 - repository: *604 + commit_oid: *611 + enterprise: *604 + installation: *605 + organization: *606 + ref: *612 + repository: *607 sender: *19 required: - action @@ -100808,12 +101492,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *608 - enterprise: *601 - installation: *602 - organization: *603 - ref: *609 - repository: *604 + commit_oid: *611 + enterprise: *604 + installation: *605 + organization: *606 + ref: *612 + repository: *607 sender: *19 required: - action @@ -101070,16 +101754,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *604 + repository: *607 sender: *19 required: - action @@ -101305,12 +101989,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *608 - enterprise: *601 - installation: *602 - organization: *603 - ref: *609 - repository: *604 + commit_oid: *611 + enterprise: *604 + installation: *605 + organization: *606 + ref: *612 + repository: *607 sender: *19 required: - action @@ -101567,10 +102251,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -101650,18 +102334,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *603 - pusher_type: &610 + organization: *606 + pusher_type: &613 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &611 + ref: &614 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -101671,7 +102355,7 @@ x-webhooks: enum: - tag - branch - repository: *604 + repository: *607 sender: *19 required: - ref @@ -101753,10 +102437,10 @@ x-webhooks: type: string enum: - created - definition: *198 - enterprise: *601 - installation: *602 - organization: *603 + definition: *201 + enterprise: *604 + installation: *605 + organization: *606 sender: *19 required: - action @@ -101840,9 +102524,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 sender: *19 required: - action @@ -101918,10 +102602,10 @@ x-webhooks: type: string enum: - updated - definition: *198 - enterprise: *601 - installation: *602 - organization: *603 + definition: *201 + enterprise: *604 + installation: *605 + organization: *606 sender: *19 required: - action @@ -101997,19 +102681,19 @@ x-webhooks: type: string enum: - updated - enterprise: *601 - installation: *602 - repository: *604 - organization: *603 + enterprise: *604 + installation: *605 + repository: *607 + organization: *606 sender: *19 new_property_values: type: array description: The new custom property values for the repository. - items: *202 + items: *205 old_property_values: type: array description: The old custom property values for the repository. - items: *202 + items: *205 required: - action - repository @@ -102085,18 +102769,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *601 - installation: *602 - organization: *603 - pusher_type: *610 - ref: *611 + enterprise: *604 + installation: *605 + organization: *606 + pusher_type: *613 + ref: *614 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *604 + repository: *607 sender: *19 required: - ref @@ -102180,11 +102864,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *388 - installation: *602 - organization: *603 - enterprise: *601 - repository: *604 + alert: *391 + installation: *605 + organization: *606 + enterprise: *604 + repository: *607 sender: *19 required: - action @@ -102268,11 +102952,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *388 - installation: *602 - organization: *603 - enterprise: *601 - repository: *604 + alert: *391 + installation: *605 + organization: *606 + enterprise: *604 + repository: *607 sender: *19 required: - action @@ -102356,11 +103040,11 @@ x-webhooks: type: string enum: - created - alert: *388 - installation: *602 - organization: *603 - enterprise: *601 - repository: *604 + alert: *391 + installation: *605 + organization: *606 + enterprise: *604 + repository: *607 sender: *19 required: - action @@ -102442,11 +103126,11 @@ x-webhooks: type: string enum: - dismissed - alert: *388 - installation: *602 - organization: *603 - enterprise: *601 - repository: *604 + alert: *391 + installation: *605 + organization: *606 + enterprise: *604 + repository: *607 sender: *19 required: - action @@ -102528,11 +103212,11 @@ x-webhooks: type: string enum: - fixed - alert: *388 - installation: *602 - organization: *603 - enterprise: *601 - repository: *604 + alert: *391 + installation: *605 + organization: *606 + enterprise: *604 + repository: *607 sender: *19 required: - action @@ -102615,11 +103299,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *388 - installation: *602 - organization: *603 - enterprise: *601 - repository: *604 + alert: *391 + installation: *605 + organization: *606 + enterprise: *604 + repository: *607 sender: *19 required: - action @@ -102701,11 +103385,11 @@ x-webhooks: type: string enum: - reopened - alert: *388 - installation: *602 - organization: *603 - enterprise: *601 - repository: *604 + alert: *391 + installation: *605 + organization: *606 + enterprise: *604 + repository: *607 sender: *19 required: - action @@ -102782,9 +103466,9 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - key: &612 + enterprise: *604 + installation: *605 + key: &615 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -102818,8 +103502,8 @@ x-webhooks: - verified - created_at - read_only - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -102896,11 +103580,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - key: *612 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + key: *615 + organization: *606 + repository: *607 sender: *19 required: - action @@ -103461,12 +104145,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - workflow: &616 + workflow: &619 title: Workflow type: object nullable: true @@ -104192,13 +104876,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *394 + deployment: *397 pull_requests: type: array - items: *479 - repository: *604 - organization: *603 - installation: *602 + items: *482 + repository: *607 + organization: *606 + installation: *605 sender: *19 responses: '200': @@ -104269,7 +104953,7 @@ x-webhooks: type: string enum: - approved - approver: &613 + approver: &616 type: object properties: avatar_url: @@ -104312,11 +104996,11 @@ x-webhooks: type: string comment: type: string - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - reviewers: &614 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + reviewers: &617 type: array items: type: object @@ -104395,7 +105079,7 @@ x-webhooks: sender: *19 since: type: string - workflow_job_run: &615 + workflow_job_run: &618 type: object properties: conclusion: @@ -105126,18 +105810,18 @@ x-webhooks: type: string enum: - rejected - approver: *613 + approver: *616 comment: type: string - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - reviewers: *614 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + reviewers: *617 sender: *19 since: type: string - workflow_job_run: *615 + workflow_job_run: *618 workflow_job_runs: type: array items: @@ -105841,13 +106525,13 @@ x-webhooks: type: string enum: - requested - enterprise: *601 + enterprise: *604 environment: type: string - installation: *602 - organization: *603 - repository: *604 - requestor: &621 + installation: *605 + organization: *606 + repository: *607 + requestor: &624 title: User type: object nullable: true @@ -107746,12 +108430,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - workflow: *616 + workflow: *619 workflow_run: title: Deployment Workflow Run type: object @@ -108431,7 +109115,7 @@ x-webhooks: type: string enum: - answered - answer: &619 + answer: &622 type: object properties: author_association: @@ -108588,7 +109272,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &617 + discussion: &620 title: Discussion description: A Discussion in a repository. type: object @@ -108874,7 +109558,7 @@ x-webhooks: - id labels: type: array - items: *441 + items: *444 required: - repository_url - category @@ -108896,10 +109580,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109026,11 +109710,11 @@ x-webhooks: - from required: - category - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109113,11 +109797,11 @@ x-webhooks: type: string enum: - closed - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109199,7 +109883,7 @@ x-webhooks: type: string enum: - created - comment: &618 + comment: &621 type: object properties: author_association: @@ -109356,11 +110040,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109443,12 +110127,12 @@ x-webhooks: type: string enum: - deleted - comment: *618 - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + comment: *621 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109543,12 +110227,12 @@ x-webhooks: - from required: - body - comment: *618 - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + comment: *621 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109632,11 +110316,11 @@ x-webhooks: type: string enum: - created - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109718,11 +110402,11 @@ x-webhooks: type: string enum: - deleted - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109822,11 +110506,11 @@ x-webhooks: type: string required: - from - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109908,10 +110592,10 @@ x-webhooks: type: string enum: - labeled - discussion: *617 - enterprise: *601 - installation: *602 - label: &620 + discussion: *620 + enterprise: *604 + installation: *605 + label: &623 title: Label type: object properties: @@ -109943,8 +110627,8 @@ x-webhooks: - color - default - description - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110027,11 +110711,11 @@ x-webhooks: type: string enum: - locked - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110113,11 +110797,11 @@ x-webhooks: type: string enum: - pinned - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110199,11 +110883,11 @@ x-webhooks: type: string enum: - reopened - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110288,16 +110972,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *617 - new_repository: *604 + new_discussion: *620 + new_repository: *607 required: - new_discussion - new_repository - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110380,10 +111064,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *617 - old_answer: *619 - organization: *603 - repository: *604 + discussion: *620 + old_answer: *622 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110465,12 +111149,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *617 - enterprise: *601 - installation: *602 - label: *620 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + label: *623 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110553,11 +111237,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110639,11 +111323,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110716,7 +111400,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *601 + enterprise: *604 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -111376,9 +112060,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *602 - organization: *603 - repository: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - forkee @@ -111524,9 +112208,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 pages: description: The pages that were updated. type: array @@ -111563,7 +112247,7 @@ x-webhooks: - action - sha - html_url - repository: *604 + repository: *607 sender: *19 required: - pages @@ -111639,10 +112323,10 @@ x-webhooks: type: string enum: - created - enterprise: *601 + enterprise: *604 installation: *22 - organization: *603 - repositories: &622 + organization: *606 + repositories: &625 description: An array of repository objects that the installation can access. type: array @@ -111668,8 +112352,8 @@ x-webhooks: - name - full_name - private - repository: *604 - requester: *621 + repository: *607 + requester: *624 sender: *19 required: - action @@ -111744,11 +112428,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 + enterprise: *604 installation: *22 - organization: *603 - repositories: *622 - repository: *604 + organization: *606 + repositories: *625 + repository: *607 requester: nullable: true sender: *19 @@ -111824,11 +112508,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *601 + enterprise: *604 installation: *22 - organization: *603 - repositories: *622 - repository: *604 + organization: *606 + repositories: *625 + repository: *607 requester: nullable: true sender: *19 @@ -111904,10 +112588,10 @@ x-webhooks: type: string enum: - added - enterprise: *601 + enterprise: *604 installation: *22 - organization: *603 - repositories_added: &623 + organization: *606 + repositories_added: &626 description: An array of repository objects, which were added to the installation. type: array @@ -111953,15 +112637,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *604 - repository_selection: &624 + repository: *607 + repository_selection: &627 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *621 + requester: *624 sender: *19 required: - action @@ -112040,10 +112724,10 @@ x-webhooks: type: string enum: - removed - enterprise: *601 + enterprise: *604 installation: *22 - organization: *603 - repositories_added: *623 + organization: *606 + repositories_added: *626 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -112070,9 +112754,9 @@ x-webhooks: - name - full_name - private - repository: *604 - repository_selection: *624 - requester: *621 + repository: *607 + repository_selection: *627 + requester: *624 sender: *19 required: - action @@ -112151,11 +112835,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *601 + enterprise: *604 installation: *22 - organization: *603 - repositories: *622 - repository: *604 + organization: *606 + repositories: *625 + repository: *607 requester: nullable: true sender: *19 @@ -112333,10 +113017,10 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 target_type: type: string @@ -112415,11 +113099,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *601 + enterprise: *604 installation: *22 - organization: *603 - repositories: *622 - repository: *604 + organization: *606 + repositories: *625 + repository: *607 requester: nullable: true sender: *19 @@ -112543,8 +113227,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 reactions: title: Reactions type: object @@ -112671,8 +113355,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -113813,8 +114497,8 @@ x-webhooks: - state - locked - assignee - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -113894,7 +114578,7 @@ x-webhooks: type: string enum: - deleted - comment: &625 + comment: &628 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -114059,8 +114743,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -115199,8 +115883,8 @@ x-webhooks: - state - locked - assignee - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -115280,7 +115964,7 @@ x-webhooks: type: string enum: - edited - changes: &653 + changes: &656 description: The changes to the comment. type: object properties: @@ -115292,9 +115976,9 @@ x-webhooks: type: string required: - from - comment: *625 - enterprise: *601 - installation: *602 + comment: *628 + enterprise: *604 + installation: *605 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -116434,8 +117118,8 @@ x-webhooks: - state - locked - assignee - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -116517,10 +117201,10 @@ x-webhooks: type: string enum: - assigned - assignee: *621 - enterprise: *601 - installation: *602 - issue: &628 + assignee: *624 + enterprise: *604 + installation: *605 + issue: &631 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -117424,8 +118108,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -117505,8 +118189,8 @@ x-webhooks: type: string enum: - closed - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -118550,8 +119234,8 @@ x-webhooks: required: - state - closed_at - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -118630,8 +119314,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -119528,8 +120212,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -119608,8 +120292,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -120509,7 +121193,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &626 + milestone: &629 title: Milestone description: A collection of related issues and pull requests. type: object @@ -120647,8 +121331,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -120747,8 +121431,8 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -121652,9 +122336,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *620 - organization: *603 - repository: *604 + label: *623 + organization: *606 + repository: *607 sender: *19 required: - action @@ -121734,8 +122418,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -122638,9 +123322,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *620 - organization: *603 - repository: *604 + label: *623 + organization: *606 + repository: *607 sender: *19 required: - action @@ -122720,8 +123404,8 @@ x-webhooks: type: string enum: - locked - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -123625,8 +124309,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -123705,8 +124389,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -124604,9 +125288,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *626 - organization: *603 - repository: *604 + milestone: *629 + organization: *606 + repository: *607 sender: *19 required: - action @@ -126053,8 +126737,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -126957,8 +127641,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -127038,9 +127722,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *601 - installation: *602 - issue: &627 + enterprise: *604 + installation: *605 + issue: &630 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -127937,8 +128621,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -128017,8 +128701,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -128921,8 +129605,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -130370,11 +131054,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *601 - installation: *602 - issue: *627 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + issue: *630 + organization: *606 + repository: *607 sender: *19 required: - action @@ -130455,7 +131139,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &656 + assignee: &659 title: User type: object nullable: true @@ -130525,11 +131209,11 @@ x-webhooks: required: - login - id - enterprise: *601 - installation: *602 - issue: *628 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + issue: *631 + organization: *606 + repository: *607 sender: *19 required: - action @@ -130608,12 +131292,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *601 - installation: *602 - issue: *628 - label: *620 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + issue: *631 + label: *623 + organization: *606 + repository: *607 sender: *19 required: - action @@ -130693,8 +131377,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -131596,8 +132280,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -131677,11 +132361,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *601 - installation: *602 - issue: *627 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + issue: *630 + organization: *606 + repository: *607 sender: *19 required: - action @@ -131760,11 +132444,11 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - label: *620 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + label: *623 + organization: *606 + repository: *607 sender: *19 required: - action @@ -131842,11 +132526,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - label: *620 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + label: *623 + organization: *606 + repository: *607 sender: *19 required: - action @@ -131956,11 +132640,11 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 - label: *620 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + label: *623 + organization: *606 + repository: *607 sender: *19 required: - action @@ -132042,9 +132726,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *601 - installation: *602 - marketplace_purchase: &629 + enterprise: *604 + installation: *605 + marketplace_purchase: &632 title: Marketplace Purchase type: object required: @@ -132127,8 +132811,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *603 - previous_marketplace_purchase: &630 + organization: *606 + previous_marketplace_purchase: &633 title: Marketplace Purchase type: object properties: @@ -132208,7 +132892,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *604 + repository: *607 sender: *19 required: - action @@ -132288,10 +132972,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *601 - installation: *602 - marketplace_purchase: *629 - organization: *603 + enterprise: *604 + installation: *605 + marketplace_purchase: *632 + organization: *606 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -132374,7 +133058,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *604 + repository: *607 sender: *19 required: - action @@ -132456,10 +133140,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *601 - installation: *602 - marketplace_purchase: *629 - organization: *603 + enterprise: *604 + installation: *605 + marketplace_purchase: *632 + organization: *606 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -132541,7 +133225,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *604 + repository: *607 sender: *19 required: - action @@ -132622,8 +133306,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 marketplace_purchase: title: Marketplace Purchase type: object @@ -132705,9 +133389,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *603 - previous_marketplace_purchase: *630 - repository: *604 + organization: *606 + previous_marketplace_purchase: *633 + repository: *607 sender: *19 required: - action @@ -132787,12 +133471,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *601 - installation: *602 - marketplace_purchase: *629 - organization: *603 - previous_marketplace_purchase: *630 - repository: *604 + enterprise: *604 + installation: *605 + marketplace_purchase: *632 + organization: *606 + previous_marketplace_purchase: *633 + repository: *607 sender: *19 required: - action @@ -132894,11 +133578,11 @@ x-webhooks: type: string required: - to - enterprise: *601 - installation: *602 - member: *621 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + member: *624 + organization: *606 + repository: *607 sender: *19 required: - action @@ -132998,11 +133682,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *601 - installation: *602 - member: *621 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + member: *624 + organization: *606 + repository: *607 sender: *19 required: - action @@ -133081,11 +133765,11 @@ x-webhooks: type: string enum: - removed - enterprise: *601 - installation: *602 - member: *621 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + member: *624 + organization: *606 + repository: *607 sender: *19 required: - action @@ -133163,11 +133847,11 @@ x-webhooks: type: string enum: - added - enterprise: *601 - installation: *602 - member: *621 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + member: *624 + organization: *606 + repository: *607 scope: description: The scope of the membership. Currently, can only be `team`. @@ -133243,7 +133927,7 @@ x-webhooks: required: - login - id - team: &631 + team: &634 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -133433,11 +134117,11 @@ x-webhooks: type: string enum: - removed - enterprise: *601 - installation: *602 - member: *621 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + member: *624 + organization: *606 + repository: *607 scope: description: The scope of the membership. Currently, can only be `team`. @@ -133514,7 +134198,7 @@ x-webhooks: required: - login - id - team: *631 + team: *634 required: - action - scope @@ -133596,8 +134280,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *602 - merge_group: &633 + installation: *605 + merge_group: &636 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -133616,15 +134300,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *632 + head_commit: *635 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -133710,10 +134394,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *602 - merge_group: *633 - organization: *603 - repository: *604 + installation: *605 + merge_group: *636 + organization: *606 + repository: *607 sender: *19 required: - action @@ -133786,7 +134470,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 + enterprise: *604 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -133894,16 +134578,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *602 - organization: *603 + installation: *605 + organization: *606 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *634 - required: *635 + properties: *637 + required: *638 nullable: true sender: *19 required: @@ -133984,11 +134668,11 @@ x-webhooks: type: string enum: - closed - enterprise: *601 - installation: *602 - milestone: *626 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + milestone: *629 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134067,9 +134751,9 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - milestone: &636 + enterprise: *604 + installation: *605 + milestone: &639 title: Milestone description: A collection of related issues and pull requests. type: object @@ -134206,8 +134890,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134286,11 +134970,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - milestone: *626 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + milestone: *629 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134400,11 +135084,11 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 - milestone: *626 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + milestone: *629 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134484,11 +135168,11 @@ x-webhooks: type: string enum: - opened - enterprise: *601 - installation: *602 - milestone: *636 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + milestone: *639 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134567,11 +135251,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *621 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + blocked_user: *624 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134650,11 +135334,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *621 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + blocked_user: *624 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134733,9 +135417,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - membership: &637 + enterprise: *604 + installation: *605 + membership: &640 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -134827,8 +135511,8 @@ x-webhooks: - role - organization_url - user - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134906,11 +135590,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *601 - installation: *602 - membership: *637 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + membership: *640 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134989,8 +135673,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -135106,10 +135790,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 - user: *621 + user: *624 required: - action - invitation @@ -135187,11 +135871,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *601 - installation: *602 - membership: *637 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + membership: *640 + organization: *606 + repository: *607 sender: *19 required: - action @@ -135278,11 +135962,11 @@ x-webhooks: properties: from: type: string - enterprise: *601 - installation: *602 - membership: *637 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + membership: *640 + organization: *606 + repository: *607 sender: *19 required: - action @@ -135358,9 +136042,9 @@ x-webhooks: type: string enum: - published - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 package: description: Information about the package. type: object @@ -135859,7 +136543,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &638 + items: &641 title: Ruby Gems metadata type: object properties: @@ -135954,7 +136638,7 @@ x-webhooks: - owner - package_version - registry - repository: *604 + repository: *607 sender: *19 required: - action @@ -136030,9 +136714,9 @@ x-webhooks: type: string enum: - updated - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 package: description: Information about the package. type: object @@ -136385,7 +137069,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *638 + items: *641 source_url: type: string format: uri @@ -136455,7 +137139,7 @@ x-webhooks: - owner - package_version - registry - repository: *604 + repository: *607 sender: *19 required: - action @@ -136632,12 +137316,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *601 + enterprise: *604 id: type: integer - installation: *602 - organization: *603 - repository: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - id @@ -136717,7 +137401,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &639 + personal_access_token_request: &642 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -136851,10 +137535,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *601 - organization: *603 + enterprise: *604 + organization: *606 sender: *19 - installation: *602 + installation: *605 required: - action - personal_access_token_request @@ -136933,11 +137617,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *639 - enterprise: *601 - organization: *603 + personal_access_token_request: *642 + enterprise: *604 + organization: *606 sender: *19 - installation: *602 + installation: *605 required: - action - personal_access_token_request @@ -137015,11 +137699,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *639 - enterprise: *601 - organization: *603 + personal_access_token_request: *642 + enterprise: *604 + organization: *606 sender: *19 - installation: *602 + installation: *605 required: - action - personal_access_token_request @@ -137096,11 +137780,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *639 - organization: *603 - enterprise: *601 + personal_access_token_request: *642 + organization: *606 + enterprise: *604 sender: *19 - installation: *602 + installation: *605 required: - action - personal_access_token_request @@ -137204,7 +137888,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *640 + last_response: *643 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -137236,8 +137920,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 zen: description: Random string of GitHub zen. @@ -137482,10 +138166,10 @@ x-webhooks: - from required: - note - enterprise: *601 - installation: *602 - organization: *603 - project_card: &641 + enterprise: *604 + installation: *605 + organization: *606 + project_card: &644 title: Project Card type: object properties: @@ -137604,7 +138288,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *604 + repository: *607 sender: *19 required: - action @@ -137685,11 +138369,11 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - project_card: *641 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + project_card: *644 + repository: *607 sender: *19 required: - action @@ -137769,9 +138453,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 project_card: title: Project Card type: object @@ -137899,8 +138583,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *634 - required: *635 + properties: *637 + required: *638 nullable: true sender: *19 required: @@ -137994,11 +138678,11 @@ x-webhooks: - from required: - note - enterprise: *601 - installation: *602 - organization: *603 - project_card: *641 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + project_card: *644 + repository: *607 sender: *19 required: - action @@ -138092,9 +138776,9 @@ x-webhooks: - from required: - column_id - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 project_card: allOf: - title: Project Card @@ -138284,7 +138968,7 @@ x-webhooks: type: string required: - after_id - repository: *604 + repository: *607 sender: *19 required: - action @@ -138364,10 +139048,10 @@ x-webhooks: type: string enum: - closed - enterprise: *601 - installation: *602 - organization: *603 - project: &643 + enterprise: *604 + installation: *605 + organization: *606 + project: &646 title: Project type: object properties: @@ -138491,7 +139175,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *604 + repository: *607 sender: *19 required: - action @@ -138571,10 +139255,10 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - project_column: &642 + enterprise: *604 + installation: *605 + organization: *606 + project_column: &645 title: Project Column type: object properties: @@ -138613,7 +139297,7 @@ x-webhooks: - name - created_at - updated_at - repository: *604 + repository: *607 sender: *19 required: - action @@ -138692,18 +139376,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 - project_column: *642 + enterprise: *604 + installation: *605 + organization: *606 + project_column: *645 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *634 - required: *635 + properties: *637 + required: *638 nullable: true sender: *19 required: @@ -138793,11 +139477,11 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 - organization: *603 - project_column: *642 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + project_column: *645 + repository: *607 sender: *19 required: - action @@ -138877,11 +139561,11 @@ x-webhooks: type: string enum: - moved - enterprise: *601 - installation: *602 - organization: *603 - project_column: *642 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + project_column: *645 + repository: *607 sender: *19 required: - action @@ -138961,11 +139645,11 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - project: *643 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + project: *646 + repository: *607 sender: *19 required: - action @@ -139045,18 +139729,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 - project: *643 + enterprise: *604 + installation: *605 + organization: *606 + project: *646 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *634 - required: *635 + properties: *637 + required: *638 nullable: true sender: *19 required: @@ -139158,11 +139842,11 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 - organization: *603 - project: *643 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + project: *646 + repository: *607 sender: *19 required: - action @@ -139241,11 +139925,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *601 - installation: *602 - organization: *603 - project: *643 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + project: *646 + repository: *607 sender: *19 required: - action @@ -139326,9 +140010,9 @@ x-webhooks: type: string enum: - closed - installation: *602 - organization: *603 - projects_v2: &644 + installation: *605 + organization: *606 + projects_v2: &647 title: Projects v2 Project description: A projects v2 project type: object @@ -139471,9 +140155,9 @@ x-webhooks: type: string enum: - created - installation: *602 - organization: *603 - projects_v2: *644 + installation: *605 + organization: *606 + projects_v2: *647 sender: *19 required: - action @@ -139554,9 +140238,9 @@ x-webhooks: type: string enum: - deleted - installation: *602 - organization: *603 - projects_v2: *644 + installation: *605 + organization: *606 + projects_v2: *647 sender: *19 required: - action @@ -139673,9 +140357,9 @@ x-webhooks: type: string to: type: string - installation: *602 - organization: *603 - projects_v2: *644 + installation: *605 + organization: *606 + projects_v2: *647 sender: *19 required: - action @@ -139758,7 +140442,7 @@ x-webhooks: type: string enum: - archived - changes: &648 + changes: &651 type: object properties: archived_at: @@ -139772,9 +140456,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *602 - organization: *603 - projects_v2_item: &645 + installation: *605 + organization: *606 + projects_v2_item: &648 title: Projects v2 Item description: An item belonging to a project type: object @@ -139908,9 +140592,9 @@ x-webhooks: nullable: true to: type: string - installation: *602 - organization: *603 - projects_v2_item: *645 + installation: *605 + organization: *606 + projects_v2_item: *648 sender: *19 required: - action @@ -139992,9 +140676,9 @@ x-webhooks: type: string enum: - created - installation: *602 - organization: *603 - projects_v2_item: *645 + installation: *605 + organization: *606 + projects_v2_item: *648 sender: *19 required: - action @@ -140075,9 +140759,9 @@ x-webhooks: type: string enum: - deleted - installation: *602 - organization: *603 - projects_v2_item: *645 + installation: *605 + organization: *606 + projects_v2_item: *648 sender: *19 required: - action @@ -140183,7 +140867,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &646 + - &649 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -140201,7 +140885,7 @@ x-webhooks: required: - id - name - - &647 + - &650 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -140224,8 +140908,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *646 - - *647 + - *649 + - *650 required: - field_value - type: object @@ -140241,9 +140925,9 @@ x-webhooks: nullable: true required: - body - installation: *602 - organization: *603 - projects_v2_item: *645 + installation: *605 + organization: *606 + projects_v2_item: *648 sender: *19 required: - action @@ -140338,9 +141022,9 @@ x-webhooks: to: type: string nullable: true - installation: *602 - organization: *603 - projects_v2_item: *645 + installation: *605 + organization: *606 + projects_v2_item: *648 sender: *19 required: - action @@ -140423,10 +141107,10 @@ x-webhooks: type: string enum: - restored - changes: *648 - installation: *602 - organization: *603 - projects_v2_item: *645 + changes: *651 + installation: *605 + organization: *606 + projects_v2_item: *648 sender: *19 required: - action @@ -140508,9 +141192,9 @@ x-webhooks: type: string enum: - reopened - installation: *602 - organization: *603 - projects_v2: *644 + installation: *605 + organization: *606 + projects_v2: *647 sender: *19 required: - action @@ -140591,9 +141275,9 @@ x-webhooks: type: string enum: - created - installation: *602 - organization: *603 - projects_v2_status_update: &649 + installation: *605 + organization: *606 + projects_v2_status_update: &652 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -140720,9 +141404,9 @@ x-webhooks: type: string enum: - deleted - installation: *602 - organization: *603 - projects_v2_status_update: *649 + installation: *605 + organization: *606 + projects_v2_status_update: *652 sender: *19 required: - action @@ -140858,9 +141542,9 @@ x-webhooks: type: string format: date nullable: true - installation: *602 - organization: *603 - projects_v2_status_update: *649 + installation: *605 + organization: *606 + projects_v2_status_update: *652 sender: *19 required: - action @@ -140931,10 +141615,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - repository @@ -141011,13 +141695,13 @@ x-webhooks: type: string enum: - assigned - assignee: *621 - enterprise: *601 - installation: *602 - number: &650 + assignee: *624 + enterprise: *604 + installation: *605 + number: &653 description: The pull request number. type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -143300,7 +143984,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -143382,11 +144066,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 number: type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -145664,7 +146348,7 @@ x-webhooks: - draft reason: type: string - repository: *604 + repository: *607 sender: *19 required: - action @@ -145746,11 +146430,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 number: type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -148028,7 +148712,7 @@ x-webhooks: - draft reason: type: string - repository: *604 + repository: *607 sender: *19 required: - action @@ -148110,13 +148794,13 @@ x-webhooks: type: string enum: - closed - enterprise: *601 - installation: *602 - number: *650 - organization: *603 - pull_request: &651 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 + pull_request: &654 allOf: - - *479 + - *482 - type: object properties: allow_auto_merge: @@ -148178,7 +148862,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *604 + repository: *607 sender: *19 required: - action @@ -148259,12 +148943,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *601 - installation: *602 - number: *650 - organization: *603 - pull_request: *651 - repository: *604 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 + pull_request: *654 + repository: *607 sender: *19 required: - action @@ -148344,11 +149028,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *601 - milestone: *461 - number: *650 - organization: *603 - pull_request: &652 + enterprise: *604 + milestone: *464 + number: *653 + organization: *606 + pull_request: &655 title: Pull Request type: object properties: @@ -150611,7 +151295,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -150690,11 +151374,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 number: type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -152976,7 +153660,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *604 + repository: *607 sender: *19 required: - action @@ -153100,12 +153784,12 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 - number: *650 - organization: *603 - pull_request: *651 - repository: *604 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 + pull_request: *654 + repository: *607 sender: *19 required: - action @@ -153185,11 +153869,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 number: type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -155456,7 +156140,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -155536,11 +156220,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *601 - installation: *602 - label: *620 - number: *650 - organization: *603 + enterprise: *604 + installation: *605 + label: *623 + number: *653 + organization: *606 pull_request: title: Pull Request type: object @@ -157822,7 +158506,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -157903,10 +158587,10 @@ x-webhooks: type: string enum: - locked - enterprise: *601 - installation: *602 - number: *650 - organization: *603 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 pull_request: title: Pull Request type: object @@ -160186,7 +160870,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -160266,12 +160950,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *601 - milestone: *461 - number: *650 - organization: *603 - pull_request: *652 - repository: *604 + enterprise: *604 + milestone: *464 + number: *653 + organization: *606 + pull_request: *655 + repository: *607 sender: *19 required: - action @@ -160350,12 +161034,12 @@ x-webhooks: type: string enum: - opened - enterprise: *601 - installation: *602 - number: *650 - organization: *603 - pull_request: *651 - repository: *604 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 + pull_request: *654 + repository: *607 sender: *19 required: - action @@ -160436,12 +161120,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *601 - installation: *602 - number: *650 - organization: *603 - pull_request: *651 - repository: *604 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 + pull_request: *654 + repository: *607 sender: *19 required: - action @@ -160521,12 +161205,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *601 - installation: *602 - number: *650 - organization: *603 - pull_request: *651 - repository: *604 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 + pull_request: *654 + repository: *607 sender: *19 required: - action @@ -160892,9 +161576,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 pull_request: type: object properties: @@ -163064,7 +163748,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *604 + repository: *607 sender: *19 required: - action @@ -163144,7 +163828,7 @@ x-webhooks: type: string enum: - deleted - comment: &654 + comment: &657 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -163429,9 +164113,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 pull_request: type: object properties: @@ -165589,7 +166273,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *604 + repository: *607 sender: *19 required: - action @@ -165669,11 +166353,11 @@ x-webhooks: type: string enum: - edited - changes: *653 - comment: *654 - enterprise: *601 - installation: *602 - organization: *603 + changes: *656 + comment: *657 + enterprise: *604 + installation: *605 + organization: *606 pull_request: type: object properties: @@ -167834,7 +168518,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *604 + repository: *607 sender: *19 required: - action @@ -167915,9 +168599,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 pull_request: title: Simple Pull Request type: object @@ -170090,7 +170774,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *604 + repository: *607 review: description: The review that was affected. type: object @@ -170333,9 +171017,9 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 pull_request: title: Simple Pull Request type: object @@ -172389,8 +173073,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *604 - review: &655 + repository: *607 + review: &658 description: The review that was affected. type: object properties: @@ -172619,12 +173303,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 number: description: The pull request number. type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -174907,7 +175591,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 requested_reviewer: title: User type: object @@ -174991,12 +175675,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 number: description: The pull request number. type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -177286,7 +177970,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 requested_team: title: Team description: Groups of organization members that gives permissions @@ -177478,12 +178162,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 number: description: The pull request number. type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -179768,7 +180452,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 requested_reviewer: title: User type: object @@ -179853,12 +180537,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 number: description: The pull request number. type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -182134,7 +182818,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 requested_team: title: Team description: Groups of organization members that gives permissions @@ -182315,9 +182999,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 pull_request: title: Simple Pull Request type: object @@ -184492,8 +185176,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *604 - review: *655 + repository: *607 + review: *658 sender: *19 required: - action @@ -184573,9 +185257,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 pull_request: title: Simple Pull Request type: object @@ -186645,7 +187329,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *604 + repository: *607 sender: *19 thread: type: object @@ -187028,9 +187712,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 pull_request: title: Simple Pull Request type: object @@ -189086,7 +189770,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *604 + repository: *607 sender: *19 thread: type: object @@ -189472,10 +190156,10 @@ x-webhooks: type: string before: type: string - enterprise: *601 - installation: *602 - number: *650 - organization: *603 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 pull_request: title: Pull Request type: object @@ -191746,7 +192430,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -191828,11 +192512,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *656 - enterprise: *601 - installation: *602 - number: *650 - organization: *603 + assignee: *659 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 pull_request: title: Pull Request type: object @@ -194115,7 +194799,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -194194,11 +194878,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *601 - installation: *602 - label: *620 - number: *650 - organization: *603 + enterprise: *604 + installation: *605 + label: *623 + number: *653 + organization: *606 pull_request: title: Pull Request type: object @@ -196471,7 +197155,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -196552,10 +197236,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *601 - installation: *602 - number: *650 - organization: *603 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 pull_request: title: Pull Request type: object @@ -198820,7 +199504,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -199020,7 +199704,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *601 + enterprise: *604 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -199112,8 +199796,8 @@ x-webhooks: - url - author - committer - installation: *602 - organization: *603 + installation: *605 + organization: *606 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -199688,9 +200372,9 @@ x-webhooks: type: string enum: - published - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 registry_package: type: object properties: @@ -200136,7 +200820,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *638 + items: *641 summary: type: string tag_name: @@ -200190,7 +200874,7 @@ x-webhooks: - owner - package_version - registry - repository: *604 + repository: *607 sender: *19 required: - action @@ -200268,9 +200952,9 @@ x-webhooks: type: string enum: - updated - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 registry_package: type: object properties: @@ -200578,7 +201262,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *638 + items: *641 summary: type: string tag_name: @@ -200627,7 +201311,7 @@ x-webhooks: - owner - package_version - registry - repository: *604 + repository: *607 sender: *19 required: - action @@ -200704,10 +201388,10 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - release: &657 + enterprise: *604 + installation: *605 + organization: *606 + release: &660 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -201012,7 +201696,7 @@ x-webhooks: - tarball_url - zipball_url - body - repository: *604 + repository: *607 sender: *19 required: - action @@ -201089,11 +201773,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 - release: *657 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + release: *660 + repository: *607 sender: *19 required: - action @@ -201201,11 +201885,11 @@ x-webhooks: type: boolean required: - to - enterprise: *601 - installation: *602 - organization: *603 - release: *657 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + release: *660 + repository: *607 sender: *19 required: - action @@ -201283,9 +201967,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -201594,7 +202278,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *604 + repository: *607 sender: *19 required: - action @@ -201670,10 +202354,10 @@ x-webhooks: type: string enum: - published - enterprise: *601 - installation: *602 - organization: *603 - release: &658 + enterprise: *604 + installation: *605 + organization: *606 + release: &661 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -201979,7 +202663,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *604 + repository: *607 sender: *19 required: - action @@ -202055,11 +202739,11 @@ x-webhooks: type: string enum: - released - enterprise: *601 - installation: *602 - organization: *603 - release: *657 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + release: *660 + repository: *607 sender: *19 required: - action @@ -202135,11 +202819,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *601 - installation: *602 - organization: *603 - release: *658 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + release: *661 + repository: *607 sender: *19 required: - action @@ -202215,11 +202899,11 @@ x-webhooks: type: string enum: - published - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - repository_advisory: *532 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + repository_advisory: *535 sender: *19 required: - action @@ -202295,11 +202979,11 @@ x-webhooks: type: string enum: - reported - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - repository_advisory: *532 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + repository_advisory: *535 sender: *19 required: - action @@ -202375,10 +203059,10 @@ x-webhooks: type: string enum: - archived - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -202455,10 +203139,10 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -202536,10 +203220,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -202623,10 +203307,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -202738,10 +203422,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -202813,10 +203497,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 status: type: string @@ -202897,10 +203581,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -202977,10 +203661,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -203074,10 +203758,10 @@ x-webhooks: - name required: - repository - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -203157,11 +203841,11 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - repository_ruleset: *212 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + repository_ruleset: *215 sender: *19 required: - action @@ -203239,11 +203923,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - repository_ruleset: *212 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + repository_ruleset: *215 sender: *19 required: - action @@ -203321,11 +204005,11 @@ x-webhooks: type: string enum: - edited - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - repository_ruleset: *212 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + repository_ruleset: *215 changes: type: object properties: @@ -203344,16 +204028,16 @@ x-webhooks: properties: added: type: array - items: *206 + items: *209 deleted: type: array - items: *206 + items: *209 updated: type: array items: type: object properties: - condition: *206 + condition: *209 changes: type: object properties: @@ -203386,16 +204070,16 @@ x-webhooks: properties: added: type: array - items: *211 + items: *214 deleted: type: array - items: *211 + items: *214 updated: type: array items: type: object properties: - rule: *211 + rule: *214 changes: type: object properties: @@ -203629,10 +204313,10 @@ x-webhooks: - from required: - owner - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -203710,10 +204394,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -203791,7 +204475,7 @@ x-webhooks: type: string enum: - create - alert: &659 + alert: &662 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -203912,10 +204596,10 @@ x-webhooks: type: string enum: - open - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -204121,10 +204805,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -204202,11 +204886,11 @@ x-webhooks: type: string enum: - reopen - alert: *659 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + alert: *662 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -204405,10 +205089,10 @@ x-webhooks: enum: - fixed - open - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -204486,7 +205170,7 @@ x-webhooks: type: string enum: - created - alert: &660 + alert: &663 type: object properties: number: *48 @@ -204575,10 +205259,10 @@ x-webhooks: description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -204659,11 +205343,11 @@ x-webhooks: type: string enum: - created - alert: *660 - installation: *602 - location: *661 - organization: *603 - repository: *604 + alert: *663 + installation: *605 + location: *664 + organization: *606 + repository: *607 sender: *19 required: - location @@ -204901,11 +205585,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *660 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + alert: *663 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -204983,11 +205667,11 @@ x-webhooks: type: string enum: - reopened - alert: *660 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + alert: *663 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -205065,11 +205749,11 @@ x-webhooks: type: string enum: - resolved - alert: *660 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + alert: *663 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -205147,11 +205831,11 @@ x-webhooks: type: string enum: - validated - alert: *660 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + alert: *663 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -205227,11 +205911,11 @@ x-webhooks: type: string enum: - published - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - security_advisory: &662 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + security_advisory: &665 description: The details of the security advisory, including summary, description, and severity. type: object @@ -205414,11 +206098,11 @@ x-webhooks: type: string enum: - updated - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - security_advisory: *662 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + security_advisory: *665 sender: *19 required: - action @@ -205491,10 +206175,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -205678,11 +206362,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *205 - enterprise: *601 - installation: *602 - organization: *603 - repository: *250 + security_and_analysis: *208 + enterprise: *604 + installation: *605 + organization: *606 + repository: *253 sender: *19 required: - changes @@ -205760,12 +206444,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - sponsorship: &663 + sponsorship: &666 type: object properties: created_at: @@ -206066,12 +206750,12 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - sponsorship: *663 + sponsorship: *666 required: - action - sponsorship @@ -206159,12 +206843,12 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - sponsorship: *663 + sponsorship: *666 required: - action - changes @@ -206241,17 +206925,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &664 + effective_date: &667 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: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - sponsorship: *663 + sponsorship: *666 required: - action - sponsorship @@ -206325,7 +207009,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &665 + changes: &668 type: object properties: tier: @@ -206369,13 +207053,13 @@ x-webhooks: - from required: - tier - effective_date: *664 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + effective_date: *667 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - sponsorship: *663 + sponsorship: *666 required: - action - changes @@ -206452,13 +207136,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *665 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + changes: *668 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - sponsorship: *663 + sponsorship: *666 required: - action - changes @@ -206532,10 +207216,10 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 starred_at: description: 'The time the star was created. This is a timestamp @@ -206618,10 +207302,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 starred_at: description: 'The time the star was created. This is a timestamp @@ -207037,15 +207721,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *601 + enterprise: *604 id: description: The unique identifier of the status. type: integer - installation: *602 + installation: *605 name: type: string - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 sha: description: The Commit SHA. @@ -207154,15 +207838,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *72 - parent_issue_repo: *55 + parent_issue: *75 + parent_issue_repo: *58 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *72 - installation: *602 - organization: *603 - repository: *604 + sub_issue: *75 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -207246,15 +207930,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *72 - parent_issue_repo: *55 + parent_issue: *75 + parent_issue_repo: *58 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *72 - installation: *602 - organization: *603 - repository: *604 + sub_issue: *75 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -207338,15 +208022,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *72 - sub_issue_repo: *55 + sub_issue: *75 + sub_issue_repo: *58 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *72 - installation: *602 - organization: *603 - repository: *604 + parent_issue: *75 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -207430,15 +208114,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *72 - sub_issue_repo: *55 + sub_issue: *75 + sub_issue_repo: *58 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *72 - installation: *602 - organization: *603 - repository: *604 + parent_issue: *75 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -207515,12 +208199,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - team: &666 + team: &669 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -207710,9 +208394,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 repository: title: Repository description: A git repository @@ -208170,7 +208854,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *666 + team: *669 required: - action - team @@ -208246,9 +208930,9 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 repository: title: Repository description: A git repository @@ -208706,7 +209390,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *666 + team: *669 required: - action - team @@ -208783,9 +209467,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 repository: title: Repository description: A git repository @@ -209243,7 +209927,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *666 + team: *669 required: - action - team @@ -209387,9 +210071,9 @@ x-webhooks: - from required: - permissions - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 repository: title: Repository description: A git repository @@ -209847,7 +210531,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *666 + team: *669 required: - action - changes @@ -209925,9 +210609,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 repository: title: Repository description: A git repository @@ -210385,7 +211069,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *666 + team: *669 required: - action - team @@ -210461,10 +211145,10 @@ x-webhooks: type: string enum: - started - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -210537,16 +211221,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *601 + enterprise: *604 inputs: type: object nullable: true additionalProperties: true - installation: *602 - organization: *603 + installation: *605 + organization: *606 ref: type: string - repository: *604 + repository: *607 sender: *19 workflow: type: string @@ -210628,10 +211312,10 @@ x-webhooks: type: string enum: - completed - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 workflow_job: allOf: @@ -210868,7 +211552,7 @@ x-webhooks: type: string required: - conclusion - deployment: *394 + deployment: *397 required: - action - repository @@ -210947,10 +211631,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 workflow_job: allOf: @@ -211210,7 +211894,7 @@ x-webhooks: required: - status - steps - deployment: *394 + deployment: *397 required: - action - repository @@ -211289,10 +211973,10 @@ x-webhooks: type: string enum: - queued - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 workflow_job: type: object @@ -211427,7 +212111,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *394 + deployment: *397 required: - action - repository @@ -211506,10 +212190,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 workflow_job: type: object @@ -211645,7 +212329,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *394 + deployment: *397 required: - action - repository @@ -211725,12 +212409,12 @@ x-webhooks: type: string enum: - completed - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - workflow: *616 + workflow: *619 workflow_run: title: Workflow Run type: object @@ -212729,12 +213413,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - workflow: *616 + workflow: *619 workflow_run: title: Workflow Run type: object @@ -213718,12 +214402,12 @@ x-webhooks: type: string enum: - requested - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - workflow: *616 + workflow: *619 workflow_run: title: Workflow Run type: object diff --git a/descriptions/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 0771a47891..1bd12dc337 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -16676,6 +16676,646 @@ } } }, + "/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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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", @@ -19956,6 +20596,655 @@ } } }, + "/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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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", @@ -69957,6 +71246,646 @@ } } }, + "/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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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", @@ -125278,6 +127207,655 @@ } } }, + "/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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 2b183af347..fec7258842 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -838,7 +838,7 @@ paths: - subscriptions_url - type - url - type: &223 + type: &226 type: string description: The type of credit the user is receiving. enum: @@ -971,7 +971,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &95 + schema: &98 title: Validation Error Simple description: Validation Error Simple type: object @@ -1004,7 +1004,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &534 + - &537 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1122,7 +1122,7 @@ paths: GitHub. type: object nullable: true - properties: &56 + properties: &59 id: description: Unique identifier of the GitHub app example: 37 @@ -1211,7 +1211,7 @@ paths: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' - required: &57 + required: &60 - id - node_id - owner @@ -1516,7 +1516,7 @@ paths: schema: type: integer default: 30 - - &155 + - &158 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 @@ -1537,7 +1537,7 @@ paths: application/json: schema: type: array - items: &156 + items: &159 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1614,7 +1614,7 @@ paths: - installation_id - repository_id examples: - default: &157 + default: &160 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1673,7 +1673,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &94 + schema: &97 title: Validation Error description: Validation Error type: object @@ -1742,7 +1742,7 @@ paths: description: Response content: application/json: - schema: &158 + schema: &161 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1856,7 +1856,7 @@ paths: - request - response examples: - default: &159 + default: &162 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1916,7 +1916,7 @@ paths: parameters: - *17 responses: - '202': &96 + '202': &99 description: Accepted content: application/json: @@ -2111,7 +2111,7 @@ paths: parameters: - *18 - *20 - - &62 + - &65 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) @@ -2835,11 +2835,11 @@ paths: - selected repositories: type: array - items: &55 + items: &58 title: Repository description: A repository on GitHub. type: object - properties: &203 + properties: &206 id: description: Unique identifier of the repository example: 42 @@ -2859,7 +2859,7 @@ paths: title: License Simple description: License Simple type: object - properties: &73 + properties: &76 key: type: string example: mit @@ -2881,7 +2881,7 @@ paths: html_url: type: string format: uri - required: &74 + required: &77 - key - name - url @@ -3268,7 +3268,7 @@ paths: type: boolean description: Whether anonymous git access is enabled for this repository - required: &204 + required: &207 - archive_url - assignees_url - blobs_url @@ -6964,7 +6964,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &136 + items: &139 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -6975,7 +6975,7 @@ paths: title: Organization Simple description: A GitHub organization. type: object - properties: &89 + properties: &92 login: type: string example: github @@ -7016,7 +7016,7 @@ paths: type: string example: A great organization nullable: true - required: &90 + required: &93 - login - url - id @@ -7034,7 +7034,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &166 + - &169 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -7093,7 +7093,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &181 + properties: &184 id: description: Unique identifier of the team type: integer @@ -7149,7 +7149,7 @@ paths: maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string - required: &182 + required: &185 - id - node_id - url @@ -7260,7 +7260,7 @@ paths: - created_at additionalProperties: false examples: - default: &137 + default: &140 value: total_seats: 2 seats: @@ -7342,6 +7342,479 @@ 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: + - *40 + - 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 + - *20 + - 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: &53 + 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 + description: Usage metrics for Copilot editor code completions + in the IDE. + nullable: true + 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 + nullable: true + 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 + description: Usage metrics for Copilot Chat in the IDE. + nullable: true + 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 + nullable: true + 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 + description: Usage metrics for Copilot Chat in github.com + nullable: true + 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 + description: The training date for the custom model + (if applicable). + nullable: true + 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 + description: Usage metrics for Copilot for pull requests. + nullable: true + 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 + nullable: true + 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: &54 + 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': *41 + '403': *29 + '404': *7 + '422': &55 + 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 @@ -7399,7 +7872,7 @@ paths: application/json: schema: type: array - items: &53 + items: &56 title: Copilot Usage Metrics description: Summary of Copilot usage. type: object @@ -7578,7 +8051,7 @@ paths: url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &139 + - &142 name: state in: query description: |- @@ -7587,7 +8060,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &140 + - &143 name: severity in: query description: |- @@ -7596,7 +8069,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &141 + - &144 name: ecosystem in: query description: |- @@ -7605,14 +8078,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &142 + - &145 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 - - &143 + - &146 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -7622,7 +8095,7 @@ paths: enum: - development - runtime - - &144 + - &147 name: sort in: query description: |- @@ -7638,7 +8111,7 @@ paths: - *42 - *43 - *44 - - &145 + - &148 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -7651,7 +8124,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &146 + - &149 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -7671,7 +8144,7 @@ paths: application/json: schema: type: array - items: &147 + items: &150 type: object description: A Dependabot alert. properties: @@ -7724,7 +8197,7 @@ paths: enum: - development - runtime - security_advisory: &386 + security_advisory: &389 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -7942,13 +8415,13 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &124 + updated_at: &127 type: string description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_at: &126 + dismissed_at: &129 type: string description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -7978,14 +8451,14 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: &125 + fixed_at: &128 type: string description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true nullable: true - auto_dismissed_at: &387 + auto_dismissed_at: &390 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -8288,7 +8761,7 @@ paths: - repository additionalProperties: false examples: - default: &148 + default: &151 value: - number: 2 state: dismissed @@ -8632,7 +9105,7 @@ paths: url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *40 - - &214 + - &217 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -8643,7 +9116,7 @@ paths: enum: - open - resolved - - &215 + - &218 name: secret_type in: query description: |- @@ -8653,7 +9126,7 @@ paths: required: false schema: type: string - - &216 + - &219 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -8662,7 +9135,7 @@ paths: required: false schema: type: string - - &217 + - &220 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. @@ -8678,7 +9151,7 @@ paths: - *18 - *43 - *44 - - &218 + - &221 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -8687,7 +9160,7 @@ paths: required: false schema: type: string - - &219 + - &222 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -8696,7 +9169,7 @@ paths: schema: type: boolean default: false - - &220 + - &223 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -8712,7 +9185,7 @@ paths: application/json: schema: type: array - items: &221 + items: &224 type: object properties: number: *48 @@ -8731,14 +9204,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &527 + state: &530 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: &528 + resolution: &531 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -8813,7 +9286,7 @@ paths: repositories in the same organization or enterprise. nullable: true examples: - default: &222 + default: &225 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -9022,7 +9495,7 @@ paths: headers: Link: *39 '404': *7 - '503': &60 + '503': &63 description: Service unavailable content: application/json: @@ -9040,6 +9513,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: + - *40 + - 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 + - *20 + - 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: *53 + examples: + default: *54 + '500': *41 + '403': *29 + '404': *7 + '422': *55 + 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 @@ -9069,7 +9616,7 @@ paths: url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team parameters: - *40 - - &178 + - &181 name: team_slug description: The slug of the team name. in: path @@ -9107,9 +9654,9 @@ paths: application/json: schema: type: array - items: *53 + items: *56 examples: - default: &138 + default: &141 value: - day: '2023-10-15' total_suggestions_count: 1000 @@ -9204,7 +9751,7 @@ paths: application/json: schema: type: array - items: &84 + items: &87 title: Event description: Event type: object @@ -9214,7 +9761,7 @@ paths: type: type: string nullable: true - actor: &54 + actor: &57 title: Actor description: Actor type: object @@ -9254,18 +9801,18 @@ paths: - id - name - url - org: *54 + org: *57 payload: type: object properties: action: type: string - issue: &72 + issue: &75 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &435 + properties: &438 id: type: integer format: int64 @@ -9376,7 +9923,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &371 + properties: &374 url: type: string format: uri @@ -9446,7 +9993,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &372 + required: &375 - closed_issues - creator - description @@ -9525,7 +10072,7 @@ paths: timeline_url: type: string format: uri - repository: *55 + repository: *58 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -9535,9 +10082,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 - author_association: &58 + properties: *59 + required: *60 + author_association: &61 title: author_association type: string example: OWNER @@ -9551,7 +10098,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &59 + reactions: &62 title: Reaction Rollup type: object properties: @@ -9587,7 +10134,7 @@ paths: - hooray - eyes - rocket - required: &436 + required: &439 - assignee - closed_at - comments @@ -9609,7 +10156,7 @@ paths: - author_association - created_at - updated_at - comment: &433 + comment: &436 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -9657,7 +10204,7 @@ paths: issue_url: type: string format: uri - author_association: *58 + author_association: *61 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -9667,9 +10214,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 - reactions: *59 + properties: *59 + required: *60 + reactions: *62 required: - id - node_id @@ -9764,7 +10311,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *37 '403': *29 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -9845,7 +10392,7 @@ paths: _links: type: object properties: - timeline: &61 + timeline: &64 title: Link With Type description: Hypermedia Link with Type type: object @@ -9857,17 +10404,17 @@ paths: required: - href - type - user: *61 - security_advisories: *61 - current_user: *61 - current_user_public: *61 - current_user_actor: *61 - current_user_organization: *61 + user: *64 + security_advisories: *64 + current_user: *64 + current_user_public: *64 + current_user_actor: *64 + current_user_organization: *64 current_user_organizations: type: array - items: *61 - repository_discussions: *61 - repository_discussions_category: *61 + items: *64 + repository_discussions: *64 + repository_discussions_category: *64 required: - timeline - user @@ -9929,7 +10476,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *62 + - *65 - *18 - *20 responses: @@ -9939,7 +10486,7 @@ paths: application/json: schema: type: array - items: &63 + items: &66 title: Base Gist description: Base Gist type: object @@ -10031,7 +10578,7 @@ paths: - created_at - updated_at examples: - default: &64 + default: &67 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -10152,7 +10699,7 @@ paths: description: Response content: application/json: - schema: &65 + schema: &68 title: Gist Simple description: Gist Simple type: object @@ -10169,7 +10716,7 @@ paths: url: type: string format: uri - user: &557 + user: &560 title: Public User description: Public User type: object @@ -10522,7 +11069,7 @@ paths: truncated: type: boolean examples: - default: &66 + default: &69 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -10624,7 +11171,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *62 + - *65 - *18 - *20 responses: @@ -10634,9 +11181,9 @@ paths: application/json: schema: type: array - items: *63 + items: *66 examples: - default: *64 + default: *67 headers: Link: *39 '422': *16 @@ -10658,7 +11205,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *62 + - *65 - *18 - *20 responses: @@ -10668,9 +11215,9 @@ paths: application/json: schema: type: array - items: *63 + items: *66 examples: - default: *64 + default: *67 headers: Link: *39 '401': *25 @@ -10698,7 +11245,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &67 + - &70 name: gist_id description: The unique identifier of the gist. in: path @@ -10710,10 +11257,10 @@ paths: description: Response content: application/json: - schema: *65 + schema: *68 examples: - default: *66 - '403': &70 + default: *69 + '403': &73 description: Forbidden Gist content: application/json: @@ -10761,7 +11308,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *67 + - *70 requestBody: required: true content: @@ -10821,9 +11368,9 @@ paths: description: Response content: application/json: - schema: *65 + schema: *68 examples: - updateGist: *66 + updateGist: *69 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -10981,7 +11528,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *67 + - *70 responses: '204': description: Response @@ -11010,7 +11557,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *67 + - *70 - *18 - *20 responses: @@ -11020,7 +11567,7 @@ paths: application/json: schema: type: array - items: &68 + items: &71 title: Gist Comment description: A comment made to a gist. type: object @@ -11055,7 +11602,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *58 + author_association: *61 required: - url - id @@ -11120,7 +11667,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *67 + - *70 requestBody: required: true content: @@ -11145,9 +11692,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *71 examples: - default: &69 + default: &72 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -11205,8 +11752,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *67 - - &71 + - *70 + - &74 name: comment_id description: The unique identifier of the comment. in: path @@ -11219,12 +11766,12 @@ paths: description: Response content: application/json: - schema: *68 + schema: *71 examples: - default: *69 + default: *72 '304': *37 '404': *7 - '403': *70 + '403': *73 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -11246,8 +11793,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *67 - - *71 + - *70 + - *74 requestBody: required: true content: @@ -11272,9 +11819,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *71 examples: - default: *69 + default: *72 '404': *7 x-github: githubCloudOnly: false @@ -11291,8 +11838,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *67 - - *71 + - *70 + - *74 responses: '204': description: Response @@ -11315,7 +11862,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *67 + - *70 - *18 - *20 responses: @@ -11416,7 +11963,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *67 + - *70 - *18 - *20 responses: @@ -11426,7 +11973,7 @@ paths: application/json: schema: type: array - items: *65 + items: *68 examples: default: value: @@ -11491,13 +12038,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *67 + - *70 responses: '201': description: Response content: application/json: - schema: *63 + schema: *66 examples: default: value: @@ -11568,7 +12115,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *67 + - *70 responses: '204': description: Response if gist is starred @@ -11598,7 +12145,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *67 + - *70 responses: '204': description: Response @@ -11620,7 +12167,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *67 + - *70 responses: '204': description: Response @@ -11649,7 +12196,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *67 + - *70 - name: sha in: path required: true @@ -11660,9 +12207,9 @@ paths: description: Response content: application/json: - schema: *65 + schema: *68 examples: - default: *66 + default: *69 '422': *16 '404': *7 '403': *29 @@ -11821,7 +12368,7 @@ paths: type: integer repositories: type: array - items: *55 + items: *58 repository_selection: type: string example: selected @@ -12028,7 +12575,7 @@ paths: - closed - all default: open - - &167 + - &170 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -12047,7 +12594,7 @@ paths: - comments default: created - *42 - - *62 + - *65 - name: collab in: query required: false @@ -12077,9 +12624,9 @@ paths: application/json: schema: type: array - items: *72 + items: *75 examples: - default: &168 + default: &171 value: - id: 1 node_id: MDU6SXNzdWUx @@ -12363,8 +12910,8 @@ paths: title: License Simple description: License Simple type: object - properties: *73 - required: *74 + properties: *76 + required: *77 examples: default: value: @@ -12648,7 +13195,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &75 + X-CommonMarker-Version: &78 example: 0.17.4 schema: type: string @@ -12703,7 +13250,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *75 + X-CommonMarker-Version: *78 content: text/html: schema: @@ -12732,7 +13279,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &78 + - &81 name: account_id description: account_id parameter in: path @@ -12744,7 +13291,7 @@ paths: description: Response content: application/json: - schema: &77 + schema: &80 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -12774,7 +13321,7 @@ paths: nullable: true id: type: integer - plan: &76 + plan: &79 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -12863,7 +13410,7 @@ paths: nullable: true updated_at: type: string - plan: *76 + plan: *79 required: - url - id @@ -12871,7 +13418,7 @@ paths: - login - marketplace_purchase examples: - default: &79 + default: &82 value: url: https://api.github.com/orgs/github type: Organization @@ -12956,9 +13503,9 @@ paths: application/json: schema: type: array - items: *76 + items: *79 examples: - default: &80 + default: &83 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -12998,14 +13545,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &81 + - &84 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &82 + - &85 name: sort description: The property to sort the results by. in: query @@ -13035,9 +13582,9 @@ paths: application/json: schema: type: array - items: *77 + items: *80 examples: - default: &83 + default: &86 value: - url: https://api.github.com/orgs/github type: Organization @@ -13111,15 +13658,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *78 + - *81 responses: '200': description: Response content: application/json: - schema: *77 + schema: *80 examples: - default: *79 + default: *82 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -13151,9 +13698,9 @@ paths: application/json: schema: type: array - items: *76 + items: *79 examples: - default: *80 + default: *83 headers: Link: *39 '401': *25 @@ -13176,8 +13723,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *81 - - *82 + - *84 + - *85 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -13197,9 +13744,9 @@ paths: application/json: schema: type: array - items: *77 + items: *80 examples: - default: *83 + default: *86 headers: Link: *39 '401': *25 @@ -13448,14 +13995,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &239 + - &242 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &240 + - &243 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -13472,7 +14019,7 @@ paths: application/json: schema: type: array - items: *84 + items: *87 examples: default: value: @@ -13526,7 +14073,7 @@ paths: '404': *7 '403': *29 '304': *37 - '301': &251 + '301': &254 description: Moved permanently content: application/json: @@ -13548,7 +14095,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &464 + - &467 name: all description: If `true`, show notifications marked as read. in: query @@ -13556,7 +14103,7 @@ paths: schema: type: boolean default: false - - &465 + - &468 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -13565,8 +14112,8 @@ paths: schema: type: boolean default: false - - *62 - - &466 + - *65 + - &469 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: @@ -13591,18 +14138,18 @@ paths: application/json: schema: type: array - items: &85 + items: &88 title: Thread description: Thread type: object properties: id: type: string - repository: &110 + repository: &113 title: Minimal Repository description: Minimal Repository type: object - properties: &150 + properties: &153 id: type: integer format: int64 @@ -13878,7 +14425,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &205 + security_and_analysis: &208 nullable: true type: object properties: @@ -13934,7 +14481,7 @@ paths: enum: - enabled - disabled - required: &151 + required: &154 - archive_url - assignees_url - blobs_url @@ -14022,7 +14569,7 @@ paths: - url - subscription_url examples: - default: &467 + default: &470 value: - id: '1' repository: @@ -14188,7 +14735,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &86 + - &89 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 @@ -14202,7 +14749,7 @@ paths: description: Response content: application/json: - schema: *85 + schema: *88 examples: default: value: @@ -14304,7 +14851,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *86 + - *89 responses: '205': description: Reset Content @@ -14326,7 +14873,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *86 + - *89 responses: '204': description: No content @@ -14349,13 +14896,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *86 + - *89 responses: '200': description: Response content: application/json: - schema: &87 + schema: &90 title: Thread Subscription description: Thread Subscription type: object @@ -14392,7 +14939,7 @@ paths: - url - subscribed examples: - default: &88 + default: &91 value: subscribed: true ignored: false @@ -14423,7 +14970,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *86 + - *89 requestBody: required: false content: @@ -14444,9 +14991,9 @@ paths: description: Response content: application/json: - schema: *87 + schema: *90 examples: - default: *88 + default: *91 '304': *37 '403': *29 '401': *25 @@ -14469,7 +15016,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *86 + - *89 responses: '204': description: Response @@ -14564,14 +15111,14 @@ paths: application/json: schema: type: array - items: &173 + items: &176 title: Organization Simple description: A GitHub organization. type: object - properties: *89 - required: *90 + properties: *92 + required: *93 examples: - default: &575 + default: &578 value: - login: github id: 1 @@ -14616,7 +15163,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - &91 + - &94 name: org description: The organization name. The name is not case sensitive. in: path @@ -14628,7 +15175,7 @@ paths: description: Response content: application/json: - schema: &92 + schema: &95 title: Organization Full description: Organization Full type: object @@ -14912,7 +15459,7 @@ paths: - updated_at - archived_at examples: - default-response: &93 + default-response: &96 value: login: github id: 1 @@ -15002,7 +15549,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *91 + - *94 requestBody: required: false content: @@ -15214,18 +15761,18 @@ paths: description: Response content: application/json: - schema: *92 + schema: *95 examples: - default: *93 + default: *96 '422': description: Validation failed content: application/json: schema: oneOf: - - *94 - - *95 - '409': &131 + - *97 + - *98 + '409': &134 description: Conflict content: application/json: @@ -15252,9 +15799,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *91 + - *94 responses: - '202': *96 + '202': *99 '404': *7 '403': *29 x-github: @@ -15277,7 +15824,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response @@ -15324,7 +15871,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: - - *91 + - *94 - *18 - *20 responses: @@ -15342,7 +15889,7 @@ paths: type: integer repository_cache_usages: type: array - items: &256 + items: &259 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -15397,13 +15944,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: - - *91 + - *94 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &97 + schema: &100 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -15417,7 +15964,7 @@ paths: required: - include_claim_keys examples: - default: &98 + default: &101 value: include_claim_keys: - repo @@ -15439,20 +15986,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: - - *91 + - *94 requestBody: required: true content: application/json: - schema: *97 + schema: *100 examples: - default: *98 + default: *101 responses: '201': description: Empty response content: application/json: - schema: &119 + schema: &122 title: Empty Object description: An object without any properties. type: object @@ -15482,7 +16029,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response @@ -15491,7 +16038,7 @@ paths: schema: type: object properties: - enabled_repositories: &99 + enabled_repositories: &102 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -15504,7 +16051,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: &100 + allowed_actions: &103 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -15512,7 +16059,7 @@ paths: - all - local_only - selected - selected_actions_url: &262 + selected_actions_url: &265 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` @@ -15543,7 +16090,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *91 + - *94 responses: '204': description: Response @@ -15554,8 +16101,8 @@ paths: schema: type: object properties: - enabled_repositories: *99 - allowed_actions: *100 + enabled_repositories: *102 + allowed_actions: *103 required: - enabled_repositories examples: @@ -15582,7 +16129,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: - - *91 + - *94 - *18 - *20 responses: @@ -15600,9 +16147,9 @@ paths: type: number repositories: type: array - items: *55 + items: *58 examples: - default: &569 + default: &572 value: total_count: 1 repositories: @@ -15742,7 +16289,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: - - *91 + - *94 responses: '204': description: Response @@ -15786,8 +16333,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: - - *91 - - &101 + - *94 + - &104 name: repository_id description: The unique identifier of the repository. in: path @@ -15815,8 +16362,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: - - *91 - - *101 + - *94 + - *104 responses: '204': description: Response @@ -15839,13 +16386,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: &102 + schema: &105 type: object properties: github_owned_allowed: @@ -15867,7 +16414,7 @@ paths: items: type: string examples: - default: &103 + default: &106 value: github_owned_allowed: true verified_allowed: false @@ -15892,7 +16439,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *91 + - *94 responses: '204': description: Response @@ -15900,9 +16447,9 @@ paths: required: false content: application/json: - schema: *102 + schema: *105 examples: - selected_actions: *103 + selected_actions: *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -15924,23 +16471,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: &266 + schema: &269 type: object properties: - default_workflow_permissions: &104 + default_workflow_permissions: &107 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &105 + can_approve_pull_request_reviews: &108 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -15948,7 +16495,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &106 + default: &109 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -15973,7 +16520,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *91 + - *94 responses: '204': description: Success response @@ -15981,13 +16528,13 @@ paths: required: false content: application/json: - schema: &267 + schema: &270 type: object properties: - default_workflow_permissions: *104 - can_approve_pull_request_reviews: *105 + default_workflow_permissions: *107 + can_approve_pull_request_reviews: *108 examples: - default: *106 + default: *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16007,7 +16554,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: - - *91 + - *94 - *18 - *20 - name: visible_to_repository @@ -16032,7 +16579,7 @@ paths: type: number runner_groups: type: array - items: &107 + items: &110 type: object properties: id: @@ -16144,7 +16691,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: - - *91 + - *94 requestBody: required: true content: @@ -16213,9 +16760,9 @@ paths: description: Response content: application/json: - schema: *107 + schema: *110 examples: - default: &109 + default: &112 value: id: 2 name: octo-runner-group @@ -16250,8 +16797,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: - - *91 - - &108 + - *94 + - &111 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -16263,7 +16810,7 @@ paths: description: Response content: application/json: - schema: *107 + schema: *110 examples: default: value: @@ -16299,8 +16846,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: - - *91 - - *108 + - *94 + - *111 requestBody: required: true content: @@ -16350,9 +16897,9 @@ paths: description: Response content: application/json: - schema: *107 + schema: *110 examples: - default: *109 + default: *112 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -16371,8 +16918,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: - - *91 - - *108 + - *94 + - *111 responses: '204': description: Response @@ -16395,8 +16942,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: - - *91 - - *108 + - *94 + - *111 - *20 - *18 responses: @@ -16414,9 +16961,9 @@ paths: type: number repositories: type: array - items: *110 + items: *113 examples: - default: &560 + default: &563 value: total_count: 1 repositories: @@ -16668,8 +17215,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: - - *91 - - *108 + - *94 + - *111 requestBody: required: true content: @@ -16713,9 +17260,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: - - *91 - - *108 - - *101 + - *94 + - *111 + - *104 responses: '204': description: Response @@ -16737,9 +17284,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: - - *91 - - *108 - - *101 + - *94 + - *111 + - *104 responses: '204': description: Response @@ -16762,8 +17309,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: - - *91 - - *108 + - *94 + - *111 - *18 - *20 responses: @@ -16781,7 +17328,7 @@ paths: type: number runners: type: array - items: &112 + items: &115 title: Self hosted runners description: A self hosted runner type: object @@ -16810,7 +17357,7 @@ paths: type: boolean labels: type: array - items: &115 + items: &118 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -16838,7 +17385,7 @@ paths: - busy - labels examples: - default: &113 + default: &116 value: total_count: 2 runners: @@ -16895,8 +17442,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: - - *91 - - *108 + - *94 + - *111 requestBody: required: true content: @@ -16940,9 +17487,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: - - *91 - - *108 - - &111 + - *94 + - *111 + - &114 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -16970,9 +17517,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: - - *91 - - *108 + - *94 - *111 + - *114 responses: '204': description: Response @@ -17002,7 +17549,7 @@ paths: in: query schema: type: string - - *91 + - *94 - *18 - *20 responses: @@ -17020,9 +17567,9 @@ paths: type: integer runners: type: array - items: *112 + items: *115 examples: - default: *113 + default: *116 headers: Link: *39 x-github: @@ -17046,7 +17593,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response @@ -17054,7 +17601,7 @@ paths: application/json: schema: type: array - items: &268 + items: &271 title: Runner Application description: Runner Application type: object @@ -17079,7 +17626,7 @@ paths: - download_url - filename examples: - default: &269 + default: &272 value: - os: osx architecture: x64 @@ -17122,7 +17669,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: - - *91 + - *94 requestBody: required: true content: @@ -17165,7 +17712,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &270 + '201': &273 description: Response content: application/json: @@ -17175,7 +17722,7 @@ paths: - runner - encoded_jit_config properties: - runner: *112 + runner: *115 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -17231,13 +17778,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *91 + - *94 responses: '201': description: Response content: application/json: - schema: &114 + schema: &117 title: Authentication Token description: Authentication Token type: object @@ -17259,7 +17806,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *55 + items: *58 single_file: type: string example: config.yaml @@ -17275,7 +17822,7 @@ paths: - token - expires_at examples: - default: &271 + default: &274 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -17306,15 +17853,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *91 + - *94 responses: '201': description: Response content: application/json: - schema: *114 + schema: *117 examples: - default: &272 + default: &275 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -17339,16 +17886,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: - - *91 - - *111 + - *94 + - *114 responses: '200': description: Response content: application/json: - schema: *112 + schema: *115 examples: - default: &273 + default: &276 value: id: 23 name: MBP @@ -17388,8 +17935,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: - - *91 - - *111 + - *94 + - *114 responses: '204': description: Response @@ -17414,10 +17961,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: - - *91 - - *111 + - *94 + - *114 responses: - '200': &116 + '200': &119 description: Response content: application/json: @@ -17431,7 +17978,7 @@ paths: type: integer labels: type: array - items: *115 + items: *118 examples: default: value: @@ -17470,8 +18017,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: - - *91 - - *111 + - *94 + - *114 requestBody: required: true content: @@ -17495,7 +18042,7 @@ paths: - gpu - accelerated responses: - '200': *116 + '200': *119 '404': *7 '422': *8 x-github: @@ -17519,8 +18066,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: - - *91 - - *111 + - *94 + - *114 requestBody: required: true content: @@ -17545,7 +18092,7 @@ paths: - gpu - accelerated responses: - '200': *116 + '200': *119 '404': *7 '422': *8 x-github: @@ -17569,10 +18116,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: - - *91 - - *111 + - *94 + - *114 responses: - '200': &274 + '200': &277 description: Response content: application/json: @@ -17586,7 +18133,7 @@ paths: type: integer labels: type: array - items: *115 + items: *118 examples: default: value: @@ -17627,9 +18174,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: - - *91 - - *111 - - &275 + - *94 + - *114 + - &278 name: name description: The name of a self-hosted runner's custom label. in: path @@ -17637,7 +18184,7 @@ paths: schema: type: string responses: - '200': *116 + '200': *119 '404': *7 '422': *8 x-github: @@ -17662,7 +18209,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *91 + - *94 - *18 - *20 responses: @@ -17680,7 +18227,7 @@ paths: type: integer secrets: type: array - items: &117 + items: &120 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -17753,13 +18300,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: &287 + schema: &290 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -17788,7 +18335,7 @@ paths: - key_id - key examples: - default: &288 + default: &291 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -17813,8 +18360,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *91 - - &118 + - *94 + - &121 name: secret_name description: The name of the secret. in: path @@ -17826,7 +18373,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *120 examples: default: value: @@ -17856,8 +18403,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 requestBody: required: true content: @@ -17912,7 +18459,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -17938,8 +18485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 responses: '204': description: Response @@ -17965,8 +18512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - *20 - *18 responses: @@ -17984,9 +18531,9 @@ paths: type: integer repositories: type: array - items: *110 + items: *113 examples: - default: &122 + default: &125 value: total_count: 1 repositories: @@ -18078,8 +18625,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 requestBody: required: true content: @@ -18131,8 +18678,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - name: repository_id in: path required: true @@ -18165,8 +18712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - name: repository_id in: path required: true @@ -18198,8 +18745,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *91 - - &261 + - *94 + - &264 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)." @@ -18223,7 +18770,7 @@ paths: type: integer variables: type: array - items: &120 + items: &123 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -18308,7 +18855,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *91 + - *94 requestBody: required: true content: @@ -18356,7 +18903,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -18381,8 +18928,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *91 - - &121 + - *94 + - &124 name: name description: The name of the variable. in: path @@ -18394,7 +18941,7 @@ paths: description: Response content: application/json: - schema: *120 + schema: *123 examples: default: value: @@ -18424,8 +18971,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *91 - - *121 + - *94 + - *124 requestBody: required: true content: @@ -18487,8 +19034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *91 - - *121 + - *94 + - *124 responses: '204': description: Response @@ -18514,8 +19061,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *91 - - *121 + - *94 + - *124 - *20 - *18 responses: @@ -18533,9 +19080,9 @@ paths: type: integer repositories: type: array - items: *110 + items: *113 examples: - default: *122 + default: *125 '409': description: Response when the visibility of the variable is not set to `selected` @@ -18561,8 +19108,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *91 - - *121 + - *94 + - *124 requestBody: required: true content: @@ -18611,8 +19158,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *91 - - *121 + - *94 + - *124 - name: repository_id in: path required: true @@ -18646,8 +19193,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *91 - - *121 + - *94 + - *124 - name: repository_id in: path required: true @@ -18683,7 +19230,7 @@ paths: - *18 - *43 - *44 - - *91 + - *94 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -18724,7 +19271,7 @@ paths: repository_id: type: integer examples: - default: &301 + default: &304 value: attestations: - bundle: @@ -18831,7 +19378,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *91 + - *94 - *18 - *20 responses: @@ -18843,7 +19390,7 @@ paths: type: array items: *19 examples: - default: &169 + default: &172 value: - login: octocat id: 1 @@ -18881,8 +19428,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *91 - - &123 + - *94 + - &126 name: username description: The handle for the GitHub user account. in: path @@ -18913,8 +19460,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -18934,8 +19481,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -18960,18 +19507,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *91 - - &327 + - *94 + - &330 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: &127 + schema: &130 type: string description: The name of the tool used to generate the code scanning analysis. - - &328 + - &331 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 @@ -18979,7 +19526,7 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &128 + schema: &131 nullable: true type: string description: The GUID of the tool used to generate the code scanning analysis, @@ -18994,7 +19541,7 @@ paths: be returned. in: query required: false - schema: &330 + schema: &333 type: string description: State of a code scanning alert. enum: @@ -19017,7 +19564,7 @@ paths: be returned. in: query required: false - schema: &331 + schema: &334 type: string description: Severity of a code scanning alert. enum: @@ -19040,16 +19587,16 @@ paths: properties: number: *48 created_at: *49 - updated_at: *124 + updated_at: *127 url: *50 html_url: *51 - instances_url: &332 + instances_url: &335 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &129 + state: &132 type: string description: State of a code scanning alert. nullable: true @@ -19057,7 +19604,7 @@ paths: - open - dismissed - fixed - fixed_at: *125 + fixed_at: *128 dismissed_by: title: Simple User description: A GitHub user. @@ -19065,8 +19612,8 @@ paths: properties: *4 required: *5 nullable: true - dismissed_at: *126 - dismissed_reason: &333 + dismissed_at: *129 + dismissed_reason: &336 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -19075,13 +19622,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &334 + dismissed_comment: &337 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &335 + rule: &338 type: object properties: id: @@ -19134,25 +19681,25 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &336 + tool: &339 type: object properties: - name: *127 + name: *130 version: nullable: true type: string description: The version of the tool used to generate the code scanning analysis. - guid: *128 - most_recent_instance: &337 + guid: *131 + most_recent_instance: &340 type: object properties: - ref: &329 + ref: &332 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &343 + analysis_key: &346 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -19163,13 +19710,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &344 + category: &347 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: *129 + state: *132 commit_sha: type: string message: @@ -19455,7 +20002,7 @@ paths: headers: Link: *39 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19477,7 +20024,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *91 + - *94 - name: target_type in: query description: The target type of the code security configuration @@ -19505,7 +20052,7 @@ paths: application/json: schema: type: array - items: &130 + items: &133 type: object description: A code security configuration properties: @@ -19744,7 +20291,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *91 + - *94 requestBody: required: true content: @@ -19916,9 +20463,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *130 + schema: *133 examples: - default: &132 + default: &135 value: id: 1325 target_type: organization @@ -19964,7 +20511,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *91 + - *94 responses: '200': description: Response @@ -19984,7 +20531,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *130 + configuration: *133 examples: default: value: @@ -20068,7 +20615,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *91 + - *94 requestBody: required: true content: @@ -20091,12 +20638,12 @@ paths: - 32 - 91 responses: - '204': &134 + '204': &137 description: A header with no content is returned. '400': *15 '403': *29 '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20118,8 +20665,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *91 - - &133 + - *94 + - &136 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -20131,9 +20678,9 @@ paths: description: Response content: application/json: - schema: *130 + schema: *133 examples: - default: *132 + default: *135 '304': *37 '403': *29 '404': *7 @@ -20157,8 +20704,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *91 - - *133 + - *94 + - *136 requestBody: required: true content: @@ -20310,7 +20857,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *130 + schema: *133 examples: default: value: @@ -20361,14 +20908,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *91 - - *133 + - *94 + - *136 responses: - '204': *134 + '204': *137 '400': *15 '403': *29 '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20392,8 +20939,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *91 - - *133 + - *94 + - *136 requestBody: required: true content: @@ -20432,7 +20979,7 @@ paths: - 32 - 91 responses: - '202': *96 + '202': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20456,8 +21003,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: - - *91 - - *133 + - *94 + - *136 requestBody: required: true content: @@ -20497,12 +21044,12 @@ paths: - none - private_and_internal - public - configuration: *130 + configuration: *133 examples: default: value: default_for_new_repos: all - configuration: *132 + configuration: *135 '403': *29 '404': *7 x-github: @@ -20526,8 +21073,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *91 - - *133 + - *94 + - *136 - 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)." @@ -20670,7 +21217,7 @@ paths: parameters: - *18 - *20 - - *91 + - *94 responses: '200': description: Response @@ -20686,7 +21233,7 @@ paths: type: integer codespaces: type: array - items: &170 + items: &173 type: object title: Codespace description: A codespace. @@ -20711,12 +21258,12 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *110 + repository: *113 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &357 + properties: &360 name: type: string description: The name of the machine. @@ -20758,7 +21305,7 @@ paths: - ready - in_progress nullable: true - required: &358 + required: &361 - name - display_name - operating_system @@ -20963,7 +21510,7 @@ paths: - pulls_url - recent_folders examples: - default: &171 + default: &174 value: total_count: 3 codespaces: @@ -21395,7 +21942,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *91 + - *94 deprecated: true requestBody: required: true @@ -21462,7 +22009,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *91 + - *94 deprecated: true requestBody: required: true @@ -21517,7 +22064,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *91 + - *94 requestBody: required: true content: @@ -21569,7 +22116,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *91 + - *94 - *18 - *20 responses: @@ -21587,7 +22134,7 @@ paths: type: integer secrets: type: array - items: &135 + items: &138 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -21626,7 +22173,7 @@ paths: - updated_at - visibility examples: - default: &359 + default: &362 value: total_count: 2 secrets: @@ -21658,13 +22205,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: &360 + schema: &363 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -21693,7 +22240,7 @@ paths: - key_id - key examples: - default: &361 + default: &364 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -21716,16 +22263,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 responses: '200': description: Response content: application/json: - schema: *135 + schema: *138 examples: - default: &363 + default: &366 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -21752,8 +22299,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 requestBody: required: true content: @@ -21808,7 +22355,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -21834,8 +22381,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 responses: '204': description: Response @@ -21860,8 +22407,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - *20 - *18 responses: @@ -21879,9 +22426,9 @@ paths: type: integer repositories: type: array - items: *110 + items: *113 examples: - default: *122 + default: *125 '404': *7 x-github: githubCloudOnly: false @@ -21903,8 +22450,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 requestBody: required: true content: @@ -21954,8 +22501,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - name: repository_id in: path required: true @@ -21988,8 +22535,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - name: repository_id in: path required: true @@ -22028,7 +22575,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: - - *91 + - *94 responses: '200': description: OK @@ -22168,7 +22715,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: - - *91 + - *94 - *20 - name: per_page description: The number of results per page (max 100). For more information, @@ -22191,9 +22738,9 @@ paths: currently being billed. seats: type: array - items: *136 + items: *139 examples: - default: *137 + default: *140 headers: Link: *39 '500': *41 @@ -22231,7 +22778,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: - - *91 + - *94 requestBody: content: application/json: @@ -22309,7 +22856,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: - - *91 + - *94 requestBody: content: application/json: @@ -22390,7 +22937,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: - - *91 + - *94 requestBody: content: application/json: @@ -22468,7 +23015,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: - - *91 + - *94 requestBody: content: application/json: @@ -22524,6 +23071,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: + - *94 + - 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 + - *20 + - 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: *53 + examples: + default: *54 + '500': *41 + '403': *29 + '404': *7 + '422': *55 + 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 @@ -22549,7 +23164,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: - - *91 + - *94 - 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`). @@ -22581,9 +23196,9 @@ paths: application/json: schema: type: array - items: *53 + items: *56 examples: - default: *138 + default: *141 '500': *41 '401': *25 '403': *29 @@ -22609,18 +23224,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *91 - - *139 - - *140 - - *141 + - *94 - *142 - *143 - *144 + - *145 + - *146 + - *147 - *42 - *43 - *44 - - *145 - - *146 + - *148 + - *149 - *18 responses: '200': @@ -22629,9 +23244,9 @@ paths: application/json: schema: type: array - items: *147 + items: *150 examples: - default: *148 + default: *151 '304': *37 '400': *15 '403': *29 @@ -22657,7 +23272,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *91 + - *94 - *18 - *20 responses: @@ -22675,7 +23290,7 @@ paths: type: integer secrets: type: array - items: &149 + items: &152 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -22746,13 +23361,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: &390 + schema: &393 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -22769,7 +23384,7 @@ paths: - key_id - key examples: - default: &391 + default: &394 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -22792,14 +23407,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 responses: '200': description: Response content: application/json: - schema: *149 + schema: *152 examples: default: value: @@ -22827,8 +23442,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 requestBody: required: true content: @@ -22883,7 +23498,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -22907,8 +23522,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 responses: '204': description: Response @@ -22932,8 +23547,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - *20 - *18 responses: @@ -22951,9 +23566,9 @@ paths: type: integer repositories: type: array - items: *110 + items: *113 examples: - default: *122 + default: *125 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -22974,8 +23589,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 requestBody: required: true content: @@ -23025,8 +23640,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - name: repository_id in: path required: true @@ -23057,8 +23672,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *91 - - *118 + - *94 + - *121 - name: repository_id in: path required: true @@ -23088,7 +23703,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: - - *91 + - *94 responses: '200': description: Response @@ -23096,7 +23711,7 @@ paths: application/json: schema: type: array - items: &184 + items: &187 title: Package description: A software package type: object @@ -23146,8 +23761,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *150 - required: *151 + properties: *153 + required: *154 nullable: true created_at: type: string @@ -23166,7 +23781,7 @@ paths: - created_at - updated_at examples: - default: &185 + default: &188 value: - id: 197 name: hello_docker @@ -23244,7 +23859,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *91 + - *94 - *18 - *20 responses: @@ -23254,7 +23869,7 @@ paths: application/json: schema: type: array - items: *84 + items: *87 examples: 200-response: value: @@ -23323,7 +23938,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *91 + - *94 - *18 - *20 responses: @@ -23333,7 +23948,7 @@ paths: application/json: schema: type: array - items: &163 + items: &166 title: Organization Invitation description: Organization Invitation type: object @@ -23380,7 +23995,7 @@ paths: - invitation_teams_url - node_id examples: - default: &164 + default: &167 value: - id: 1 login: monalisa @@ -23435,7 +24050,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *91 + - *94 - *18 - *20 responses: @@ -23445,7 +24060,7 @@ paths: application/json: schema: type: array - items: &152 + items: &155 title: Org Hook description: Org Hook type: object @@ -23556,7 +24171,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *91 + - *94 requestBody: required: true content: @@ -23616,9 +24231,9 @@ paths: description: Response content: application/json: - schema: *152 + schema: *155 examples: - default: &153 + default: &156 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -23665,8 +24280,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *91 - - &154 + - *94 + - &157 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. @@ -23679,9 +24294,9 @@ paths: description: Response content: application/json: - schema: *152 + schema: *155 examples: - default: *153 + default: *156 '404': *7 x-github: githubCloudOnly: false @@ -23708,8 +24323,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *91 - - *154 + - *94 + - *157 requestBody: required: false content: @@ -23754,7 +24369,7 @@ paths: description: Response content: application/json: - schema: *152 + schema: *155 examples: default: value: @@ -23793,8 +24408,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *91 - - *154 + - *94 + - *157 responses: '204': description: Response @@ -23821,8 +24436,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *91 - - *154 + - *94 + - *157 responses: '200': description: Response @@ -23852,8 +24467,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *91 - - *154 + - *94 + - *157 requestBody: required: false content: @@ -23903,10 +24518,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *91 - - *154 + - *94 + - *157 - *18 - - *155 + - *158 - name: redelivery in: query required: false @@ -23919,9 +24534,9 @@ paths: application/json: schema: type: array - items: *156 + items: *159 examples: - default: *157 + default: *160 '400': *15 '422': *16 x-github: @@ -23946,17 +24561,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *91 - - *154 + - *94 + - *157 - *17 responses: '200': description: Response content: application/json: - schema: *158 + schema: *161 examples: - default: *159 + default: *162 '400': *15 '422': *16 x-github: @@ -23981,11 +24596,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *91 - - *154 + - *94 + - *157 - *17 responses: - '202': *96 + '202': *99 '400': *15 '422': *16 x-github: @@ -24011,8 +24626,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *91 - - *154 + - *94 + - *157 responses: '204': description: Response @@ -24036,7 +24651,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *91 + - *94 responses: '200': description: Response @@ -24044,7 +24659,7 @@ paths: application/json: schema: *22 examples: - default: &429 + default: &432 value: id: 1 account: @@ -24113,7 +24728,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *91 + - *94 - *18 - *20 responses: @@ -24202,7 +24817,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response @@ -24210,12 +24825,12 @@ paths: application/json: schema: anyOf: - - &161 + - &164 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &160 + limit: &163 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -24240,7 +24855,7 @@ paths: properties: {} additionalProperties: false examples: - default: &162 + default: &165 value: limit: collaborators_only origin: organization @@ -24264,18 +24879,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *91 + - *94 requestBody: required: true content: application/json: - schema: &430 + schema: &433 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *160 + limit: *163 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -24299,9 +24914,9 @@ paths: description: Response content: application/json: - schema: *161 + schema: *164 examples: - default: *162 + default: *165 '422': *16 x-github: githubCloudOnly: false @@ -24319,7 +24934,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *91 + - *94 responses: '204': description: Response @@ -24343,7 +24958,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *91 + - *94 - *18 - *20 - name: role @@ -24377,9 +24992,9 @@ paths: application/json: schema: type: array - items: *163 + items: *166 examples: - default: *164 + default: *167 headers: Link: *39 '404': *7 @@ -24402,7 +25017,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *91 + - *94 requestBody: required: false content: @@ -24456,7 +25071,7 @@ paths: description: Response content: application/json: - schema: *163 + schema: *166 examples: default: value: @@ -24510,8 +25125,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *91 - - &165 + - *94 + - &168 name: invitation_id description: The unique identifier of the invitation. in: path @@ -24541,8 +25156,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *91 - - *165 + - *94 + - *168 - *18 - *20 responses: @@ -24552,9 +25167,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - default: &183 + default: &186 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -24599,7 +25214,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *91 + - *94 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -24629,7 +25244,7 @@ paths: - closed - all default: open - - *167 + - *170 - name: sort description: What to sort results by. in: query @@ -24642,7 +25257,7 @@ paths: - comments default: created - *42 - - *62 + - *65 - *18 - *20 responses: @@ -24652,9 +25267,9 @@ paths: application/json: schema: type: array - items: *72 + items: *75 examples: - default: *168 + default: *171 headers: Link: *39 '404': *7 @@ -24676,7 +25291,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *91 + - *94 - 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) @@ -24712,7 +25327,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 '422': *16 @@ -24732,8 +25347,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response if requester is an organization member and user is @@ -24764,8 +25379,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -24791,8 +25406,8 @@ paths: parameters: - *18 - *20 - - *91 - - *123 + - *94 + - *126 responses: '200': description: Response @@ -24808,9 +25423,9 @@ paths: type: integer codespaces: type: array - items: *170 + items: *173 examples: - default: *171 + default: *174 '304': *37 '500': *41 '401': *25 @@ -24835,9 +25450,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *91 - - *123 - - &172 + - *94 + - *126 + - &175 name: codespace_name in: path required: true @@ -24845,7 +25460,7 @@ paths: schema: type: string responses: - '202': *96 + '202': *99 '304': *37 '500': *41 '401': *25 @@ -24870,17 +25485,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *91 - - *123 - - *172 + - *94 + - *126 + - *175 responses: '200': description: Response content: application/json: - schema: *170 + schema: *173 examples: - default: &356 + default: &359 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -25050,14 +25665,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: - - *91 - - *123 + - *94 + - *126 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *136 + schema: *139 examples: default: value: @@ -25125,14 +25740,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - - *91 - - *123 + - *94 + - *126 responses: '200': description: Response content: application/json: - schema: &174 + schema: &177 title: Org Membership description: Org Membership type: object @@ -25161,7 +25776,7 @@ paths: type: string format: uri example: https://api.github.com/orgs/octocat - organization: *173 + organization: *176 user: title: Simple User description: A GitHub user. @@ -25184,7 +25799,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &175 + response-if-user-has-an-active-admin-membership-with-organization: &178 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -25252,8 +25867,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - - *91 - - *123 + - *94 + - *126 requestBody: required: false content: @@ -25281,9 +25896,9 @@ paths: description: Response content: application/json: - schema: *174 + schema: *177 examples: - response-if-user-already-had-membership-with-organization: *175 + response-if-user-already-had-membership-with-organization: *178 '422': *16 '403': *29 x-github: @@ -25304,8 +25919,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -25330,7 +25945,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *91 + - *94 - *18 - *20 - name: exclude @@ -25351,7 +25966,7 @@ paths: application/json: schema: type: array - items: &176 + items: &179 title: Migration description: A migration. type: object @@ -25392,7 +26007,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *55 + items: *58 url: type: string format: uri @@ -25604,7 +26219,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *91 + - *94 requestBody: required: true content: @@ -25680,7 +26295,7 @@ paths: description: Response content: application/json: - schema: *176 + schema: *179 examples: default: value: @@ -25858,8 +26473,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *91 - - &177 + - *94 + - &180 name: migration_id description: The unique identifier of the migration. in: path @@ -25886,7 +26501,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *176 + schema: *179 examples: default: value: @@ -26055,8 +26670,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *91 - - *177 + - *94 + - *180 responses: '302': description: Response @@ -26077,8 +26692,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *91 - - *177 + - *94 + - *180 responses: '204': description: Response @@ -26101,9 +26716,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *91 - - *177 - - &574 + - *94 + - *180 + - &577 name: repo_name description: repo_name parameter in: path @@ -26130,8 +26745,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *91 - - *177 + - *94 + - *180 - *18 - *20 responses: @@ -26141,9 +26756,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: &190 + default: &193 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -26280,7 +26895,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response - list of organization roles @@ -26296,7 +26911,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &180 + items: &183 title: Organization Role description: Organization roles type: object @@ -26423,8 +27038,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *91 - - *178 + - *94 + - *181 responses: '204': description: Response @@ -26449,9 +27064,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *91 - - *178 - - &179 + - *94 + - *181 + - &182 name: role_id description: The unique identifier of the role. in: path @@ -26486,9 +27101,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *91 - - *178 - - *179 + - *94 + - *181 + - *182 responses: '204': description: Response @@ -26513,8 +27128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -26539,9 +27154,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *91 - - *123 - - *179 + - *94 + - *126 + - *182 responses: '204': description: Response @@ -26571,9 +27186,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *91 - - *123 - - *179 + - *94 + - *126 + - *182 responses: '204': description: Response @@ -26601,14 +27216,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *91 - - *179 + - *94 + - *182 responses: '200': description: Response content: application/json: - schema: *180 + schema: *183 examples: default: value: @@ -26658,8 +27273,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: - - *91 - - *179 + - *94 + - *182 - *18 - *20 responses: @@ -26728,8 +27343,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *181 - required: *182 + properties: *184 + required: *185 nullable: true required: - id @@ -26744,7 +27359,7 @@ paths: - slug - parent examples: - default: *183 + default: *186 headers: Link: *39 '404': @@ -26773,8 +27388,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: - - *91 - - *179 + - *94 + - *182 - *18 - *20 responses: @@ -26884,7 +27499,7 @@ paths: - type - url examples: - default: *169 + default: *172 headers: Link: *39 '404': @@ -26908,7 +27523,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *91 + - *94 - 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) @@ -26932,7 +27547,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 x-github: @@ -26957,8 +27572,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *91 - - *123 + - *94 + - *126 requestBody: required: false content: @@ -27015,8 +27630,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -27073,8 +27688,8 @@ paths: - docker - nuget - container - - *91 - - &576 + - *94 + - &579 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -27110,12 +27725,12 @@ paths: application/json: schema: type: array - items: *184 + items: *187 examples: - default: *185 + default: *188 '403': *29 '401': *25 - '400': &578 + '400': &581 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -27137,7 +27752,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &186 + - &189 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 @@ -27155,20 +27770,20 @@ paths: - docker - nuget - container - - &187 + - &190 name: package_name description: The name of the package. in: path required: true schema: type: string - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: *184 + schema: *187 examples: default: value: @@ -27220,9 +27835,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *186 - - *187 - - *91 + - *189 + - *190 + - *94 responses: '204': description: Response @@ -27254,9 +27869,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *186 - - *187 - - *91 + - *189 + - *190 + - *94 - name: token description: package token schema: @@ -27288,9 +27903,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: - - *186 - - *187 - - *91 + - *189 + - *190 + - *94 - *20 - *18 - name: state @@ -27310,7 +27925,7 @@ paths: application/json: schema: type: array - items: &188 + items: &191 title: Package Version description: A version of a software package type: object @@ -27435,10 +28050,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *186 - - *187 - - *91 - - &189 + - *189 + - *190 + - *94 + - &192 name: package_version_id description: Unique identifier of the package version. in: path @@ -27450,7 +28065,7 @@ paths: description: Response content: application/json: - schema: *188 + schema: *191 examples: default: value: @@ -27486,10 +28101,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *186 - - *187 - - *91 - *189 + - *190 + - *94 + - *192 responses: '204': description: Response @@ -27521,10 +28136,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *186 - - *187 - - *91 - *189 + - *190 + - *94 + - *192 responses: '204': description: Response @@ -27551,10 +28166,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: - - *91 + - *94 - *18 - *20 - - &191 + - &194 name: sort description: The property by which to sort the results. in: query @@ -27565,7 +28180,7 @@ paths: - created_at default: created_at - *42 - - &192 + - &195 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -27576,7 +28191,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &193 + - &196 name: repository description: The name of the repository to use to filter the results. in: query @@ -27584,7 +28199,7 @@ paths: schema: type: string example: Hello-World - - &194 + - &197 name: permission description: The permission to use to filter the results. in: query @@ -27592,7 +28207,7 @@ paths: schema: type: string example: issues_read - - &195 + - &198 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) @@ -27602,7 +28217,7 @@ paths: schema: type: string format: date-time - - &196 + - &199 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) @@ -27751,7 +28366,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: - - *91 + - *94 requestBody: required: true content: @@ -27796,7 +28411,7 @@ paths: '422': *16 '404': *7 '403': *29 - '202': *96 + '202': *99 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27817,7 +28432,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: - - *91 + - *94 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -27857,7 +28472,7 @@ paths: '422': *16 '404': *7 '403': *29 - '204': *134 + '204': *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27878,7 +28493,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: - - *91 + - *94 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -27898,9 +28513,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 x-github: @@ -27923,16 +28538,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: - - *91 + - *94 - *18 - *20 - - *191 - - *42 - - *192 - - *193 - *194 + - *42 - *195 - *196 + - *197 + - *198 + - *199 responses: '500': *41 '422': *16 @@ -28067,7 +28682,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: - - *91 + - *94 requestBody: required: true content: @@ -28104,7 +28719,7 @@ paths: responses: '500': *41 '404': *7 - '202': *96 + '202': *99 '403': *29 '422': *16 x-github: @@ -28127,7 +28742,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: - - *91 + - *94 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -28157,7 +28772,7 @@ paths: responses: '500': *41 '404': *7 - '204': *134 + '204': *137 '403': *29 '422': *16 x-github: @@ -28179,7 +28794,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: - - *91 + - *94 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -28198,9 +28813,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 x-github: @@ -28222,7 +28837,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-organization-projects parameters: - - *91 + - *94 - name: state description: Indicates the state of the projects to return. in: query @@ -28243,7 +28858,7 @@ paths: application/json: schema: type: array - items: &197 + items: &200 title: Project description: Projects are a way to organize columns and cards of work. @@ -28387,7 +29002,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#create-an-organization-project parameters: - - *91 + - *94 requestBody: required: true content: @@ -28413,7 +29028,7 @@ paths: description: Response content: application/json: - schema: *197 + schema: *200 examples: default: value: @@ -28451,7 +29066,7 @@ paths: '401': *25 '403': *29 '404': *7 - '410': &248 + '410': &251 description: Gone content: application/json: @@ -28475,7 +29090,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response @@ -28483,7 +29098,7 @@ paths: application/json: schema: type: array - items: &198 + items: &201 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -28542,7 +29157,7 @@ paths: - property_name - value_type examples: - default: &199 + default: &202 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -28583,7 +29198,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *91 + - *94 requestBody: required: true content: @@ -28594,7 +29209,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *198 + items: *201 minItems: 1 maxItems: 100 required: @@ -28624,9 +29239,9 @@ paths: application/json: schema: type: array - items: *198 + items: *201 examples: - default: *199 + default: *202 '403': *29 '404': *7 x-github: @@ -28647,8 +29262,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *91 - - &200 + - *94 + - &203 name: custom_property_name description: The custom property name in: path @@ -28660,9 +29275,9 @@ paths: description: Response content: application/json: - schema: *198 + schema: *201 examples: - default: &201 + default: &204 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -28695,8 +29310,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: - - *91 - - *200 + - *94 + - *203 requestBody: required: true content: @@ -28755,9 +29370,9 @@ paths: description: Response content: application/json: - schema: *198 + schema: *201 examples: - default: *201 + default: *204 '403': *29 '404': *7 x-github: @@ -28780,10 +29395,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *91 - - *200 + - *94 + - *203 responses: - '204': *134 + '204': *137 '403': *29 '404': *7 x-github: @@ -28804,7 +29419,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *91 + - *94 - *18 - *20 - name: repository_query @@ -28842,7 +29457,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &202 + items: &205 title: Custom Property Value description: Custom property name and associated value type: object @@ -28909,7 +29524,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: - - *91 + - *94 requestBody: required: true content: @@ -28929,7 +29544,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *202 + items: *205 required: - repository_names - properties @@ -28970,7 +29585,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *91 + - *94 - *18 - *20 responses: @@ -28982,7 +29597,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 x-github: @@ -29001,8 +29616,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response if user is a public member @@ -29026,8 +29641,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -29048,8 +29663,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *91 - - *123 + - *94 + - *126 responses: '204': description: Response @@ -29073,7 +29688,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *91 + - *94 - name: type description: Specifies the types of repositories you want returned. in: query @@ -29119,9 +29734,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 x-github: @@ -29142,7 +29757,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *91 + - *94 requestBody: required: true content: @@ -29323,7 +29938,7 @@ paths: description: Response content: application/json: - schema: &250 + schema: &253 title: Full Repository description: Full Repository type: object @@ -29600,8 +30215,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *203 - required: *204 + properties: *206 + required: *207 nullable: true temp_clone_token: type: string @@ -29688,8 +30303,8 @@ paths: title: License Simple description: License Simple type: object - properties: *73 - required: *74 + properties: *76 + required: *77 nullable: true organization: title: Simple User @@ -29698,8 +30313,8 @@ paths: properties: *4 required: *5 nullable: true - parent: *55 - source: *55 + parent: *58 + source: *58 forks: type: integer master_branch: @@ -29716,7 +30331,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &378 + properties: &381 url: type: string format: uri @@ -29732,12 +30347,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &379 + required: &382 - url - key - name - html_url - security_and_analysis: *205 + security_and_analysis: *208 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -29821,7 +30436,7 @@ paths: - network_count - subscribers_count examples: - default: &252 + default: &255 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -30339,10 +30954,10 @@ paths: category: orgs subcategory: rules parameters: - - *91 + - *94 - *18 - *20 - - &514 + - &517 name: targets description: | A comma-separated list of rule targets to filter by. @@ -30360,7 +30975,7 @@ paths: application/json: schema: type: array - items: &212 + items: &215 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -30393,7 +31008,7 @@ paths: source: type: string description: The name of the source - enforcement: &208 + enforcement: &211 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -30406,7 +31021,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &209 + items: &212 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -30471,7 +31086,7 @@ paths: conditions: nullable: true anyOf: - - &206 + - &209 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -30495,7 +31110,7 @@ paths: match. items: type: string - - &210 + - &213 title: Organization ruleset conditions type: object description: |- @@ -30508,7 +31123,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *206 + - *209 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -30542,7 +31157,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *206 + - *209 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -30564,7 +31179,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *206 + - *209 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -30577,7 +31192,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &207 + items: &210 title: Repository ruleset property targeting definition type: object @@ -30610,17 +31225,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *207 + items: *210 required: - repository_property rules: type: array - items: &211 + items: &214 title: Repository Rule type: object description: A repository rule. oneOf: - - &496 + - &499 title: creation description: Only allow users with bypass permission to create matching refs. @@ -30632,7 +31247,7 @@ paths: type: string enum: - creation - - &497 + - &500 title: update description: Only allow users with bypass permission to update matching refs. @@ -30653,7 +31268,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &499 + - &502 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -30665,7 +31280,7 @@ paths: type: string enum: - deletion - - &500 + - &503 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -30677,7 +31292,7 @@ paths: type: string enum: - required_linear_history - - &501 + - &504 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -30755,7 +31370,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &502 + - &505 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -30779,7 +31394,7 @@ paths: type: string required: - required_deployment_environments - - &503 + - &506 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -30791,7 +31406,7 @@ paths: type: string enum: - required_signatures - - &504 + - &507 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -30837,7 +31452,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &505 + - &508 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -30885,7 +31500,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &506 + - &509 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -30897,7 +31512,7 @@ paths: type: string enum: - non_fast_forward - - &507 + - &510 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -30933,7 +31548,7 @@ paths: required: - operator - pattern - - &508 + - &511 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -30969,7 +31584,7 @@ paths: required: - operator - pattern - - &509 + - &512 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -31005,7 +31620,7 @@ paths: required: - operator - pattern - - &510 + - &513 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -31041,7 +31656,7 @@ paths: required: - operator - pattern - - &511 + - &514 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -31167,7 +31782,7 @@ paths: maximum: 100 required: - max_file_size - - &512 + - &515 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -31217,7 +31832,7 @@ paths: - repository_id required: - workflows - - &513 + - &516 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -31330,7 +31945,7 @@ paths: category: orgs subcategory: rules parameters: - - *91 + - *94 requestBody: description: Request body required: true @@ -31350,16 +31965,16 @@ paths: - tag - push default: branch - enforcement: *208 + enforcement: *211 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *209 - conditions: *210 + items: *212 + conditions: *213 rules: type: array description: An array of rules within the ruleset. - items: *211 + items: *214 required: - name - enforcement @@ -31397,9 +32012,9 @@ paths: description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: &213 + default: &216 value: id: 21 name: super cool ruleset @@ -31453,8 +32068,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *91 - - &515 + - *94 + - &518 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 @@ -31470,7 +32085,7 @@ paths: in: query schema: type: integer - - &516 + - &519 name: time_period description: |- The time period to filter by. @@ -31486,14 +32101,14 @@ paths: - week - month default: day - - &517 + - &520 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 - - &518 + - &521 name: rule_suite_result description: The rule results to filter on. When specified, only suites with this result will be returned. @@ -31513,7 +32128,7 @@ paths: description: Response content: application/json: - schema: &519 + schema: &522 title: Rule Suites description: Response type: array @@ -31568,7 +32183,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &520 + default: &523 value: - id: 21 actor_id: 12 @@ -31611,8 +32226,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *91 - - &521 + - *94 + - &524 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -31628,7 +32243,7 @@ paths: description: Response content: application/json: - schema: &522 + schema: &525 title: Rule Suite description: Response type: object @@ -31727,7 +32342,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &523 + default: &526 value: id: 21 actor_id: 12 @@ -31788,7 +32403,7 @@ paths: category: orgs subcategory: rules parameters: - - *91 + - *94 - name: ruleset_id description: The ID of the ruleset. in: path @@ -31800,9 +32415,9 @@ paths: description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: *213 + default: *216 '404': *7 '500': *41 put: @@ -31820,7 +32435,7 @@ paths: category: orgs subcategory: rules parameters: - - *91 + - *94 - name: ruleset_id description: The ID of the ruleset. in: path @@ -31845,16 +32460,16 @@ paths: - branch - tag - push - enforcement: *208 + enforcement: *211 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *209 - conditions: *210 + items: *212 + conditions: *213 rules: description: An array of rules within the ruleset. type: array - items: *211 + items: *214 examples: default: value: @@ -31889,9 +32504,9 @@ paths: description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: *213 + default: *216 '404': *7 '500': *41 delete: @@ -31909,7 +32524,7 @@ paths: category: orgs subcategory: rules parameters: - - *91 + - *94 - name: ruleset_id description: The ID of the ruleset. in: path @@ -31937,15 +32552,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *91 - - *214 - - *215 - - *216 + - *94 - *217 + - *218 + - *219 + - *220 - *42 - *20 - *18 - - &525 + - &528 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 @@ -31955,7 +32570,7 @@ paths: required: false schema: type: string - - &526 + - &529 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 @@ -31965,9 +32580,9 @@ paths: required: false schema: type: string - - *218 - - *219 - - *220 + - *221 + - *222 + - *223 responses: '200': description: Response @@ -31975,13 +32590,13 @@ paths: application/json: schema: type: array - items: *221 + items: *224 examples: - default: *222 + default: *225 headers: Link: *39 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32003,7 +32618,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *91 + - *94 - *42 - name: sort description: The property to sort the results by. @@ -32047,7 +32662,7 @@ paths: application/json: schema: type: array - items: &532 + items: &535 description: A repository security advisory. type: object properties: @@ -32267,7 +32882,7 @@ paths: login: type: string description: The username of the user credited. - type: *223 + type: *226 credits_detailed: type: array nullable: true @@ -32277,7 +32892,7 @@ paths: type: object properties: user: *19 - type: *223 + type: *226 state: type: string description: The state of the user's acceptance of the @@ -32301,7 +32916,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *166 + items: *169 private_fork: readOnly: true nullable: true @@ -32338,7 +32953,7 @@ paths: - private_fork additionalProperties: false examples: - default: &533 + default: &536 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -32720,7 +33335,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *91 + - *94 responses: '200': description: Response @@ -32728,15 +33343,15 @@ paths: application/json: schema: type: array - items: &475 + items: &478 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *181 - required: *182 + properties: *184 + required: *185 examples: - default: *183 + default: *186 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32759,8 +33374,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *91 - - *178 + - *94 + - *181 responses: '204': description: Response @@ -32785,8 +33400,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *91 - - *178 + - *94 + - *181 responses: '204': description: Response @@ -32812,13 +33427,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: &592 + schema: &595 type: object properties: total_minutes_used: @@ -32888,7 +33503,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &593 + default: &596 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -32918,13 +33533,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: &594 + schema: &597 type: object properties: total_gigabytes_bandwidth_used: @@ -32942,7 +33557,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &595 + default: &598 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -32968,13 +33583,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: &596 + schema: &599 type: object properties: days_left_in_billing_cycle: @@ -32992,7 +33607,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &597 + default: &600 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -33002,6 +33617,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: + - *94 + - *181 + - 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 + - *20 + - 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: *53 + examples: + default: *54 + '500': *41 + '403': *29 + '404': *7 + '422': *55 + 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 @@ -33030,8 +33714,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: - - *91 - - *178 + - *94 + - *181 - 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`). @@ -33063,9 +33747,9 @@ paths: application/json: schema: type: array - items: *53 + items: *56 examples: - default: *138 + default: *141 '500': *41 '401': *25 '403': *29 @@ -33087,7 +33771,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *91 + - *94 - *18 - *20 responses: @@ -33097,9 +33781,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - default: *183 + default: *186 headers: Link: *39 '403': *29 @@ -33121,7 +33805,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *91 + - *94 requestBody: required: true content: @@ -33193,7 +33877,7 @@ paths: description: Response content: application/json: - schema: &224 + schema: &227 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -33256,8 +33940,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *181 - required: *182 + properties: *184 + required: *185 nullable: true members_count: type: integer @@ -33503,7 +34187,7 @@ paths: - repos_count - organization examples: - default: &225 + default: &228 value: id: 1 node_id: MDQ6VGVhbTE= @@ -33573,16 +34257,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *91 - - *178 + - *94 + - *181 responses: '200': description: Response content: application/json: - schema: *224 + schema: *227 examples: - default: *225 + default: *228 '404': *7 x-github: githubCloudOnly: false @@ -33603,8 +34287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *91 - - *178 + - *94 + - *181 requestBody: required: false content: @@ -33666,16 +34350,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *224 + schema: *227 examples: - default: *225 + default: *228 '201': description: Response content: application/json: - schema: *224 + schema: *227 examples: - default: *225 + default: *228 '404': *7 '422': *16 '403': *29 @@ -33700,8 +34384,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *91 - - *178 + - *94 + - *181 responses: '204': description: Response @@ -33727,8 +34411,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *91 - - *178 + - *94 + - *181 - *42 - *18 - *20 @@ -33745,7 +34429,7 @@ paths: application/json: schema: type: array - items: &226 + items: &229 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -33824,7 +34508,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *59 + reactions: *62 required: - author - body @@ -33844,7 +34528,7 @@ paths: - updated_at - url examples: - default: &547 + default: &550 value: - author: login: octocat @@ -33918,8 +34602,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *91 - - *178 + - *94 + - *181 requestBody: required: true content: @@ -33953,9 +34637,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: &227 + default: &230 value: author: login: octocat @@ -34027,9 +34711,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *91 - - *178 - - &228 + - *94 + - *181 + - &231 name: discussion_number description: The number that identifies the discussion. in: path @@ -34041,9 +34725,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: *227 + default: *230 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34065,9 +34749,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *91 - - *178 - - *228 + - *94 + - *181 + - *231 requestBody: required: false content: @@ -34090,9 +34774,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: &548 + default: &551 value: author: login: octocat @@ -34162,9 +34846,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *91 - - *178 - - *228 + - *94 + - *181 + - *231 responses: '204': description: Response @@ -34190,9 +34874,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *91 - - *178 - - *228 + - *94 + - *181 + - *231 - *42 - *18 - *20 @@ -34203,7 +34887,7 @@ paths: application/json: schema: type: array - items: &229 + items: &232 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -34260,7 +34944,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *59 + reactions: *62 required: - author - body @@ -34275,7 +34959,7 @@ paths: - updated_at - url examples: - default: &549 + default: &552 value: - author: login: octocat @@ -34343,9 +35027,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *91 - - *178 - - *228 + - *94 + - *181 + - *231 requestBody: required: true content: @@ -34367,9 +35051,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *232 examples: - default: &230 + default: &233 value: author: login: octocat @@ -34435,10 +35119,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *91 - - *178 - - *228 - - &231 + - *94 + - *181 + - *231 + - &234 name: comment_number description: The number that identifies the comment. in: path @@ -34450,9 +35134,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *232 examples: - default: *230 + default: *233 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34474,10 +35158,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *91 - - *178 - - *228 + - *94 + - *181 - *231 + - *234 requestBody: required: true content: @@ -34499,9 +35183,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *232 examples: - default: &550 + default: &553 value: author: login: octocat @@ -34565,10 +35249,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *91 - - *178 - - *228 + - *94 + - *181 - *231 + - *234 responses: '204': description: Response @@ -34594,10 +35278,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *91 - - *178 - - *228 + - *94 + - *181 - *231 + - *234 - 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. @@ -34623,7 +35307,7 @@ paths: application/json: schema: type: array - items: &232 + items: &235 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -34666,7 +35350,7 @@ paths: - content - created_at examples: - default: &234 + default: &237 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -34716,10 +35400,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *91 - - *178 - - *228 + - *94 + - *181 - *231 + - *234 requestBody: required: true content: @@ -34752,9 +35436,9 @@ paths: team discussion comment content: application/json: - schema: *232 + schema: *235 examples: - default: &233 + default: &236 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -34783,9 +35467,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34808,11 +35492,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *91 - - *178 - - *228 + - *94 + - *181 - *231 - - &235 + - *234 + - &238 name: reaction_id description: The unique identifier of the reaction. in: path @@ -34844,9 +35528,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *91 - - *178 - - *228 + - *94 + - *181 + - *231 - 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. @@ -34872,9 +35556,9 @@ paths: application/json: schema: type: array - items: *232 + items: *235 examples: - default: *234 + default: *237 headers: Link: *39 x-github: @@ -34900,9 +35584,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *91 - - *178 - - *228 + - *94 + - *181 + - *231 requestBody: required: true content: @@ -34934,16 +35618,16 @@ paths: description: Response content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '201': description: Response content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -34966,10 +35650,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *91 - - *178 - - *228 - - *235 + - *94 + - *181 + - *231 + - *238 responses: '204': description: Response @@ -34993,8 +35677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *91 - - *178 + - *94 + - *181 - *18 - *20 responses: @@ -35004,9 +35688,9 @@ paths: application/json: schema: type: array - items: *163 + items: *166 examples: - default: *164 + default: *167 headers: Link: *39 x-github: @@ -35028,8 +35712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *91 - - *178 + - *94 + - *181 - name: role description: Filters members returned by their role in the team. in: query @@ -35052,7 +35736,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 x-github: @@ -35082,15 +35766,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - - *91 - - *178 - - *123 + - *94 + - *181 + - *126 responses: '200': description: Response content: application/json: - schema: &236 + schema: &239 title: Team Membership description: Team Membership type: object @@ -35117,7 +35801,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &551 + response-if-user-is-a-team-maintainer: &554 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -35153,9 +35837,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *91 - - *178 - - *123 + - *94 + - *181 + - *126 requestBody: required: false content: @@ -35180,9 +35864,9 @@ paths: description: Response content: application/json: - schema: *236 + schema: *239 examples: - response-if-users-membership-with-team-is-now-pending: &552 + response-if-users-membership-with-team-is-now-pending: &555 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -35217,9 +35901,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - - *91 - - *178 - - *123 + - *94 + - *181 + - *126 responses: '204': description: Response @@ -35245,8 +35929,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects parameters: - - *91 - - *178 + - *94 + - *181 - *18 - *20 responses: @@ -35256,7 +35940,7 @@ paths: application/json: schema: type: array - items: &237 + items: &240 title: Team Project description: A team's access to a project. type: object @@ -35324,7 +36008,7 @@ paths: - updated_at - permissions examples: - default: &553 + default: &556 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -35385,9 +36069,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project parameters: - - *91 - - *178 - - &238 + - *94 + - *181 + - &241 name: project_id description: The unique identifier of the project. in: path @@ -35399,9 +36083,9 @@ paths: description: Response content: application/json: - schema: *237 + schema: *240 examples: - default: &554 + default: &557 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -35461,9 +36145,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions parameters: - - *91 - - *178 - - *238 + - *94 + - *181 + - *241 requestBody: required: false content: @@ -35527,9 +36211,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team parameters: - - *91 - - *178 - - *238 + - *94 + - *181 + - *241 responses: '204': description: Response @@ -35553,8 +36237,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *91 - - *178 + - *94 + - *181 - *18 - *20 responses: @@ -35564,9 +36248,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 x-github: @@ -35595,16 +36279,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *91 - - *178 - - *239 - - *240 + - *94 + - *181 + - *242 + - *243 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &555 + schema: &558 title: Team Repository description: A team's access to a repository. type: object @@ -35627,8 +36311,8 @@ paths: title: License Simple description: License Simple type: object - properties: *73 - required: *74 + properties: *76 + required: *77 nullable: true forks: type: integer @@ -36173,10 +36857,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *91 - - *178 - - *239 - - *240 + - *94 + - *181 + - *242 + - *243 requestBody: required: false content: @@ -36221,10 +36905,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *91 - - *178 - - *239 - - *240 + - *94 + - *181 + - *242 + - *243 responses: '204': description: Response @@ -36248,8 +36932,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *91 - - *178 + - *94 + - *181 - *18 - *20 responses: @@ -36259,9 +36943,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - response-if-child-teams-exist: &556 + response-if-child-teams-exist: &559 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -36314,7 +36998,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *91 + - *94 - name: security_product in: path description: The security feature to enable or disable. @@ -36385,7 +37069,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#get-a-project-card parameters: - - &241 + - &244 name: card_id description: The unique identifier of the card. in: path @@ -36397,7 +37081,7 @@ paths: description: Response content: application/json: - schema: &242 + schema: &245 title: Project Card description: Project cards represent a scope of work. type: object @@ -36464,7 +37148,7 @@ paths: - created_at - updated_at examples: - default: &243 + default: &246 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -36514,7 +37198,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#update-an-existing-project-card parameters: - - *241 + - *244 requestBody: required: false content: @@ -36541,9 +37225,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *245 examples: - default: *243 + default: *246 '304': *37 '403': *29 '401': *25 @@ -36564,7 +37248,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#delete-a-project-card parameters: - - *241 + - *244 responses: '204': description: Response @@ -36602,7 +37286,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#move-a-project-card parameters: - - *241 + - *244 requestBody: required: true content: @@ -36707,7 +37391,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#get-a-project-column parameters: - - &244 + - &247 name: column_id description: The unique identifier of the column. in: path @@ -36719,7 +37403,7 @@ paths: description: Response content: application/json: - schema: &245 + schema: &248 title: Project Column description: Project columns contain cards of work. type: object @@ -36765,7 +37449,7 @@ paths: - created_at - updated_at examples: - default: &246 + default: &249 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -36794,7 +37478,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#update-an-existing-project-column parameters: - - *244 + - *247 requestBody: required: true content: @@ -36818,9 +37502,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *248 examples: - default: *246 + default: *249 '304': *37 '403': *29 '401': *25 @@ -36839,7 +37523,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#delete-a-project-column parameters: - - *244 + - *247 responses: '204': description: Response @@ -36862,7 +37546,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#list-project-cards parameters: - - *244 + - *247 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -36883,7 +37567,7 @@ paths: application/json: schema: type: array - items: *242 + items: *245 examples: default: value: @@ -36936,7 +37620,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#create-a-project-card parameters: - - *244 + - *247 requestBody: required: true content: @@ -36976,9 +37660,9 @@ paths: description: Response content: application/json: - schema: *242 + schema: *245 examples: - default: *243 + default: *246 '304': *37 '403': *29 '401': *25 @@ -36988,8 +37672,8 @@ paths: application/json: schema: oneOf: - - *94 - - *95 + - *97 + - *98 '503': description: Response content: @@ -37028,7 +37712,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#move-a-project-column parameters: - - *244 + - *247 requestBody: required: true content: @@ -37084,15 +37768,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-a-project parameters: - - *238 + - *241 responses: '200': description: Response content: application/json: - schema: *197 + schema: *200 examples: - default: &247 + default: &250 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -37145,7 +37829,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#update-a-project parameters: - - *238 + - *241 requestBody: required: false content: @@ -37191,9 +37875,9 @@ paths: description: Response content: application/json: - schema: *197 + schema: *200 examples: - default: *247 + default: *250 '404': description: Not Found if the authenticated user does not have access to the project @@ -37214,7 +37898,7 @@ paths: items: type: string '401': *25 - '410': *248 + '410': *251 '422': *8 x-github: githubCloudOnly: false @@ -37232,7 +37916,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#delete-a-project parameters: - - *238 + - *241 responses: '204': description: Delete Success @@ -37253,7 +37937,7 @@ paths: items: type: string '401': *25 - '410': *248 + '410': *251 '404': *7 x-github: githubCloudOnly: false @@ -37276,7 +37960,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#list-project-collaborators parameters: - - *238 + - *241 - 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 @@ -37303,7 +37987,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 '404': *7 @@ -37328,8 +38012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#add-project-collaborator parameters: - - *238 - - *123 + - *241 + - *126 requestBody: required: false content: @@ -37376,8 +38060,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator parameters: - - *238 - - *123 + - *241 + - *126 responses: '204': description: Response @@ -37405,8 +38089,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user parameters: - - *238 - - *123 + - *241 + - *126 responses: '200': description: Response @@ -37473,7 +38157,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#list-project-columns parameters: - - *238 + - *241 - *18 - *20 responses: @@ -37483,7 +38167,7 @@ paths: application/json: schema: type: array - items: *245 + items: *248 examples: default: value: @@ -37515,7 +38199,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#create-a-project-column parameters: - - *238 + - *241 requestBody: required: true content: @@ -37538,7 +38222,7 @@ paths: description: Response content: application/json: - schema: *245 + schema: *248 examples: default: value: @@ -37599,7 +38283,7 @@ paths: resources: type: object properties: - core: &249 + core: &252 title: Rate Limit type: object properties: @@ -37616,19 +38300,19 @@ paths: - remaining - reset - used - graphql: *249 - search: *249 - code_search: *249 - source_import: *249 - integration_manifest: *249 - code_scanning_upload: *249 - actions_runner_registration: *249 - scim: *249 - dependency_snapshots: *249 + graphql: *252 + search: *252 + code_search: *252 + source_import: *252 + integration_manifest: *252 + code_scanning_upload: *252 + actions_runner_registration: *252 + scim: *252 + dependency_snapshots: *252 required: - core - search - rate: *249 + rate: *252 required: - rate - resources @@ -37727,14 +38411,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *250 + schema: *253 examples: default-response: summary: Default response @@ -38235,7 +38919,7 @@ paths: status: disabled '403': *29 '404': *7 - '301': *251 + '301': *254 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38253,8 +38937,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: false content: @@ -38490,10 +39174,10 @@ paths: description: Response content: application/json: - schema: *250 + schema: *253 examples: - default: *252 - '307': &253 + default: *255 + '307': &256 description: Temporary Redirect content: application/json: @@ -38522,8 +39206,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -38545,7 +39229,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *253 + '307': *256 '404': *7 x-github: githubCloudOnly: false @@ -38568,11 +39252,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 - - &279 + - &282 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -38595,7 +39279,7 @@ paths: type: integer artifacts: type: array - items: &254 + items: &257 title: Artifact description: An artifact type: object @@ -38666,7 +39350,7 @@ paths: - expires_at - updated_at examples: - default: &280 + default: &283 value: total_count: 2 artifacts: @@ -38725,9 +39409,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: - - *239 - - *240 - - &255 + - *242 + - *243 + - &258 name: artifact_id description: The unique identifier of the artifact. in: path @@ -38739,7 +39423,7 @@ paths: description: Response content: application/json: - schema: *254 + schema: *257 examples: default: value: @@ -38776,9 +39460,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: - - *239 - - *240 - - *255 + - *242 + - *243 + - *258 responses: '204': description: Response @@ -38802,9 +39486,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: - - *239 - - *240 - - *255 + - *242 + - *243 + - *258 - name: archive_format in: path required: true @@ -38818,7 +39502,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': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38841,14 +39525,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *256 + schema: *259 examples: default: value: @@ -38874,11 +39558,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 - - &257 + - &260 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 @@ -38912,7 +39596,7 @@ paths: description: Response content: application/json: - schema: &258 + schema: &261 title: Repository actions caches description: Repository actions caches type: object @@ -38954,7 +39638,7 @@ paths: - total_count - actions_caches examples: - default: &259 + default: &262 value: total_count: 1 actions_caches: @@ -38986,23 +39670,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: - - *239 - - *240 + - *242 + - *243 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *257 + - *260 responses: '200': description: Response content: application/json: - schema: *258 + schema: *261 examples: - default: *259 + default: *262 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39022,8 +39706,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: - - *239 - - *240 + - *242 + - *243 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -39054,9 +39738,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: - - *239 - - *240 - - &260 + - *242 + - *243 + - &263 name: job_id description: The unique identifier of the job. in: path @@ -39068,7 +39752,7 @@ paths: description: Response content: application/json: - schema: &283 + schema: &286 title: Job description: Information of a job execution in a workflow run type: object @@ -39375,9 +40059,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: - - *239 - - *240 - - *260 + - *242 + - *243 + - *263 responses: '302': description: Response @@ -39405,9 +40089,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: - - *239 - - *240 - - *260 + - *242 + - *243 + - *263 requestBody: required: false content: @@ -39428,7 +40112,7 @@ paths: description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -39452,8 +40136,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: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Status response @@ -39503,8 +40187,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: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -39538,7 +40222,7 @@ paths: description: Empty response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -39567,8 +40251,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -39586,7 +40270,7 @@ paths: type: integer secrets: type: array - items: &285 + items: &288 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -39606,7 +40290,7 @@ paths: - created_at - updated_at examples: - default: &286 + default: &289 value: total_count: 2 secrets: @@ -39639,9 +40323,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: - - *239 - - *240 - - *261 + - *242 + - *243 + - *264 - *20 responses: '200': @@ -39658,7 +40342,7 @@ paths: type: integer variables: type: array - items: &289 + items: &292 title: Actions Variable type: object properties: @@ -39688,7 +40372,7 @@ paths: - created_at - updated_at examples: - default: &290 + default: &293 value: total_count: 2 variables: @@ -39721,8 +40405,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -39731,11 +40415,11 @@ paths: schema: type: object properties: - enabled: &263 + enabled: &266 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *100 - selected_actions_url: *262 + allowed_actions: *103 + selected_actions_url: *265 required: - enabled examples: @@ -39762,8 +40446,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -39774,8 +40458,8 @@ paths: schema: type: object properties: - enabled: *263 - allowed_actions: *100 + enabled: *266 + allowed_actions: *103 required: - enabled examples: @@ -39804,14 +40488,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: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: &264 + schema: &267 type: object properties: access_level: @@ -39828,7 +40512,7 @@ paths: required: - access_level examples: - default: &265 + default: &268 value: access_level: organization x-github: @@ -39852,15 +40536,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: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: application/json: - schema: *264 + schema: *267 examples: - default: *265 + default: *268 responses: '204': description: Response @@ -39884,16 +40568,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *102 + schema: *105 examples: - default: *103 + default: *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -39912,8 +40596,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -39921,9 +40605,9 @@ paths: required: false content: application/json: - schema: *102 + schema: *105 examples: - selected_actions: *103 + selected_actions: *106 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -39945,16 +40629,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *266 + schema: *269 examples: - default: *106 + default: *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39975,8 +40659,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Success response @@ -39987,9 +40671,9 @@ paths: required: true content: application/json: - schema: *267 + schema: *270 examples: - default: *106 + default: *109 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40016,8 +40700,8 @@ paths: in: query schema: type: string - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -40035,9 +40719,9 @@ paths: type: integer runners: type: array - items: *112 + items: *115 examples: - default: *113 + default: *116 headers: Link: *39 x-github: @@ -40061,8 +40745,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -40070,9 +40754,9 @@ paths: application/json: schema: type: array - items: *268 + items: *271 examples: - default: *269 + default: *272 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40094,8 +40778,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: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -40138,7 +40822,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *270 + '201': *273 '404': *7 '422': *8 x-github: @@ -40168,16 +40852,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '201': description: Response content: application/json: - schema: *114 + schema: *117 examples: - default: *271 + default: *274 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40205,16 +40889,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '201': description: Response content: application/json: - schema: *114 + schema: *117 examples: - default: *272 + default: *275 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40236,17 +40920,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: - - *239 - - *240 - - *111 + - *242 + - *243 + - *114 responses: '200': description: Response content: application/json: - schema: *112 + schema: *115 examples: - default: *273 + default: *276 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40267,9 +40951,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: - - *239 - - *240 - - *111 + - *242 + - *243 + - *114 responses: '204': description: Response @@ -40294,11 +40978,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: - - *239 - - *240 - - *111 + - *242 + - *243 + - *114 responses: - '200': *116 + '200': *119 '404': *7 x-github: githubCloudOnly: false @@ -40320,9 +41004,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: - - *239 - - *240 - - *111 + - *242 + - *243 + - *114 requestBody: required: true content: @@ -40346,7 +41030,7 @@ paths: - gpu - accelerated responses: - '200': *116 + '200': *119 '404': *7 '422': *8 x-github: @@ -40370,9 +41054,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: - - *239 - - *240 - - *111 + - *242 + - *243 + - *114 requestBody: required: true content: @@ -40397,7 +41081,7 @@ paths: - gpu - accelerated responses: - '200': *116 + '200': *119 '404': *7 '422': *8 x-github: @@ -40421,11 +41105,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: - - *239 - - *240 - - *111 + - *242 + - *243 + - *114 responses: - '200': *274 + '200': *277 '404': *7 x-github: githubCloudOnly: false @@ -40452,12 +41136,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: - - *239 - - *240 - - *111 - - *275 + - *242 + - *243 + - *114 + - *278 responses: - '200': *116 + '200': *119 '404': *7 '422': *8 x-github: @@ -40483,9 +41167,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: - - *239 - - *240 - - &293 + - *242 + - *243 + - &296 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. @@ -40493,7 +41177,7 @@ paths: required: false schema: type: string - - &294 + - &297 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -40501,7 +41185,7 @@ paths: required: false schema: type: string - - &295 + - &298 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -40510,7 +41194,7 @@ paths: required: false schema: type: string - - &296 + - &299 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 @@ -40537,7 +41221,7 @@ paths: - pending - *18 - *20 - - &297 + - &300 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)." @@ -40546,7 +41230,7 @@ paths: schema: type: string format: date-time - - &276 + - &279 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -40555,13 +41239,13 @@ paths: schema: type: boolean default: false - - &298 + - &301 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &299 + - &302 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -40584,7 +41268,7 @@ paths: type: integer workflow_runs: type: array - items: &277 + items: &280 title: Workflow Run description: An invocation of a workflow type: object @@ -40679,7 +41363,7 @@ paths: that triggered the run. type: array nullable: true - items: &318 + items: &321 title: Pull Request Minimal type: object properties: @@ -40798,7 +41482,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &322 + properties: &325 id: type: string description: SHA for the commit @@ -40849,7 +41533,7 @@ paths: - name - email nullable: true - required: &323 + required: &326 - id - tree_id - message @@ -40857,8 +41541,8 @@ paths: - author - committer nullable: true - repository: *110 - head_repository: *110 + repository: *113 + head_repository: *113 head_repository_id: type: integer example: 5 @@ -40896,7 +41580,7 @@ paths: - workflow_url - pull_requests examples: - default: &300 + default: &303 value: total_count: 1 workflow_runs: @@ -41132,24 +41816,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: - - *239 - - *240 - - &278 + - *242 + - *243 + - &281 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *276 + - *279 responses: '200': description: Response content: application/json: - schema: *277 + schema: *280 examples: - default: &281 + default: &284 value: id: 30433642 name: Build @@ -41390,9 +42074,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '204': description: Response @@ -41415,9 +42099,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '200': description: Response @@ -41536,15 +42220,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: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '201': description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -41571,12 +42255,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 - *18 - *20 - - *279 + - *282 responses: '200': description: Response @@ -41592,9 +42276,9 @@ paths: type: integer artifacts: type: array - items: *254 + items: *257 examples: - default: *280 + default: *283 headers: Link: *39 x-github: @@ -41618,25 +42302,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *239 - - *240 - - *278 - - &282 + - *242 + - *243 + - *281 + - &285 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *276 + - *279 responses: '200': description: Response content: application/json: - schema: *277 + schema: *280 examples: - default: *281 + default: *284 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41659,10 +42343,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: - - *239 - - *240 - - *278 - - *282 + - *242 + - *243 + - *281 + - *285 - *18 - *20 responses: @@ -41680,9 +42364,9 @@ paths: type: integer jobs: type: array - items: *283 + items: *286 examples: - default: &284 + default: &287 value: total_count: 1 jobs: @@ -41795,10 +42479,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *239 - - *240 - - *278 - - *282 + - *242 + - *243 + - *281 + - *285 responses: '302': description: Response @@ -41826,19 +42510,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '202': description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41861,9 +42545,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: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 requestBody: required: true content: @@ -41930,19 +42614,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '202': description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41965,9 +42649,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 - 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 @@ -41997,9 +42681,9 @@ paths: type: integer jobs: type: array - items: *283 + items: *286 examples: - default: *284 + default: *287 headers: Link: *39 x-github: @@ -42024,9 +42708,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '302': description: Response @@ -42053,9 +42737,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '204': description: Response @@ -42082,9 +42766,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '200': description: Response @@ -42144,7 +42828,7 @@ paths: items: type: object properties: - type: &399 + type: &402 type: string description: The type of reviewer. enum: @@ -42154,7 +42838,7 @@ paths: reviewer: anyOf: - *19 - - *166 + - *169 required: - environment - wait_timer @@ -42229,9 +42913,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 requestBody: required: true content: @@ -42278,7 +42962,7 @@ paths: application/json: schema: type: array - items: &394 + items: &397 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -42366,8 +43050,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 required: - id - node_id @@ -42384,7 +43068,7 @@ paths: - created_at - updated_at examples: - default: &395 + default: &398 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -42440,9 +43124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 requestBody: required: false content: @@ -42463,7 +43147,7 @@ paths: description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -42486,9 +43170,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 requestBody: required: false content: @@ -42509,7 +43193,7 @@ paths: description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -42534,9 +43218,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *239 - - *240 - - *278 + - *242 + - *243 + - *281 responses: '200': description: Response @@ -42673,8 +43357,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -42692,9 +43376,9 @@ paths: type: integer secrets: type: array - items: *285 + items: *288 examples: - default: *286 + default: *289 headers: Link: *39 x-github: @@ -42719,16 +43403,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *287 + schema: *290 examples: - default: *288 + default: *291 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42750,17 +43434,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 responses: '200': description: Response content: application/json: - schema: *285 + schema: *288 examples: - default: &412 + default: &415 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -42786,9 +43470,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 requestBody: required: true content: @@ -42816,7 +43500,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -42842,9 +43526,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 responses: '204': description: Response @@ -42869,9 +43553,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: - - *239 - - *240 - - *261 + - *242 + - *243 + - *264 - *20 responses: '200': @@ -42888,9 +43572,9 @@ paths: type: integer variables: type: array - items: *289 + items: *292 examples: - default: *290 + default: *293 headers: Link: *39 x-github: @@ -42913,8 +43597,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -42941,7 +43625,7 @@ paths: description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -42966,17 +43650,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: - - *239 - - *240 - - *121 + - *242 + - *243 + - *124 responses: '200': description: Response content: application/json: - schema: *289 + schema: *292 examples: - default: &413 + default: &416 value: name: USERNAME value: octocat @@ -43002,9 +43686,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: - - *239 - - *240 - - *121 + - *242 + - *243 + - *124 requestBody: required: true content: @@ -43046,9 +43730,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: - - *239 - - *240 - - *121 + - *242 + - *243 + - *124 responses: '204': description: Response @@ -43073,8 +43757,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -43092,7 +43776,7 @@ paths: type: integer workflows: type: array - items: &291 + items: &294 title: Workflow description: A GitHub Actions workflow type: object @@ -43199,9 +43883,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: - - *239 - - *240 - - &292 + - *242 + - *243 + - &295 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -43216,7 +43900,7 @@ paths: description: Response content: application/json: - schema: *291 + schema: *294 examples: default: value: @@ -43249,9 +43933,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: - - *239 - - *240 - - *292 + - *242 + - *243 + - *295 responses: '204': description: Response @@ -43276,9 +43960,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *239 - - *240 - - *292 + - *242 + - *243 + - *295 responses: '204': description: Response @@ -43329,9 +44013,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: - - *239 - - *240 - - *292 + - *242 + - *243 + - *295 responses: '204': description: Response @@ -43356,19 +44040,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: - - *239 - - *240 - - *292 - - *293 - - *294 + - *242 + - *243 - *295 - *296 - - *18 - - *20 - *297 - - *276 - *298 - *299 + - *18 + - *20 + - *300 + - *279 + - *301 + - *302 responses: '200': description: Response @@ -43384,9 +44068,9 @@ paths: type: integer workflow_runs: type: array - items: *277 + items: *280 examples: - default: *300 + default: *303 headers: Link: *39 x-github: @@ -43412,9 +44096,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: - - *239 - - *240 - - *292 + - *242 + - *243 + - *295 responses: '200': description: Response @@ -43475,8 +44159,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: - - *239 - - *240 + - *242 + - *243 - *42 - *18 - *43 @@ -43640,8 +44324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -43653,7 +44337,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 '404': *7 @@ -43678,8 +44362,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: - - *239 - - *240 + - *242 + - *243 - name: assignee in: path required: true @@ -43715,8 +44399,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -43828,8 +44512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *43 - *44 @@ -43873,7 +44557,7 @@ paths: repository_id: type: integer examples: - default: *301 + default: *304 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43893,8 +44577,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -43902,7 +44586,7 @@ paths: application/json: schema: type: array - items: &302 + items: &305 title: Autolink reference description: An autolink reference. type: object @@ -43952,8 +44636,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -43992,9 +44676,9 @@ paths: description: response content: application/json: - schema: *302 + schema: *305 examples: - default: &303 + default: &306 value: id: 1 key_prefix: TICKET- @@ -44025,9 +44709,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: - - *239 - - *240 - - &304 + - *242 + - *243 + - &307 name: autolink_id description: The unique identifier of the autolink. in: path @@ -44039,9 +44723,9 @@ paths: description: Response content: application/json: - schema: *302 + schema: *305 examples: - default: *303 + default: *306 '404': *7 x-github: githubCloudOnly: false @@ -44061,9 +44745,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: - - *239 - - *240 - - *304 + - *242 + - *243 + - *307 responses: '204': description: Response @@ -44087,8 +44771,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: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response if Dependabot is enabled @@ -44136,8 +44820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-automated-security-fixes parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -44158,8 +44842,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-automated-security-fixes parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -44179,8 +44863,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: - - *239 - - *240 + - *242 + - *243 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -44218,7 +44902,7 @@ paths: - url protected: type: boolean - protection: &306 + protection: &309 title: Branch Protection description: Branch Protection type: object @@ -44260,7 +44944,7 @@ paths: required: - contexts - checks - enforce_admins: &309 + enforce_admins: &312 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -44275,7 +44959,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &311 + required_pull_request_reviews: &314 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -44296,7 +44980,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *166 + items: *169 apps: description: The list of apps with review dismissal access. @@ -44325,7 +45009,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *166 + items: *169 apps: description: The list of apps allowed to bypass pull request requirements. @@ -44351,7 +45035,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &308 + restrictions: &311 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -44658,9 +45342,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: - - *239 - - *240 - - &307 + - *242 + - *243 + - &310 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). @@ -44674,14 +45358,14 @@ paths: description: Response content: application/json: - schema: &317 + schema: &320 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &367 + commit: &370 title: Commit description: Commit type: object @@ -44715,7 +45399,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &305 + properties: &308 name: type: string example: '"Chris Wanstrath"' @@ -44730,7 +45414,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *305 + properties: *308 nullable: true message: type: string @@ -44751,7 +45435,7 @@ paths: required: - sha - url - verification: &419 + verification: &422 title: Verification type: object properties: @@ -44781,12 +45465,12 @@ paths: nullable: true oneOf: - *19 - - *119 + - *122 committer: nullable: true oneOf: - *19 - - *119 + - *122 parents: type: array items: @@ -44817,7 +45501,7 @@ paths: type: integer files: type: array - items: &382 + items: &385 title: Diff Entry description: Diff Entry type: object @@ -44900,7 +45584,7 @@ paths: - self protected: type: boolean - protection: *306 + protection: *309 protection_url: type: string format: uri @@ -45006,7 +45690,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *251 + '301': *254 '404': *7 x-github: githubCloudOnly: false @@ -45028,15 +45712,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response content: application/json: - schema: *306 + schema: *309 examples: default: value: @@ -45230,9 +45914,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: true content: @@ -45487,7 +46171,7 @@ paths: url: type: string format: uri - required_status_checks: &314 + required_status_checks: &317 title: Status Check Policy description: Status Check Policy type: object @@ -45563,7 +46247,7 @@ paths: items: *19 teams: type: array - items: *166 + items: *169 apps: type: array items: *6 @@ -45581,7 +46265,7 @@ paths: items: *19 teams: type: array - items: *166 + items: *169 apps: type: array items: *6 @@ -45639,7 +46323,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *308 + restrictions: *311 required_conversation_resolution: type: object properties: @@ -45751,9 +46435,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '204': description: Response @@ -45778,17 +46462,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response content: application/json: - schema: *309 + schema: *312 examples: - default: &310 + default: &313 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -45810,17 +46494,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response content: application/json: - schema: *309 + schema: *312 examples: - default: *310 + default: *313 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45839,9 +46523,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '204': description: Response @@ -45866,17 +46550,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response content: application/json: - schema: *311 + schema: *314 examples: - default: &312 + default: &315 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -45972,9 +46656,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: false content: @@ -46072,9 +46756,9 @@ paths: description: Response content: application/json: - schema: *311 + schema: *314 examples: - default: *312 + default: *315 '422': *16 x-github: githubCloudOnly: false @@ -46095,9 +46779,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '204': description: Response @@ -46124,17 +46808,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response content: application/json: - schema: *309 + schema: *312 examples: - default: &313 + default: &316 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -46157,17 +46841,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response content: application/json: - schema: *309 + schema: *312 examples: - default: *313 + default: *316 '404': *7 x-github: githubCloudOnly: false @@ -46187,9 +46871,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '204': description: Response @@ -46214,17 +46898,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response content: application/json: - schema: *314 + schema: *317 examples: - default: &315 + default: &318 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -46250,9 +46934,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: false content: @@ -46304,9 +46988,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *317 examples: - default: *315 + default: *318 '404': *7 '422': *16 x-github: @@ -46328,9 +47012,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '204': description: Response @@ -46354,9 +47038,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response @@ -46390,9 +47074,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: false content: @@ -46459,9 +47143,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: false content: @@ -46525,9 +47209,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: content: application/json: @@ -46593,15 +47277,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response content: application/json: - schema: *308 + schema: *311 examples: default: value: @@ -46692,9 +47376,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '204': description: Response @@ -46717,9 +47401,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response @@ -46729,7 +47413,7 @@ paths: type: array items: *6 examples: - default: &316 + default: &319 value: - id: 1 slug: octoapp @@ -46786,9 +47470,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: true content: @@ -46822,7 +47506,7 @@ paths: type: array items: *6 examples: - default: *316 + default: *319 '422': *16 x-github: githubCloudOnly: false @@ -46843,9 +47527,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: true content: @@ -46879,7 +47563,7 @@ paths: type: array items: *6 examples: - default: *316 + default: *319 '422': *16 x-github: githubCloudOnly: false @@ -46900,9 +47584,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: true content: @@ -46936,7 +47620,7 @@ paths: type: array items: *6 examples: - default: *316 + default: *319 '422': *16 x-github: githubCloudOnly: false @@ -46958,9 +47642,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response @@ -46968,9 +47652,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - default: *183 + default: *186 '404': *7 x-github: githubCloudOnly: false @@ -46990,9 +47674,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: false content: @@ -47028,9 +47712,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - default: *183 + default: *186 '422': *16 x-github: githubCloudOnly: false @@ -47051,9 +47735,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: false content: @@ -47089,9 +47773,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - default: *183 + default: *186 '422': *16 x-github: githubCloudOnly: false @@ -47112,9 +47796,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: content: application/json: @@ -47149,9 +47833,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - default: *183 + default: *186 '422': *16 x-github: githubCloudOnly: false @@ -47173,9 +47857,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 responses: '200': description: Response @@ -47185,7 +47869,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 '404': *7 x-github: githubCloudOnly: false @@ -47209,9 +47893,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: true content: @@ -47244,7 +47928,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 '422': *16 x-github: githubCloudOnly: false @@ -47269,9 +47953,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: true content: @@ -47304,7 +47988,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 '422': *16 x-github: githubCloudOnly: false @@ -47329,9 +48013,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: true content: @@ -47364,7 +48048,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 '422': *16 x-github: githubCloudOnly: false @@ -47391,9 +48075,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 requestBody: required: true content: @@ -47415,7 +48099,7 @@ paths: description: Response content: application/json: - schema: *317 + schema: *320 examples: default: value: @@ -47530,8 +48214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -47810,7 +48494,7 @@ paths: description: Response content: application/json: - schema: &319 + schema: &322 title: CheckRun description: A check performed on the code of a given code change type: object @@ -47921,16 +48605,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *318 - deployment: &606 + items: *321 + deployment: &609 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -47997,8 +48681,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 required: - id - node_id @@ -48210,9 +48894,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: - - *239 - - *240 - - &320 + - *242 + - *243 + - &323 name: check_run_id description: The unique identifier of the check run. in: path @@ -48224,9 +48908,9 @@ paths: description: Response content: application/json: - schema: *319 + schema: *322 examples: - default: &321 + default: &324 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -48326,9 +49010,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: - - *239 - - *240 - - *320 + - *242 + - *243 + - *323 requestBody: required: true content: @@ -48568,9 +49252,9 @@ paths: description: Response content: application/json: - schema: *319 + schema: *322 examples: - default: *321 + default: *324 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48590,9 +49274,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: - - *239 - - *240 - - *320 + - *242 + - *243 + - *323 - *18 - *20 responses: @@ -48689,15 +49373,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: - - *239 - - *240 - - *320 + - *242 + - *243 + - *323 responses: '201': description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -48735,8 +49419,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -48758,7 +49442,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &324 + schema: &327 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -48821,7 +49505,7 @@ paths: nullable: true pull_requests: type: array - items: *318 + items: *321 nullable: true app: title: GitHub app @@ -48832,9 +49516,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 - repository: *110 + properties: *59 + required: *60 + repository: *113 created_at: type: string format: date-time @@ -48843,12 +49527,12 @@ paths: type: string format: date-time nullable: true - head_commit: &632 + head_commit: &635 title: Simple Commit description: A commit. type: object - properties: *322 - required: *323 + properties: *325 + required: *326 latest_check_runs_count: type: integer check_runs_url: @@ -48876,7 +49560,7 @@ paths: - check_runs_url - pull_requests examples: - default: &325 + default: &328 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -49167,9 +49851,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *324 + schema: *327 examples: - default: *325 + default: *328 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49188,8 +49872,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -49250,7 +49934,7 @@ paths: required: - app_id - setting - repository: *110 + repository: *113 examples: default: value: @@ -49498,9 +50182,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: - - *239 - - *240 - - &326 + - *242 + - *243 + - &329 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -49512,9 +50196,9 @@ paths: description: Response content: application/json: - schema: *324 + schema: *327 examples: - default: *325 + default: *328 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49537,17 +50221,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: - - *239 - - *240 - - *326 - - &375 + - *242 + - *243 + - *329 + - &378 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &376 + - &379 name: status description: Returns check runs with the specified `status`. in: query @@ -49586,9 +50270,9 @@ paths: type: integer check_runs: type: array - items: *319 + items: *322 examples: - default: &377 + default: &380 value: total_count: 1 check_runs: @@ -49690,15 +50374,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: - - *239 - - *240 - - *326 + - *242 + - *243 + - *329 responses: '201': description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -49725,21 +50409,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: - - *239 - - *240 - - *327 - - *328 + - *242 + - *243 + - *330 + - *331 - *20 - *18 - - &341 + - &344 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: *329 - - &342 + schema: *332 + - &345 name: pr description: The number of the pull request for the results you want to list. in: query @@ -49764,13 +50448,13 @@ paths: be returned. in: query required: false - schema: *330 + schema: *333 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *331 + schema: *334 responses: '200': description: Response @@ -49783,12 +50467,12 @@ paths: properties: number: *48 created_at: *49 - updated_at: *124 + updated_at: *127 url: *50 html_url: *51 - instances_url: *332 - state: *129 - fixed_at: *125 + instances_url: *335 + state: *132 + fixed_at: *128 dismissed_by: title: Simple User description: A GitHub user. @@ -49796,12 +50480,12 @@ paths: properties: *4 required: *5 nullable: true - dismissed_at: *126 - dismissed_reason: *333 - dismissed_comment: *334 - rule: *335 - tool: *336 - most_recent_instance: *337 + dismissed_at: *129 + dismissed_reason: *336 + dismissed_comment: *337 + rule: *338 + tool: *339 + most_recent_instance: *340 required: - number - created_at @@ -49917,14 +50601,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &338 + '403': &341 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49944,9 +50628,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: - - *239 - - *240 - - &339 + - *242 + - *243 + - &342 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -49960,17 +50644,17 @@ paths: description: Response content: application/json: - schema: &340 + schema: &343 type: object properties: number: *48 created_at: *49 - updated_at: *124 + updated_at: *127 url: *50 html_url: *51 - instances_url: *332 - state: *129 - fixed_at: *125 + instances_url: *335 + state: *132 + fixed_at: *128 dismissed_by: title: Simple User description: A GitHub user. @@ -49978,9 +50662,9 @@ paths: properties: *4 required: *5 nullable: true - dismissed_at: *126 - dismissed_reason: *333 - dismissed_comment: *334 + dismissed_at: *129 + dismissed_reason: *336 + dismissed_comment: *337 rule: type: object properties: @@ -50034,8 +50718,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *336 - most_recent_instance: *337 + tool: *339 + most_recent_instance: *340 required: - number - created_at @@ -50124,9 +50808,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *338 + '403': *341 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50144,9 +50828,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: - - *239 - - *240 - - *339 + - *242 + - *243 + - *342 requestBody: required: true content: @@ -50161,8 +50845,8 @@ paths: enum: - open - dismissed - dismissed_reason: *333 - dismissed_comment: *334 + dismissed_reason: *336 + dismissed_comment: *337 required: - state examples: @@ -50177,7 +50861,7 @@ paths: description: Response content: application/json: - schema: *340 + schema: *343 examples: default: value: @@ -50252,14 +50936,14 @@ paths: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '403': &347 + '403': &350 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *7 - '503': *60 + '503': *63 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50279,13 +50963,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: - - *239 - - *240 - - *339 + - *242 + - *243 + - *342 - *20 - *18 - - *341 - - *342 + - *344 + - *345 responses: '200': description: Response @@ -50293,7 +50977,7 @@ paths: application/json: schema: type: array - items: *337 + items: *340 examples: default: value: @@ -50332,9 +51016,9 @@ paths: end_column: 50 classifications: - source - '403': *338 + '403': *341 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50366,25 +51050,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: - - *239 - - *240 - - *327 - - *328 + - *242 + - *243 + - *330 + - *331 - *20 - *18 - - *342 + - *345 - 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: *329 + schema: *332 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &345 + schema: &348 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -50405,23 +51089,23 @@ paths: application/json: schema: type: array - items: &346 + items: &349 type: object properties: - ref: *329 - commit_sha: &355 + ref: *332 + commit_sha: &358 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: *343 + analysis_key: *346 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *344 + category: *347 error: type: string example: error reading field xyz @@ -50445,8 +51129,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *345 - tool: *336 + sarif_id: *348 + tool: *339 deletable: type: boolean warning: @@ -50507,9 +51191,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *338 + '403': *341 '404': *7 - '503': *60 + '503': *63 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50543,8 +51227,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: - - *239 - - *240 + - *242 + - *243 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -50557,7 +51241,7 @@ paths: description: Response content: application/json: - schema: *346 + schema: *349 examples: response: summary: application/json response @@ -50611,9 +51295,9 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *338 + '403': *341 '404': *7 - '503': *60 + '503': *63 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50693,8 +51377,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: - - *239 - - *240 + - *242 + - *243 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -50747,9 +51431,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': *15 - '403': *347 + '403': *350 '404': *7 - '503': *60 + '503': *63 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -50769,8 +51453,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -50778,7 +51462,7 @@ paths: application/json: schema: type: array - items: &348 + items: &351 title: CodeQL Database description: A CodeQL database. type: object @@ -50889,9 +51573,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': *338 + '403': *341 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50918,8 +51602,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 - name: language in: path description: The language of the CodeQL database. @@ -50931,7 +51615,7 @@ paths: description: Response content: application/json: - schema: *348 + schema: *351 examples: default: value: @@ -50963,11 +51647,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': &384 + '302': &387 description: Found - '403': *338 + '403': *341 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50993,8 +51677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -51003,7 +51687,7 @@ paths: type: object additionalProperties: false properties: - language: &349 + language: &352 type: string description: The language targeted by the CodeQL query enum: @@ -51081,7 +51765,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &353 + schema: &356 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -51091,7 +51775,7 @@ paths: description: The ID of the variant analysis. controller_repo: *52 actor: *19 - query_language: *349 + query_language: *352 query_pack_url: type: string description: The download url for the query pack. @@ -51138,7 +51822,7 @@ paths: items: type: object properties: - repository: &350 + repository: &353 title: Repository Identifier description: Repository Identifier type: object @@ -51174,7 +51858,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &354 + analysis_status: &357 type: string description: The new status of the CodeQL variant analysis repository task. @@ -51206,7 +51890,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &351 + access_mismatch_repos: &354 type: object properties: repository_count: @@ -51220,7 +51904,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: *350 + items: *353 required: - repository_count - repositories @@ -51242,8 +51926,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *351 - over_limit_repos: *351 + no_codeql_db_repos: *354 + over_limit_repos: *354 required: - access_mismatch_repos - not_found_repos @@ -51259,7 +51943,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &352 + value: &355 summary: Default response value: id: 1 @@ -51411,17 +52095,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *352 + value: *355 repository_lists: summary: Response for a successful variant analysis submission - value: *352 + value: *355 '404': *7 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51442,8 +52126,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: - - *239 - - *240 + - *242 + - *243 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -51455,11 +52139,11 @@ paths: description: Response content: application/json: - schema: *353 + schema: *356 examples: - default: *352 + default: *355 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51480,7 +52164,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: - - *239 + - *242 - name: repo in: path description: The name of the controller repository. @@ -51515,7 +52199,7 @@ paths: type: object properties: repository: *52 - analysis_status: *354 + analysis_status: *357 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -51619,7 +52303,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51640,8 +52324,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -51702,9 +52386,9 @@ paths: query_suite: default updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *338 + '403': *341 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51723,8 +52407,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -51769,7 +52453,7 @@ paths: description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -51794,7 +52478,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *347 + '403': *350 '404': *7 '409': description: Response if there is already a validation run in progress with @@ -51802,7 +52486,7 @@ paths: content: application/json: schema: *3 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51859,8 +52543,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -51868,7 +52552,7 @@ paths: schema: type: object properties: - commit_sha: *355 + commit_sha: *358 ref: type: string description: |- @@ -51926,7 +52610,7 @@ paths: schema: type: object properties: - id: *345 + id: *348 url: type: string description: The REST API URL for checking the status of the upload. @@ -51940,11 +52624,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': *347 + '403': *350 '404': *7 '413': description: Payload Too Large if the sarif field is too large - '503': *60 + '503': *63 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -51963,8 +52647,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: - - *239 - - *240 + - *242 + - *243 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -52010,10 +52694,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': *338 + '403': *341 '404': description: Not Found if the sarif id does not match any upload - '503': *60 + '503': *63 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -52035,8 +52719,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: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -52060,7 +52744,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *130 + configuration: *133 examples: default: value: @@ -52089,7 +52773,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': *134 + '204': *137 '304': *37 '403': *29 '404': *7 @@ -52114,8 +52798,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: - - *239 - - *240 + - *242 + - *243 - 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 @@ -52235,8 +52919,8 @@ paths: parameters: - *18 - *20 - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -52252,7 +52936,7 @@ paths: type: integer codespaces: type: array - items: *170 + items: *173 examples: default: value: @@ -52550,8 +53234,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -52614,22 +53298,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '400': *15 '401': *25 '403': *29 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -52653,8 +53337,8 @@ paths: parameters: - *18 - *20 - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -52718,8 +53402,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -52754,14 +53438,14 @@ paths: type: integer machines: type: array - items: &563 + items: &566 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *357 - required: *358 + properties: *360 + required: *361 examples: - default: &564 + default: &567 value: total_count: 2 machines: @@ -52801,8 +53485,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *239 - - *240 + - *242 + - *243 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -52886,8 +53570,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: - - *239 - - *240 + - *242 + - *243 - 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 @@ -52932,7 +53616,7 @@ paths: '403': *29 '404': *7 '422': *16 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52953,8 +53637,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -52972,7 +53656,7 @@ paths: type: integer secrets: type: array - items: &362 + items: &365 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -52992,7 +53676,7 @@ paths: - created_at - updated_at examples: - default: *359 + default: *362 headers: Link: *39 x-github: @@ -53015,16 +53699,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *360 + schema: *363 examples: - default: *361 + default: *364 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -53044,17 +53728,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 responses: '200': description: Response content: application/json: - schema: *362 + schema: *365 examples: - default: *363 + default: *366 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53074,9 +53758,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 requestBody: required: true content: @@ -53104,7 +53788,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -53128,9 +53812,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 responses: '204': description: Response @@ -53158,8 +53842,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: - - *239 - - *240 + - *242 + - *243 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -53201,7 +53885,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &364 + properties: &367 login: type: string example: octocat @@ -53294,7 +53978,7 @@ paths: user_view_type: type: string example: public - required: &365 + required: &368 - avatar_url - events_url - followers_url @@ -53368,9 +54052,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: - - *239 - - *240 - - *123 + - *242 + - *243 + - *126 responses: '204': description: Response if user is a collaborator @@ -53412,9 +54096,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *239 - - *240 - - *123 + - *242 + - *243 + - *126 requestBody: required: false content: @@ -53440,7 +54124,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &432 + schema: &435 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -53451,7 +54135,7 @@ paths: example: 42 type: integer format: int64 - repository: *110 + repository: *113 invitee: title: Simple User description: A GitHub user. @@ -53662,9 +54346,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *239 - - *240 - - *123 + - *242 + - *243 + - *126 responses: '204': description: No Content when collaborator was removed from the repository. @@ -53693,9 +54377,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *239 - - *240 - - *123 + - *242 + - *243 + - *126 responses: '200': description: if user has admin permissions @@ -53715,8 +54399,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *364 - required: *365 + properties: *367 + required: *368 nullable: true required: - permission @@ -53771,8 +54455,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -53782,7 +54466,7 @@ paths: application/json: schema: type: array - items: &366 + items: &369 title: Commit Comment description: Commit Comment type: object @@ -53823,8 +54507,8 @@ paths: updated_at: type: string format: date-time - author_association: *58 - reactions: *59 + author_association: *61 + reactions: *62 required: - url - html_url @@ -53840,7 +54524,7 @@ paths: - created_at - updated_at examples: - default: &369 + default: &372 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -53899,17 +54583,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 responses: '200': description: Response content: application/json: - schema: *366 + schema: *369 examples: - default: &370 + default: &373 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -53966,9 +54650,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 requestBody: required: true content: @@ -53990,7 +54674,7 @@ paths: description: Response content: application/json: - schema: *366 + schema: *369 examples: default: value: @@ -54041,9 +54725,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 responses: '204': description: Response @@ -54064,9 +54748,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 - 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. @@ -54092,9 +54776,9 @@ paths: application/json: schema: type: array - items: *232 + items: *235 examples: - default: *234 + default: *237 headers: Link: *39 '404': *7 @@ -54115,9 +54799,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 requestBody: required: true content: @@ -54149,16 +54833,16 @@ paths: description: Reaction exists content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '201': description: Reaction created content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '422': *16 x-github: githubCloudOnly: false @@ -54180,10 +54864,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *239 - - *240 - - *71 - - *235 + - *242 + - *243 + - *74 + - *238 responses: '204': description: Response @@ -54231,8 +54915,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: - - *239 - - *240 + - *242 + - *243 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -54288,9 +54972,9 @@ paths: application/json: schema: type: array - items: *367 + items: *370 examples: - default: &483 + default: &486 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -54363,7 +55047,7 @@ paths: '500': *41 '400': *15 '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54383,9 +55067,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: - - *239 - - *240 - - &368 + - *242 + - *243 + - &371 name: commit_sha description: The SHA of the commit. in: path @@ -54432,7 +55116,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *16 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54457,9 +55141,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: - - *239 - - *240 - - *368 + - *242 + - *243 + - *371 - *18 - *20 responses: @@ -54469,9 +55153,9 @@ paths: application/json: schema: type: array - items: *366 + items: *369 examples: - default: *369 + default: *372 headers: Link: *39 x-github: @@ -54499,9 +55183,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: - - *239 - - *240 - - *368 + - *242 + - *243 + - *371 requestBody: required: true content: @@ -54536,9 +55220,9 @@ paths: description: Response content: application/json: - schema: *366 + schema: *369 examples: - default: *370 + default: *373 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -54566,9 +55250,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: - - *239 - - *240 - - *368 + - *242 + - *243 + - *371 - *18 - *20 responses: @@ -54578,7 +55262,7 @@ paths: application/json: schema: type: array - items: &473 + items: &476 title: Pull Request Simple description: Pull Request Simple type: object @@ -54684,8 +55368,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *371 - required: *372 + properties: *374 + required: *375 nullable: true active_lock_reason: type: string @@ -54730,7 +55414,7 @@ paths: nullable: true requested_teams: type: array - items: *166 + items: *169 nullable: true head: type: object @@ -54739,7 +55423,7 @@ paths: type: string ref: type: string - repo: *55 + repo: *58 sha: type: string user: @@ -54762,7 +55446,7 @@ paths: type: string ref: type: string - repo: *55 + repo: *58 sha: type: string user: @@ -54781,7 +55465,7 @@ paths: _links: type: object properties: - comments: &373 + comments: &376 title: Link description: Hypermedia Link type: object @@ -54790,13 +55474,13 @@ paths: type: string required: - href - commits: *373 - statuses: *373 - html: *373 - issue: *373 - review_comments: *373 - review_comment: *373 - self: *373 + commits: *376 + statuses: *376 + html: *376 + issue: *376 + review_comments: *376 + review_comment: *376 + self: *376 required: - comments - commits @@ -54806,8 +55490,8 @@ paths: - review_comments - review_comment - self - author_association: *58 - auto_merge: &476 + author_association: *61 + auto_merge: &479 title: Auto merge description: The status of auto merging a pull request. type: object @@ -54870,7 +55554,7 @@ paths: - author_association - auto_merge examples: - default: &474 + default: &477 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -55350,7 +56034,7 @@ paths: draft: false headers: Link: *39 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55406,11 +56090,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: - - *239 - - *240 + - *242 + - *243 - *20 - *18 - - &374 + - &377 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)" @@ -55425,9 +56109,9 @@ paths: description: Response content: application/json: - schema: *367 + schema: *370 examples: - default: &460 + default: &463 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -55513,8 +56197,8 @@ paths: '422': *16 '404': *7 '500': *41 - '503': *60 - '409': *131 + '503': *63 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -55539,11 +56223,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: - - *239 - - *240 - - *374 - - *375 - - *376 + - *242 + - *243 + - *377 + - *378 + - *379 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -55577,9 +56261,9 @@ paths: type: integer check_runs: type: array - items: *319 + items: *322 examples: - default: *377 + default: *380 headers: Link: *39 x-github: @@ -55604,9 +56288,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: - - *239 - - *240 - - *374 + - *242 + - *243 + - *377 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -55614,7 +56298,7 @@ paths: schema: type: integer example: 1 - - *375 + - *378 - *18 - *20 responses: @@ -55632,7 +56316,7 @@ paths: type: integer check_suites: type: array - items: *324 + items: *327 examples: default: value: @@ -55832,9 +56516,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: - - *239 - - *240 - - *374 + - *242 + - *243 + - *377 - *18 - *20 responses: @@ -55901,7 +56585,7 @@ paths: type: string total_count: type: integer - repository: *110 + repository: *113 commit_url: type: string format: uri @@ -56032,9 +56716,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *239 - - *240 - - *374 + - *242 + - *243 + - *377 - *18 - *20 responses: @@ -56044,7 +56728,7 @@ paths: application/json: schema: type: array - items: &537 + items: &540 title: Status description: The status of a commit. type: object @@ -56125,7 +56809,7 @@ paths: site_admin: false headers: Link: *39 - '301': *251 + '301': *254 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56153,8 +56837,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -56183,20 +56867,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *378 - required: *379 + properties: *381 + required: *382 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &380 + properties: &383 url: type: string format: uri html_url: type: string format: uri - required: &381 + required: &384 - url - html_url nullable: true @@ -56204,32 +56888,32 @@ paths: title: License Simple description: License Simple type: object - properties: *73 - required: *74 + properties: *76 + required: *77 nullable: true contributing: title: Community Health File type: object - properties: *380 - required: *381 + properties: *383 + required: *384 nullable: true readme: title: Community Health File type: object - properties: *380 - required: *381 + properties: *383 + required: *384 nullable: true issue_template: title: Community Health File type: object - properties: *380 - required: *381 + properties: *383 + required: *384 nullable: true pull_request_template: title: Community Health File type: object - properties: *380 - required: *381 + properties: *383 + required: *384 nullable: true required: - code_of_conduct @@ -56355,8 +57039,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: - - *239 - - *240 + - *242 + - *243 - *20 - *18 - name: basehead @@ -56399,8 +57083,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *367 - merge_base_commit: *367 + base_commit: *370 + merge_base_commit: *370 status: type: string enum: @@ -56420,10 +57104,10 @@ paths: example: 6 commits: type: array - items: *367 + items: *370 files: type: array - items: *382 + items: *385 required: - url - html_url @@ -56664,7 +57348,7 @@ paths: module Test" '404': *7 '500': *41 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56706,8 +57390,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: - - *239 - - *240 + - *242 + - *243 - name: path description: path parameter in: path @@ -56848,7 +57532,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &383 + response-if-content-is-a-file: &386 summary: Response if content is a file value: type: file @@ -56980,7 +57664,7 @@ paths: - size - type - url - - &488 + - &491 title: Content File description: Content File type: object @@ -57181,7 +57865,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *383 + response-if-content-is-a-file: *386 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -57250,7 +57934,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *7 '403': *29 - '302': *384 + '302': *387 '304': *37 x-github: githubCloudOnly: false @@ -57273,8 +57957,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: - - *239 - - *240 + - *242 + - *243 - name: path description: path parameter in: path @@ -57367,7 +58051,7 @@ paths: description: Response content: application/json: - schema: &385 + schema: &388 title: File Commit description: File Commit type: object @@ -57515,7 +58199,7 @@ paths: description: Response content: application/json: - schema: *385 + schema: *388 examples: example-for-creating-a-file: value: @@ -57568,7 +58252,7 @@ paths: schema: oneOf: - *3 - - &414 + - &417 description: Repository rule violation was detected type: object properties: @@ -57589,7 +58273,7 @@ paths: items: type: object properties: - placeholder_id: &530 + placeholder_id: &533 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -57621,8 +58305,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: - - *239 - - *240 + - *242 + - *243 - name: path description: path parameter in: path @@ -57683,7 +58367,7 @@ paths: description: Response content: application/json: - schema: *385 + schema: *388 examples: default: value: @@ -57716,8 +58400,8 @@ paths: payload: '422': *16 '404': *7 - '409': *131 - '503': *60 + '409': *134 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57737,8 +58421,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: - - *239 - - *240 + - *242 + - *243 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -57861,20 +58545,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *239 - - *240 - - *139 - - *140 - - *141 + - *242 + - *243 - *142 + - *143 + - *144 + - *145 - 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 - - *143 - - *144 + - *146 + - *147 - *42 - name: page description: "**Closing down notice**. Page number of the results to fetch. @@ -57894,8 +58578,8 @@ paths: default: 30 - *43 - *44 - - *145 - - *146 + - *148 + - *149 responses: '200': description: Response @@ -57903,7 +58587,7 @@ paths: application/json: schema: type: array - items: &388 + items: &391 type: object description: A Dependabot alert. properties: @@ -57936,13 +58620,13 @@ paths: enum: - development - runtime - security_advisory: *386 + security_advisory: *389 security_vulnerability: *47 url: *50 html_url: *51 created_at: *49 - updated_at: *124 - dismissed_at: *126 + updated_at: *127 + dismissed_at: *129 dismissed_by: title: Simple User description: A GitHub user. @@ -57966,8 +58650,8 @@ paths: dismissal. nullable: true maxLength: 280 - fixed_at: *125 - auto_dismissed_at: *387 + fixed_at: *128 + auto_dismissed_at: *390 required: - number - state @@ -58194,9 +58878,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *239 - - *240 - - &389 + - *242 + - *243 + - &392 name: alert_number in: path description: |- @@ -58211,7 +58895,7 @@ paths: description: Response content: application/json: - schema: *388 + schema: *391 examples: default: value: @@ -58321,9 +59005,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *239 - - *240 - - *389 + - *242 + - *243 + - *392 requestBody: required: true content: @@ -58368,7 +59052,7 @@ paths: description: Response content: application/json: - schema: *388 + schema: *391 examples: default: value: @@ -58474,7 +59158,7 @@ paths: '400': *15 '403': *29 '404': *7 - '409': *131 + '409': *134 '422': *8 x-github: githubCloudOnly: false @@ -58497,8 +59181,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -58516,7 +59200,7 @@ paths: type: integer secrets: type: array - items: &392 + items: &395 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -58569,16 +59253,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *390 + schema: *393 examples: - default: *391 + default: *394 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58598,15 +59282,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 responses: '200': description: Response content: application/json: - schema: *392 + schema: *395 examples: default: value: @@ -58632,9 +59316,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 requestBody: required: true content: @@ -58662,7 +59346,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -58686,9 +59370,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: - - *239 - - *240 - - *118 + - *242 + - *243 + - *121 responses: '204': description: Response @@ -58710,8 +59394,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: - - *239 - - *240 + - *242 + - *243 - 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 @@ -58871,8 +59555,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: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -59075,8 +59759,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: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -59151,7 +59835,7 @@ paths: - version - url additionalProperties: false - metadata: &393 + metadata: &396 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -59184,7 +59868,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *393 + metadata: *396 resolved: type: object description: A collection of resolved package dependencies. @@ -59197,7 +59881,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *393 + metadata: *396 relationship: type: string description: A notation of whether a dependency is requested @@ -59326,8 +60010,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: - - *239 - - *240 + - *242 + - *243 - name: sha description: The SHA recorded at creation time. in: query @@ -59367,9 +60051,9 @@ paths: application/json: schema: type: array - items: *394 + items: *397 examples: - default: *395 + default: *398 headers: Link: *39 x-github: @@ -59435,8 +60119,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -59517,7 +60201,7 @@ paths: description: Response content: application/json: - schema: *394 + schema: *397 examples: simple-example: summary: Simple example @@ -59590,9 +60274,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: - - *239 - - *240 - - &396 + - *242 + - *243 + - &399 name: deployment_id description: deployment_id parameter in: path @@ -59604,7 +60288,7 @@ paths: description: Response content: application/json: - schema: *394 + schema: *397 examples: default: value: @@ -59669,9 +60353,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: - - *239 - - *240 - - *396 + - *242 + - *243 + - *399 responses: '204': description: Response @@ -59693,9 +60377,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: - - *239 - - *240 - - *396 + - *242 + - *243 + - *399 - *18 - *20 responses: @@ -59705,7 +60389,7 @@ paths: application/json: schema: type: array - items: &397 + items: &400 title: Deployment Status description: The status of a deployment. type: object @@ -59796,8 +60480,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 required: - id - node_id @@ -59866,9 +60550,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: - - *239 - - *240 - - *396 + - *242 + - *243 + - *399 requestBody: required: true content: @@ -59943,9 +60627,9 @@ paths: description: Response content: application/json: - schema: *397 + schema: *400 examples: - default: &398 + default: &401 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -60001,9 +60685,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: - - *239 - - *240 - - *396 + - *242 + - *243 + - *399 - name: status_id in: path required: true @@ -60014,9 +60698,9 @@ paths: description: Response content: application/json: - schema: *397 + schema: *400 examples: - default: *398 + default: *401 '404': *7 x-github: githubCloudOnly: false @@ -60041,8 +60725,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -60099,8 +60783,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -60117,7 +60801,7 @@ paths: type: integer environments: type: array - items: &400 + items: &403 title: Environment description: Details of a deployment environment type: object @@ -60169,7 +60853,7 @@ paths: type: type: string example: wait_timer - wait_timer: &402 + wait_timer: &405 type: integer example: 30 description: The amount of time to delay a job after @@ -60206,11 +60890,11 @@ paths: items: type: object properties: - type: *399 + type: *402 reviewer: anyOf: - *19 - - *166 + - *169 required: - id - node_id @@ -60230,7 +60914,7 @@ paths: - id - node_id - type - deployment_branch_policy: &403 + deployment_branch_policy: &406 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -60346,9 +61030,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: - - *239 - - *240 - - &401 + - *242 + - *243 + - &404 name: environment_name in: path required: true @@ -60361,9 +61045,9 @@ paths: description: Response content: application/json: - schema: *400 + schema: *403 examples: - default: &404 + default: &407 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -60447,9 +61131,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: - - *239 - - *240 - - *401 + - *242 + - *243 + - *404 requestBody: required: false content: @@ -60458,7 +61142,7 @@ paths: type: object nullable: true properties: - wait_timer: *402 + wait_timer: *405 prevent_self_review: type: boolean example: false @@ -60475,13 +61159,13 @@ paths: items: type: object properties: - type: *399 + type: *402 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *403 + deployment_branch_policy: *406 additionalProperties: false examples: default: @@ -60501,9 +61185,9 @@ paths: description: Response content: application/json: - schema: *400 + schema: *403 examples: - default: *404 + default: *407 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -60527,9 +61211,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: - - *239 - - *240 - - *401 + - *242 + - *243 + - *404 responses: '204': description: Default response @@ -60554,9 +61238,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *239 - - *240 - - *401 + - *242 + - *243 + - *404 - *18 - *20 responses: @@ -60574,7 +61258,7 @@ paths: example: 2 branch_policies: type: array - items: &405 + items: &408 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -60631,9 +61315,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *239 - - *240 - - *401 + - *242 + - *243 + - *404 requestBody: required: true content: @@ -60679,9 +61363,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *408 examples: - example-wildcard: &406 + example-wildcard: &409 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -60723,10 +61407,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *239 - - *240 - - *401 - - &407 + - *242 + - *243 + - *404 + - &410 name: branch_policy_id in: path required: true @@ -60738,9 +61422,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *408 examples: - default: *406 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60759,10 +61443,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *239 - - *240 - - *401 - - *407 + - *242 + - *243 + - *404 + - *410 requestBody: required: true content: @@ -60790,9 +61474,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *408 examples: - default: *406 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60811,10 +61495,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *239 - - *240 - - *401 - - *407 + - *242 + - *243 + - *404 + - *410 responses: '204': description: Response @@ -60839,9 +61523,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *401 - - *240 - - *239 + - *404 + - *243 + - *242 responses: '200': description: List of deployment protection rules @@ -60857,7 +61541,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &408 + items: &411 title: Deployment protection rule description: Deployment protection rule type: object @@ -60876,7 +61560,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &409 + app: &412 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -60975,9 +61659,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: - - *401 - - *240 - - *239 + - *404 + - *243 + - *242 requestBody: content: application/json: @@ -60998,9 +61682,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *408 + schema: *411 examples: - default: &410 + default: &413 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -61035,9 +61719,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: - - *401 - - *240 - - *239 + - *404 + - *243 + - *242 - *20 - *18 responses: @@ -61056,7 +61740,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *409 + items: *412 examples: default: value: @@ -61091,10 +61775,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: - - *239 - - *240 - - *401 - - &411 + - *242 + - *243 + - *404 + - &414 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -61106,9 +61790,9 @@ paths: description: Response content: application/json: - schema: *408 + schema: *411 examples: - default: *410 + default: *413 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61129,10 +61813,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *401 - - *240 - - *239 - - *411 + - *404 + - *243 + - *242 + - *414 responses: '204': description: Response @@ -61158,9 +61842,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: - - *239 - - *240 - - *401 + - *242 + - *243 + - *404 - *18 - *20 responses: @@ -61178,9 +61862,9 @@ paths: type: integer secrets: type: array - items: *285 + items: *288 examples: - default: *286 + default: *289 headers: Link: *39 x-github: @@ -61205,17 +61889,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: - - *239 - - *240 - - *401 + - *242 + - *243 + - *404 responses: '200': description: Response content: application/json: - schema: *287 + schema: *290 examples: - default: *288 + default: *291 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61237,18 +61921,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: - - *239 - - *240 - - *401 - - *118 + - *242 + - *243 + - *404 + - *121 responses: '200': description: Response content: application/json: - schema: *285 + schema: *288 examples: - default: *412 + default: *415 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61270,10 +61954,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *239 - - *240 - - *401 - - *118 + - *242 + - *243 + - *404 + - *121 requestBody: required: true content: @@ -61304,7 +61988,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -61330,10 +62014,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: - - *239 - - *240 - - *401 - - *118 + - *242 + - *243 + - *404 + - *121 responses: '204': description: Default response @@ -61358,10 +62042,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: - - *239 - - *240 - - *401 - - *261 + - *242 + - *243 + - *404 + - *264 - *20 responses: '200': @@ -61378,9 +62062,9 @@ paths: type: integer variables: type: array - items: *289 + items: *292 examples: - default: *290 + default: *293 headers: Link: *39 x-github: @@ -61403,9 +62087,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: - - *239 - - *240 - - *401 + - *242 + - *243 + - *404 requestBody: required: true content: @@ -61432,7 +62116,7 @@ paths: description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -61457,18 +62141,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: - - *239 - - *240 - - *401 - - *121 + - *242 + - *243 + - *404 + - *124 responses: '200': description: Response content: application/json: - schema: *289 + schema: *292 examples: - default: *413 + default: *416 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61489,10 +62173,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: - - *239 - - *240 - - *121 - - *401 + - *242 + - *243 + - *124 + - *404 requestBody: required: true content: @@ -61534,10 +62218,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: - - *239 - - *240 - - *121 - - *401 + - *242 + - *243 + - *124 + - *404 responses: '204': description: Response @@ -61559,8 +62243,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -61570,7 +62254,7 @@ paths: application/json: schema: type: array - items: *84 + items: *87 examples: 200-response: value: @@ -61637,8 +62321,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: - - *239 - - *240 + - *242 + - *243 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -61660,7 +62344,7 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: default: value: @@ -61797,8 +62481,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: false content: @@ -61830,9 +62514,9 @@ paths: description: Response content: application/json: - schema: *250 + schema: *253 examples: - default: *252 + default: *255 '400': *15 '422': *16 '403': *29 @@ -61853,8 +62537,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -61905,7 +62589,7 @@ paths: schema: type: string '404': *7 - '409': *131 + '409': *134 '403': *29 '422': description: Validation failed @@ -61913,8 +62597,8 @@ paths: application/json: schema: oneOf: - - *94 - - *414 + - *97 + - *417 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61939,8 +62623,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: - - *239 - - *240 + - *242 + - *243 - name: file_sha in: path required: true @@ -61991,7 +62675,7 @@ paths: '404': *7 '422': *16 '403': *29 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62038,8 +62722,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -62148,7 +62832,7 @@ paths: description: Response content: application/json: - schema: &415 + schema: &418 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -62307,7 +62991,7 @@ paths: type: string '422': *16 '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62356,15 +63040,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: - - *239 - - *240 - - *368 + - *242 + - *243 + - *371 responses: '200': description: Response content: application/json: - schema: *415 + schema: *418 examples: default: value: @@ -62394,7 +63078,7 @@ paths: signature: payload: '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62419,9 +63103,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: - - *239 - - *240 - - &416 + - *242 + - *243 + - &419 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. @@ -62438,7 +63122,7 @@ paths: application/json: schema: type: array - items: &417 + items: &420 title: Git Reference description: Git references within a repository type: object @@ -62492,7 +63176,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *39 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62513,17 +63197,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: - - *239 - - *240 - - *416 + - *242 + - *243 + - *419 responses: '200': description: Response content: application/json: - schema: *417 + schema: *420 examples: - default: &418 + default: &421 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -62533,7 +63217,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62552,8 +63236,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -62582,16 +63266,16 @@ paths: description: Response content: application/json: - schema: *417 + schema: *420 examples: - default: *418 + default: *421 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *16 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62610,9 +63294,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: - - *239 - - *240 - - *416 + - *242 + - *243 + - *419 requestBody: required: true content: @@ -62641,11 +63325,11 @@ paths: description: Response content: application/json: - schema: *417 + schema: *420 examples: - default: *418 + default: *421 '422': *16 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62661,14 +63345,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: - - *239 - - *240 - - *416 + - *242 + - *243 + - *419 responses: '204': description: Response '422': *16 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62715,8 +63399,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -62783,7 +63467,7 @@ paths: description: Response content: application/json: - schema: &420 + schema: &423 title: Git Tag description: Metadata for a Git tag type: object @@ -62834,7 +63518,7 @@ paths: - sha - type - url - verification: *419 + verification: *422 required: - sha - url @@ -62844,7 +63528,7 @@ paths: - tag - message examples: - default: &421 + default: &424 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -62870,7 +63554,7 @@ paths: schema: type: string '422': *16 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62915,8 +63599,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: - - *239 - - *240 + - *242 + - *243 - name: tag_sha in: path required: true @@ -62927,11 +63611,11 @@ paths: description: Response content: application/json: - schema: *420 + schema: *423 examples: - default: *421 + default: *424 '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62953,8 +63637,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -63027,7 +63711,7 @@ paths: description: Response content: application/json: - schema: &422 + schema: &425 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -63116,7 +63800,7 @@ paths: '422': *16 '404': *7 '403': *29 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63139,8 +63823,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: - - *239 - - *240 + - *242 + - *243 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -63163,7 +63847,7 @@ paths: description: Response content: application/json: - schema: *422 + schema: *425 examples: default-response: summary: Default response @@ -63204,7 +63888,7 @@ paths: truncated: false '422': *16 '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63222,8 +63906,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -63233,7 +63917,7 @@ paths: application/json: schema: type: array - items: &423 + items: &426 title: Webhook description: Webhooks for repositories. type: object @@ -63287,7 +63971,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &640 + last_response: &643 title: Hook Response type: object properties: @@ -63361,8 +64045,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: false content: @@ -63414,9 +64098,9 @@ paths: description: Response content: application/json: - schema: *423 + schema: *426 examples: - default: &424 + default: &427 value: type: Repository id: 12345678 @@ -63464,17 +64148,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 responses: '200': description: Response content: application/json: - schema: *423 + schema: *426 examples: - default: *424 + default: *427 '404': *7 x-github: githubCloudOnly: false @@ -63494,9 +64178,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 requestBody: required: true content: @@ -63541,9 +64225,9 @@ paths: description: Response content: application/json: - schema: *423 + schema: *426 examples: - default: *424 + default: *427 '422': *16 '404': *7 x-github: @@ -63561,9 +64245,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 responses: '204': description: Response @@ -63587,9 +64271,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 responses: '200': description: Response @@ -63616,9 +64300,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 requestBody: required: false content: @@ -63662,11 +64346,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 - *18 - - *155 + - *158 - name: redelivery in: query required: false @@ -63679,9 +64363,9 @@ paths: application/json: schema: type: array - items: *156 + items: *159 examples: - default: *157 + default: *160 '400': *15 '422': *16 x-github: @@ -63700,18 +64384,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 - *17 responses: '200': description: Response content: application/json: - schema: *158 + schema: *161 examples: - default: *159 + default: *162 '400': *15 '422': *16 x-github: @@ -63730,12 +64414,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 - *17 responses: - '202': *96 + '202': *99 '400': *15 '422': *16 x-github: @@ -63755,9 +64439,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 responses: '204': description: Response @@ -63782,9 +64466,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *239 - - *240 - - *154 + - *242 + - *243 + - *157 responses: '204': description: Response @@ -63842,14 +64526,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: &425 + schema: &428 title: Import description: A repository import from an external source. type: object @@ -63948,7 +64632,7 @@ paths: - html_url - authors_url examples: - default: &428 + default: &431 value: vcs: subversion use_lfs: true @@ -63964,7 +64648,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *7 - '503': &426 + '503': &429 description: Unavailable due to service under maintenance. content: application/json: @@ -63993,8 +64677,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -64042,7 +64726,7 @@ paths: description: Response content: application/json: - schema: *425 + schema: *428 examples: default: value: @@ -64067,7 +64751,7 @@ paths: type: string '422': *16 '404': *7 - '503': *426 + '503': *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64095,8 +64779,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: false content: @@ -64145,7 +64829,7 @@ paths: description: Response content: application/json: - schema: *425 + schema: *428 examples: example-1: summary: Example 1 @@ -64193,7 +64877,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': *426 + '503': *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64216,12 +64900,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response - '503': *426 + '503': *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64247,9 +64931,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: - - *239 - - *240 - - &587 + - *242 + - *243 + - &590 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -64263,7 +64947,7 @@ paths: application/json: schema: type: array - items: &427 + items: &430 title: Porter Author description: Porter Author type: object @@ -64317,7 +65001,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *7 - '503': *426 + '503': *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64342,8 +65026,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: - - *239 - - *240 + - *242 + - *243 - name: author_id in: path required: true @@ -64373,7 +65057,7 @@ paths: description: Response content: application/json: - schema: *427 + schema: *430 examples: default: value: @@ -64386,7 +65070,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *16 '404': *7 - '503': *426 + '503': *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64410,8 +65094,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -64452,7 +65136,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *426 + '503': *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64480,8 +65164,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -64508,11 +65192,11 @@ paths: description: Response content: application/json: - schema: *425 + schema: *428 examples: - default: *428 + default: *431 '422': *16 - '503': *426 + '503': *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64535,8 +65219,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -64544,8 +65228,8 @@ paths: application/json: schema: *22 examples: - default: *429 - '301': *251 + default: *432 + '301': *254 '404': *7 x-github: githubCloudOnly: false @@ -64565,8 +65249,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -64574,12 +65258,12 @@ paths: application/json: schema: anyOf: - - *161 + - *164 - type: object properties: {} additionalProperties: false examples: - default: &431 + default: &434 value: limit: collaborators_only origin: repository @@ -64604,13 +65288,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: application/json: - schema: *430 + schema: *433 examples: default: summary: Example request body @@ -64622,9 +65306,9 @@ paths: description: Response content: application/json: - schema: *161 + schema: *164 examples: - default: *431 + default: *434 '409': description: Response x-github: @@ -64646,8 +65330,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -64670,8 +65354,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -64681,9 +65365,9 @@ paths: application/json: schema: type: array - items: *432 + items: *435 examples: - default: &580 + default: &583 value: - id: 1 repository: @@ -64814,9 +65498,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: - - *239 - - *240 - - *165 + - *242 + - *243 + - *168 requestBody: required: false content: @@ -64845,7 +65529,7 @@ paths: description: Response content: application/json: - schema: *432 + schema: *435 examples: default: value: @@ -64976,9 +65660,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *239 - - *240 - - *165 + - *242 + - *243 + - *168 responses: '204': description: Response @@ -65009,8 +65693,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: - - *239 - - *240 + - *242 + - *243 - 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 @@ -65050,7 +65734,7 @@ paths: required: false schema: type: string - - *167 + - *170 - name: sort description: What to sort results by. in: query @@ -65063,7 +65747,7 @@ paths: - comments default: created - *42 - - *62 + - *65 - *18 - *20 responses: @@ -65073,7 +65757,7 @@ paths: application/json: schema: type: array - items: *72 + items: *75 examples: default: value: @@ -65223,7 +65907,7 @@ paths: state_reason: completed headers: Link: *39 - '301': *251 + '301': *254 '422': *16 '404': *7 x-github: @@ -65252,8 +65936,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -65328,9 +66012,9 @@ paths: description: Response content: application/json: - schema: *72 + schema: *75 examples: - default: &438 + default: &441 value: id: 1 node_id: MDU6SXNzdWUx @@ -65484,9 +66168,9 @@ paths: '400': *15 '403': *29 '422': *16 - '503': *60 + '503': *63 '404': *7 - '410': *248 + '410': *251 x-github: triggersNotification: true githubCloudOnly: false @@ -65514,9 +66198,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *239 - - *240 - - *82 + - *242 + - *243 + - *85 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -65526,7 +66210,7 @@ paths: enum: - asc - desc - - *62 + - *65 - *18 - *20 responses: @@ -65536,9 +66220,9 @@ paths: application/json: schema: type: array - items: *433 + items: *436 examples: - default: &440 + default: &443 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -65596,17 +66280,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 responses: '200': description: Response content: application/json: - schema: *433 + schema: *436 examples: - default: &434 + default: &437 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -65660,9 +66344,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 requestBody: required: true content: @@ -65684,9 +66368,9 @@ paths: description: Response content: application/json: - schema: *433 + schema: *436 examples: - default: *434 + default: *437 '422': *16 x-github: githubCloudOnly: false @@ -65704,9 +66388,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 responses: '204': description: Response @@ -65726,9 +66410,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 - 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. @@ -65754,9 +66438,9 @@ paths: application/json: schema: type: array - items: *232 + items: *235 examples: - default: *234 + default: *237 headers: Link: *39 '404': *7 @@ -65777,9 +66461,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 requestBody: required: true content: @@ -65811,16 +66495,16 @@ paths: description: Reaction exists content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '201': description: Reaction created content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '422': *16 x-github: githubCloudOnly: false @@ -65842,10 +66526,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *239 - - *240 - - *71 - - *235 + - *242 + - *243 + - *74 + - *238 responses: '204': description: Response @@ -65865,8 +66549,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -65876,7 +66560,7 @@ paths: application/json: schema: type: array - items: &437 + items: &440 title: Issue Event description: Issue Event type: object @@ -65919,8 +66603,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *435 - required: *436 + properties: *438 + required: *439 nullable: true label: title: Issue Event Label @@ -65964,7 +66648,7 @@ paths: properties: *4 required: *5 nullable: true - requested_team: *166 + requested_team: *169 dismissed_review: title: Issue Event Dismissed Review type: object @@ -66029,7 +66713,7 @@ paths: required: - from - to - author_association: *58 + author_association: *61 lock_reason: type: string nullable: true @@ -66042,8 +66726,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 required: - id - node_id @@ -66227,8 +66911,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: - - *239 - - *240 + - *242 + - *243 - name: event_id in: path required: true @@ -66239,7 +66923,7 @@ paths: description: Response content: application/json: - schema: *437 + schema: *440 examples: default: value: @@ -66432,7 +67116,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *7 - '410': *248 + '410': *251 '403': *29 x-github: githubCloudOnly: false @@ -66466,9 +67150,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: - - *239 - - *240 - - &439 + - *242 + - *243 + - &442 name: issue_number description: The number that identifies the issue. in: path @@ -66480,12 +67164,12 @@ paths: description: Response content: application/json: - schema: *72 + schema: *75 examples: - default: *438 - '301': *251 + default: *441 + '301': *254 '404': *7 - '410': *248 + '410': *251 '304': *37 x-github: githubCloudOnly: false @@ -66510,9 +67194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 requestBody: required: false content: @@ -66607,15 +67291,15 @@ paths: description: Response content: application/json: - schema: *72 + schema: *75 examples: - default: *438 + default: *441 '422': *16 - '503': *60 + '503': *63 '403': *29 - '301': *251 + '301': *254 '404': *7 - '410': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66633,9 +67317,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 requestBody: required: false content: @@ -66661,9 +67345,9 @@ paths: description: Response content: application/json: - schema: *72 + schema: *75 examples: - default: *438 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66679,9 +67363,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 requestBody: content: application/json: @@ -66706,9 +67390,9 @@ paths: description: Response content: application/json: - schema: *72 + schema: *75 examples: - default: *438 + default: *441 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66730,9 +67414,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: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 - name: assignee in: path required: true @@ -66772,10 +67456,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: - - *239 - - *240 - - *439 - - *62 + - *242 + - *243 + - *442 + - *65 - *18 - *20 responses: @@ -66785,13 +67469,13 @@ paths: application/json: schema: type: array - items: *433 + items: *436 examples: - default: *440 + default: *443 headers: Link: *39 '404': *7 - '410': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66820,9 +67504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 requestBody: required: true content: @@ -66844,16 +67528,16 @@ paths: description: Response content: application/json: - schema: *433 + schema: *436 examples: - default: *434 + default: *437 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *248 + '410': *251 '422': *16 '404': *7 x-github: @@ -66873,9 +67557,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 - *18 - *20 responses: @@ -66889,7 +67573,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &443 + - &446 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -66920,8 +67604,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 label: type: object properties: @@ -66943,7 +67627,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &444 + - &447 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -66974,8 +67658,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 label: type: object properties: @@ -67063,8 +67747,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 assignee: *19 assigner: *19 required: @@ -67079,7 +67763,7 @@ paths: - performed_via_github_app - assignee - assigner - - &445 + - &448 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -67110,8 +67794,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 milestone: type: object properties: @@ -67130,7 +67814,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &446 + - &449 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -67161,8 +67845,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 milestone: type: object properties: @@ -67181,7 +67865,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &447 + - &450 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -67212,8 +67896,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 rename: type: object properties: @@ -67235,7 +67919,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &448 + - &451 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -67266,10 +67950,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 review_requester: *19 - requested_team: *166 + requested_team: *169 requested_reviewer: *19 required: - review_requester @@ -67282,7 +67966,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &449 + - &452 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -67313,10 +67997,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 review_requester: *19 - requested_team: *166 + requested_team: *169 requested_reviewer: *19 required: - review_requester @@ -67329,7 +68013,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &450 + - &453 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -67360,8 +68044,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 dismissed_review: type: object properties: @@ -67389,7 +68073,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &451 + - &454 title: Locked Issue Event description: Locked Issue Event type: object @@ -67420,8 +68104,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 lock_reason: type: string example: '"off-topic"' @@ -67437,7 +68121,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &452 + - &455 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -67468,8 +68152,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 project_card: type: object properties: @@ -67503,7 +68187,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &453 + - &456 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -67534,8 +68218,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 project_card: type: object properties: @@ -67569,7 +68253,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &454 + - &457 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -67600,8 +68284,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 project_card: type: object properties: @@ -67635,7 +68319,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &455 + - &458 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -67726,7 +68410,7 @@ paths: color: red headers: Link: *39 - '410': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67743,9 +68427,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 - *18 - *20 responses: @@ -67755,7 +68439,7 @@ paths: application/json: schema: type: array - items: &441 + items: &444 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -67802,7 +68486,7 @@ paths: - color - default examples: - default: &442 + default: &445 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -67820,9 +68504,9 @@ paths: default: false headers: Link: *39 - '301': *251 + '301': *254 '404': *7 - '410': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67839,9 +68523,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 requestBody: required: false content: @@ -67900,12 +68584,12 @@ paths: application/json: schema: type: array - items: *441 + items: *444 examples: - default: *442 - '301': *251 + default: *445 + '301': *254 '404': *7 - '410': *248 + '410': *251 '422': *16 x-github: githubCloudOnly: false @@ -67922,9 +68606,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 requestBody: required: false content: @@ -67984,12 +68668,12 @@ paths: application/json: schema: type: array - items: *441 + items: *444 examples: - default: *442 - '301': *251 + default: *445 + '301': *254 '404': *7 - '410': *248 + '410': *251 '422': *16 x-github: githubCloudOnly: false @@ -68006,15 +68690,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 responses: '204': description: Response - '301': *251 + '301': *254 '404': *7 - '410': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68033,9 +68717,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 - name: name in: path required: true @@ -68048,7 +68732,7 @@ paths: application/json: schema: type: array - items: *441 + items: *444 examples: default: value: @@ -68059,9 +68743,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *251 + '301': *254 '404': *7 - '410': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68081,9 +68765,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 requestBody: required: false content: @@ -68111,7 +68795,7 @@ paths: '204': description: Response '403': *29 - '410': *248 + '410': *251 '404': *7 '422': *16 x-github: @@ -68129,9 +68813,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 responses: '204': description: Response @@ -68153,9 +68837,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 - 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. @@ -68181,13 +68865,13 @@ paths: application/json: schema: type: array - items: *232 + items: *235 examples: - default: *234 + default: *237 headers: Link: *39 '404': *7 - '410': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68205,9 +68889,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 requestBody: required: true content: @@ -68239,16 +68923,16 @@ paths: description: Response content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '201': description: Response content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '422': *16 x-github: githubCloudOnly: false @@ -68270,10 +68954,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: - - *239 - - *240 - - *439 - - *235 + - *242 + - *243 + - *442 + - *238 responses: '204': description: Response @@ -68293,9 +68977,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *239 - - *240 - - *439 + - *242 + - *243 + - *442 - *18 - *20 responses: @@ -68310,9 +68994,6 @@ paths: description: Timeline Event type: object anyOf: - - *443 - - *444 - - *445 - *446 - *447 - *448 @@ -68323,6 +69004,9 @@ paths: - *453 - *454 - *455 + - *456 + - *457 + - *458 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -68365,7 +69049,7 @@ paths: issue_url: type: string format: uri - author_association: *58 + author_association: *61 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -68375,9 +69059,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 - reactions: *59 + properties: *59 + required: *60 + reactions: *62 required: - event - actor @@ -68408,7 +69092,7 @@ paths: properties: type: type: string - issue: *72 + issue: *75 required: - event - created_at @@ -68600,7 +69284,7 @@ paths: type: string body_text: type: string - author_association: *58 + author_association: *61 required: - event - id @@ -68623,7 +69307,7 @@ paths: type: string comments: type: array - items: &477 + items: &480 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -68712,7 +69396,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *58 + author_association: *61 _links: type: object properties: @@ -68796,7 +69480,7 @@ paths: enum: - line - file - reactions: *59 + reactions: *62 body_html: type: string example: '"

comment body

"' @@ -68832,7 +69516,7 @@ paths: type: string comments: type: array - items: *366 + items: *369 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -68863,8 +69547,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 assignee: *19 required: - id @@ -68907,8 +69591,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 assignee: *19 required: - id @@ -68951,8 +69635,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 state_reason: type: string nullable: true @@ -69121,7 +69805,7 @@ paths: headers: Link: *39 '404': *7 - '410': *248 + '410': *251 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69138,8 +69822,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -69149,7 +69833,7 @@ paths: application/json: schema: type: array - items: &456 + items: &459 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -69211,8 +69895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -69248,9 +69932,9 @@ paths: description: Response content: application/json: - schema: *456 + schema: *459 examples: - default: &457 + default: &460 value: id: 1 key: ssh-rsa AAA... @@ -69283,9 +69967,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *239 - - *240 - - &458 + - *242 + - *243 + - &461 name: key_id description: The unique identifier of the key. in: path @@ -69297,9 +69981,9 @@ paths: description: Response content: application/json: - schema: *456 + schema: *459 examples: - default: *457 + default: *460 '404': *7 x-github: githubCloudOnly: false @@ -69317,9 +70001,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *239 - - *240 - - *458 + - *242 + - *243 + - *461 responses: '204': description: Response @@ -69339,8 +70023,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -69350,9 +70034,9 @@ paths: application/json: schema: type: array - items: *441 + items: *444 examples: - default: *442 + default: *445 headers: Link: *39 '404': *7 @@ -69373,8 +70057,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -69410,9 +70094,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *444 examples: - default: &459 + default: &462 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -69444,8 +70128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: - - *239 - - *240 + - *242 + - *243 - name: name in: path required: true @@ -69456,9 +70140,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *444 examples: - default: *459 + default: *462 '404': *7 x-github: githubCloudOnly: false @@ -69475,8 +70159,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: - - *239 - - *240 + - *242 + - *243 - name: name in: path required: true @@ -69515,7 +70199,7 @@ paths: description: Response content: application/json: - schema: *441 + schema: *444 examples: default: value: @@ -69541,8 +70225,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: - - *239 - - *240 + - *242 + - *243 - name: name in: path required: true @@ -69568,8 +70252,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -69608,9 +70292,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *239 - - *240 - - *341 + - *242 + - *243 + - *344 responses: '200': description: Response @@ -69672,8 +70356,8 @@ paths: title: License Simple description: License Simple type: object - properties: *73 - required: *74 + properties: *76 + required: *77 nullable: true required: - _links @@ -69755,8 +70439,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -69821,8 +70505,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -69856,9 +70540,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *367 + schema: *370 examples: - default: *460 + default: *463 '204': description: Response when already merged '404': @@ -69883,8 +70567,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: - - *239 - - *240 + - *242 + - *243 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -69925,12 +70609,12 @@ paths: application/json: schema: type: array - items: &461 + items: &464 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *371 - required: *372 + properties: *374 + required: *375 examples: default: value: @@ -69986,8 +70670,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -70027,9 +70711,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *464 examples: - default: &462 + default: &465 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -70088,9 +70772,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: - - *239 - - *240 - - &463 + - *242 + - *243 + - &466 name: milestone_number description: The number that identifies the milestone. in: path @@ -70102,9 +70786,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *464 examples: - default: *462 + default: *465 '404': *7 x-github: githubCloudOnly: false @@ -70121,9 +70805,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: - - *239 - - *240 - - *463 + - *242 + - *243 + - *466 requestBody: required: false content: @@ -70161,9 +70845,9 @@ paths: description: Response content: application/json: - schema: *461 + schema: *464 examples: - default: *462 + default: *465 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70179,9 +70863,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: - - *239 - - *240 - - *463 + - *242 + - *243 + - *466 responses: '204': description: Response @@ -70202,9 +70886,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: - - *239 - - *240 - - *463 + - *242 + - *243 + - *466 - *18 - *20 responses: @@ -70214,9 +70898,9 @@ paths: application/json: schema: type: array - items: *441 + items: *444 examples: - default: *442 + default: *445 headers: Link: *39 x-github: @@ -70235,12 +70919,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - - *239 - - *240 - - *464 - - *465 - - *62 - - *466 + - *242 + - *243 + - *467 + - *468 + - *65 + - *469 - *18 - *20 responses: @@ -70250,9 +70934,9 @@ paths: application/json: schema: type: array - items: *85 + items: *88 examples: - default: *467 + default: *470 headers: Link: *39 x-github: @@ -70276,8 +70960,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: false content: @@ -70335,14 +71019,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: &468 + schema: &471 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -70467,7 +71151,7 @@ paths: - custom_404 - public examples: - default: &469 + default: &472 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -70508,8 +71192,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -70563,11 +71247,11 @@ paths: description: Response content: application/json: - schema: *468 + schema: *471 examples: - default: *469 + default: *472 '422': *16 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70588,8 +71272,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -70667,7 +71351,7 @@ paths: description: Response '422': *16 '400': *15 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70688,14 +71372,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response '422': *16 '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70715,8 +71399,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -70726,7 +71410,7 @@ paths: application/json: schema: type: array - items: &470 + items: &473 title: Page Build description: Page Build type: object @@ -70820,8 +71504,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: - - *239 - - *240 + - *242 + - *243 responses: '201': description: Response @@ -70866,16 +71550,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *470 + schema: *473 examples: - default: &471 + default: &474 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -70923,8 +71607,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: - - *239 - - *240 + - *242 + - *243 - name: build_id in: path required: true @@ -70935,9 +71619,9 @@ paths: description: Response content: application/json: - schema: *470 + schema: *473 examples: - default: *471 + default: *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70957,8 +71641,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -71064,9 +71748,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: - - *239 - - *240 - - &472 + - *242 + - *243 + - &475 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -71124,11 +71808,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *239 - - *240 - - *472 + - *242 + - *243 + - *475 responses: - '204': *134 + '204': *137 '404': *7 x-github: githubCloudOnly: false @@ -71153,8 +71837,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -71385,7 +72069,7 @@ paths: description: Empty response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -71412,8 +72096,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: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Private vulnerability reporting status @@ -71450,10 +72134,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: - '204': *134 + '204': *137 '422': *15 x-github: githubCloudOnly: false @@ -71472,10 +72156,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: - '204': *134 + '204': *137 '422': *15 x-github: githubCloudOnly: false @@ -71496,8 +72180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-repository-projects parameters: - - *239 - - *240 + - *242 + - *243 - name: state description: Indicates the state of the projects to return. in: query @@ -71518,7 +72202,7 @@ paths: application/json: schema: type: array - items: *197 + items: *200 examples: default: value: @@ -71558,7 +72242,7 @@ paths: '401': *25 '403': *29 '404': *7 - '410': *248 + '410': *251 '422': *8 x-github: githubCloudOnly: false @@ -71578,8 +72262,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#create-a-repository-project parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -71605,13 +72289,13 @@ paths: description: Response content: application/json: - schema: *197 + schema: *200 examples: - default: *247 + default: *250 '401': *25 '403': *29 '404': *7 - '410': *248 + '410': *251 '422': *8 x-github: githubCloudOnly: false @@ -71631,8 +72315,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -71640,7 +72324,7 @@ paths: application/json: schema: type: array - items: *202 + items: *205 examples: default: value: @@ -71671,8 +72355,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: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -71684,7 +72368,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *202 + items: *205 required: - properties examples: @@ -71734,8 +72418,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: - - *239 - - *240 + - *242 + - *243 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -71795,9 +72479,9 @@ paths: application/json: schema: type: array - items: *473 + items: *476 examples: - default: *474 + default: *477 headers: Link: *39 '304': *37 @@ -71829,8 +72513,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -71895,7 +72579,7 @@ paths: description: Response content: application/json: - schema: &479 + schema: &482 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -72006,8 +72690,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *371 - required: *372 + properties: *374 + required: *375 nullable: true active_lock_reason: type: string @@ -72052,7 +72736,7 @@ paths: nullable: true requested_teams: type: array - items: *475 + items: *478 nullable: true head: type: object @@ -72061,7 +72745,7 @@ paths: type: string ref: type: string - repo: *55 + repo: *58 sha: type: string user: *19 @@ -72078,7 +72762,7 @@ paths: type: string ref: type: string - repo: *55 + repo: *58 sha: type: string user: *19 @@ -72091,14 +72775,14 @@ paths: _links: type: object properties: - comments: *373 - commits: *373 - statuses: *373 - html: *373 - issue: *373 - review_comments: *373 - review_comment: *373 - self: *373 + comments: *376 + commits: *376 + statuses: *376 + html: *376 + issue: *376 + review_comments: *376 + review_comment: *376 + self: *376 required: - comments - commits @@ -72108,8 +72792,8 @@ paths: - review_comments - review_comment - self - author_association: *58 - auto_merge: *476 + author_association: *61 + auto_merge: *479 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -72201,7 +72885,7 @@ paths: - merged_by - review_comments examples: - default: &480 + default: &483 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -72728,8 +73412,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *239 - - *240 + - *242 + - *243 - name: sort in: query required: false @@ -72748,7 +73432,7 @@ paths: enum: - asc - desc - - *62 + - *65 - *18 - *20 responses: @@ -72758,9 +73442,9 @@ paths: application/json: schema: type: array - items: *477 + items: *480 examples: - default: &482 + default: &485 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -72837,17 +73521,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 responses: '200': description: Response content: application/json: - schema: *477 + schema: *480 examples: - default: &478 + default: &481 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -72922,9 +73606,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 requestBody: required: true content: @@ -72946,9 +73630,9 @@ paths: description: Response content: application/json: - schema: *477 + schema: *480 examples: - default: *478 + default: *481 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72964,9 +73648,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 responses: '204': description: Response @@ -72987,9 +73671,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 - 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. @@ -73015,9 +73699,9 @@ paths: application/json: schema: type: array - items: *232 + items: *235 examples: - default: *234 + default: *237 headers: Link: *39 '404': *7 @@ -73038,9 +73722,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: - - *239 - - *240 - - *71 + - *242 + - *243 + - *74 requestBody: required: true content: @@ -73072,16 +73756,16 @@ paths: description: Reaction exists content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '201': description: Reaction created content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '422': *16 x-github: githubCloudOnly: false @@ -73103,10 +73787,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *239 - - *240 - - *71 - - *235 + - *242 + - *243 + - *74 + - *238 responses: '204': description: Response @@ -73149,9 +73833,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: - - *239 - - *240 - - &481 + - *242 + - *243 + - &484 name: pull_number description: The number that identifies the pull request. in: path @@ -73164,9 +73848,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *479 + schema: *482 examples: - default: *480 + default: *483 '304': *37 '404': *7 '406': @@ -73175,7 +73859,7 @@ paths: application/json: schema: *3 '500': *41 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73201,9 +73885,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 requestBody: required: false content: @@ -73245,9 +73929,9 @@ paths: description: Response content: application/json: - schema: *479 + schema: *482 examples: - default: *480 + default: *483 '422': *16 '403': *29 x-github: @@ -73269,9 +73953,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 requestBody: required: true content: @@ -73331,21 +74015,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '401': *25 '403': *29 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -73371,10 +74055,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: - - *239 - - *240 - - *481 - - *82 + - *242 + - *243 + - *484 + - *85 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -73384,7 +74068,7 @@ paths: enum: - asc - desc - - *62 + - *65 - *18 - *20 responses: @@ -73394,9 +74078,9 @@ paths: application/json: schema: type: array - items: *477 + items: *480 examples: - default: *482 + default: *485 headers: Link: *39 x-github: @@ -73429,9 +74113,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 requestBody: required: true content: @@ -73536,7 +74220,7 @@ paths: description: Response content: application/json: - schema: *477 + schema: *480 examples: example-for-a-multi-line-comment: value: @@ -73624,10 +74308,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: - - *239 - - *240 - - *481 - - *71 + - *242 + - *243 + - *484 + - *74 requestBody: required: true content: @@ -73649,7 +74333,7 @@ paths: description: Response content: application/json: - schema: *477 + schema: *480 examples: default: value: @@ -73735,9 +74419,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 - *18 - *20 responses: @@ -73747,9 +74431,9 @@ paths: application/json: schema: type: array - items: *367 + items: *370 examples: - default: *483 + default: *486 headers: Link: *39 x-github: @@ -73779,9 +74463,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 - *18 - *20 responses: @@ -73791,7 +74475,7 @@ paths: application/json: schema: type: array - items: *382 + items: *385 examples: default: value: @@ -73810,7 +74494,7 @@ paths: Link: *39 '422': *16 '500': *41 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73829,9 +74513,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 responses: '204': description: Response if pull request has been merged @@ -73854,9 +74538,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 requestBody: required: false content: @@ -73967,9 +74651,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 responses: '200': description: Response @@ -73985,7 +74669,7 @@ paths: items: *19 teams: type: array - items: *166 + items: *169 required: - users - teams @@ -74044,9 +74728,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 requestBody: required: false content: @@ -74083,7 +74767,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *476 examples: default: value: @@ -74619,9 +75303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 requestBody: required: true content: @@ -74655,7 +75339,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *476 examples: default: value: @@ -75160,9 +75844,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 - *18 - *20 responses: @@ -75172,7 +75856,7 @@ paths: application/json: schema: type: array - items: &484 + items: &487 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -75241,7 +75925,7 @@ paths: type: string body_text: type: string - author_association: *58 + author_association: *61 required: - id - node_id @@ -75323,9 +76007,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 requestBody: required: false content: @@ -75411,9 +76095,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *487 examples: - default: &486 + default: &489 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -75476,10 +76160,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: - - *239 - - *240 - - *481 - - &485 + - *242 + - *243 + - *484 + - &488 name: review_id description: The unique identifier of the review. in: path @@ -75491,9 +76175,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *487 examples: - default: &487 + default: &490 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -75552,10 +76236,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: - - *239 - - *240 - - *481 - - *485 + - *242 + - *243 + - *484 + - *488 requestBody: required: true content: @@ -75578,7 +76262,7 @@ paths: description: Response content: application/json: - schema: *484 + schema: *487 examples: default: value: @@ -75640,18 +76324,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: - - *239 - - *240 - - *481 - - *485 + - *242 + - *243 + - *484 + - *488 responses: '200': description: Response content: application/json: - schema: *484 + schema: *487 examples: - default: *486 + default: *489 '422': *8 '404': *7 x-github: @@ -75678,10 +76362,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: - - *239 - - *240 - - *481 - - *485 + - *242 + - *243 + - *484 + - *488 - *18 - *20 responses: @@ -75760,13 +76444,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *58 + author_association: *61 _links: type: object properties: - self: *373 - html: *373 - pull_request: *373 + self: *376 + html: *376 + pull_request: *376 required: - self - html @@ -75775,7 +76459,7 @@ paths: type: string body_html: type: string - reactions: *59 + reactions: *62 side: description: The side of the first line of the range for a multi-line comment. @@ -75909,10 +76593,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: - - *239 - - *240 - - *481 - - *485 + - *242 + - *243 + - *484 + - *488 requestBody: required: true content: @@ -75940,7 +76624,7 @@ paths: description: Response content: application/json: - schema: *484 + schema: *487 examples: default: value: @@ -76003,10 +76687,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: - - *239 - - *240 - - *481 - - *485 + - *242 + - *243 + - *484 + - *488 requestBody: required: true content: @@ -76041,9 +76725,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *487 examples: - default: *487 + default: *490 '404': *7 '422': *8 '403': *29 @@ -76065,9 +76749,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: - - *239 - - *240 - - *481 + - *242 + - *243 + - *484 requestBody: required: false content: @@ -76130,8 +76814,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: - - *239 - - *240 + - *242 + - *243 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -76144,9 +76828,9 @@ paths: description: Response content: application/json: - schema: *488 + schema: *491 examples: - default: &489 + default: &492 value: type: file encoding: base64 @@ -76188,8 +76872,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: - - *239 - - *240 + - *242 + - *243 - name: dir description: The alternate path to look for a README file in: path @@ -76209,9 +76893,9 @@ paths: description: Response content: application/json: - schema: *488 + schema: *491 examples: - default: *489 + default: *492 '404': *7 '422': *16 x-github: @@ -76233,8 +76917,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -76244,7 +76928,7 @@ paths: application/json: schema: type: array - items: &490 + items: &493 title: Release description: A release. type: object @@ -76307,7 +76991,7 @@ paths: author: *19 assets: type: array - items: &491 + items: &494 title: Release Asset description: Data related to a release. type: object @@ -76378,7 +77062,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *59 + reactions: *62 required: - assets_url - upload_url @@ -76488,8 +77172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -76565,9 +77249,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *493 examples: - default: &494 + default: &497 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -76668,9 +77352,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: - - *239 - - *240 - - &492 + - *242 + - *243 + - &495 name: asset_id description: The unique identifier of the asset. in: path @@ -76682,9 +77366,9 @@ paths: description: Response content: application/json: - schema: *491 + schema: *494 examples: - default: &493 + default: &496 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 @@ -76718,7 +77402,7 @@ paths: type: User site_admin: false '404': *7 - '302': *384 + '302': *387 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76734,9 +77418,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: - - *239 - - *240 - - *492 + - *242 + - *243 + - *495 requestBody: required: false content: @@ -76764,9 +77448,9 @@ paths: description: Response content: application/json: - schema: *491 + schema: *494 examples: - default: *493 + default: *496 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76782,9 +77466,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: - - *239 - - *240 - - *492 + - *242 + - *243 + - *495 responses: '204': description: Response @@ -76808,8 +77492,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -76894,16 +77578,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response content: application/json: - schema: *490 + schema: *493 examples: - default: *494 + default: *497 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76920,8 +77604,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: - - *239 - - *240 + - *242 + - *243 - name: tag description: tag parameter in: path @@ -76934,9 +77618,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *493 examples: - default: *494 + default: *497 '404': *7 x-github: githubCloudOnly: false @@ -76958,9 +77642,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: - - *239 - - *240 - - &495 + - *242 + - *243 + - &498 name: release_id description: The unique identifier of the release. in: path @@ -76974,9 +77658,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: *490 + schema: *493 examples: - default: *494 + default: *497 '401': description: Unauthorized x-github: @@ -76994,9 +77678,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: - - *239 - - *240 - - *495 + - *242 + - *243 + - *498 requestBody: required: false content: @@ -77060,9 +77744,9 @@ paths: description: Response content: application/json: - schema: *490 + schema: *493 examples: - default: *494 + default: *497 '404': description: Not Found if the discussion category name is invalid content: @@ -77083,9 +77767,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: - - *239 - - *240 - - *495 + - *242 + - *243 + - *498 responses: '204': description: Response @@ -77105,9 +77789,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: - - *239 - - *240 - - *495 + - *242 + - *243 + - *498 - *18 - *20 responses: @@ -77117,7 +77801,7 @@ paths: application/json: schema: type: array - items: *491 + items: *494 examples: default: value: @@ -77197,9 +77881,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: - - *239 - - *240 - - *495 + - *242 + - *243 + - *498 - name: name in: query required: true @@ -77225,7 +77909,7 @@ paths: description: Response for successful upload content: application/json: - schema: *491 + schema: *494 examples: response-for-successful-upload: value: @@ -77279,9 +77963,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: - - *239 - - *240 - - *495 + - *242 + - *243 + - *498 - 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. @@ -77305,9 +77989,9 @@ paths: application/json: schema: type: array - items: *232 + items: *235 examples: - default: *234 + default: *237 headers: Link: *39 '404': *7 @@ -77328,9 +78012,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: - - *239 - - *240 - - *495 + - *242 + - *243 + - *498 requestBody: required: true content: @@ -77360,16 +78044,16 @@ paths: description: Reaction exists content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '201': description: Reaction created content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 '422': *16 x-github: githubCloudOnly: false @@ -77391,10 +78075,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: - - *239 - - *240 - - *495 - - *235 + - *242 + - *243 + - *498 + - *238 responses: '204': description: Response @@ -77418,9 +78102,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: - - *239 - - *240 - - *307 + - *242 + - *243 + - *310 - *18 - *20 responses: @@ -77436,8 +78120,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *496 - - &498 + - *499 + - &501 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -77456,54 +78140,54 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *497 - - *498 - - allOf: - - *499 - - *498 - allOf: - *500 - - *498 - - allOf: - *501 - - *498 - allOf: - *502 - - *498 + - *501 - allOf: - *503 - - *498 + - *501 - allOf: - *504 - - *498 + - *501 - allOf: - *505 - - *498 + - *501 - allOf: - *506 - - *498 + - *501 - allOf: - *507 - - *498 + - *501 - allOf: - *508 - - *498 + - *501 - allOf: - *509 - - *498 + - *501 - allOf: - *510 - - *498 + - *501 - allOf: - *511 - - *498 + - *501 - allOf: - *512 - - *498 + - *501 - allOf: - *513 - - *498 + - *501 + - allOf: + - *514 + - *501 + - allOf: + - *515 + - *501 + - allOf: + - *516 + - *501 examples: default: value: @@ -77542,8 +78226,8 @@ paths: category: repos subcategory: rules parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 - name: includes_parents @@ -77554,7 +78238,7 @@ paths: schema: type: boolean default: true - - *514 + - *517 responses: '200': description: Response @@ -77562,7 +78246,7 @@ paths: application/json: schema: type: array - items: *212 + items: *215 examples: default: value: @@ -77609,8 +78293,8 @@ paths: category: repos subcategory: rules parameters: - - *239 - - *240 + - *242 + - *243 requestBody: description: Request body required: true @@ -77630,16 +78314,16 @@ paths: - tag - push default: branch - enforcement: *208 + enforcement: *211 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *209 - conditions: *206 + items: *212 + conditions: *209 rules: type: array description: An array of rules within the ruleset. - items: *211 + items: *214 required: - name - enforcement @@ -77670,9 +78354,9 @@ paths: description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: &524 + default: &527 value: id: 42 name: super cool ruleset @@ -77719,12 +78403,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: - - *239 - - *240 - - *515 - - *516 - - *517 + - *242 + - *243 - *518 + - *519 + - *520 + - *521 - *18 - *20 responses: @@ -77732,9 +78416,9 @@ paths: description: Response content: application/json: - schema: *519 + schema: *522 examples: - default: *520 + default: *523 '404': *7 '500': *41 x-github: @@ -77755,17 +78439,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *239 - - *240 - - *521 + - *242 + - *243 + - *524 responses: '200': description: Response content: application/json: - schema: *522 + schema: *525 examples: - default: *523 + default: *526 '404': *7 '500': *41 x-github: @@ -77793,8 +78477,8 @@ paths: category: repos subcategory: rules parameters: - - *239 - - *240 + - *242 + - *243 - name: ruleset_id description: The ID of the ruleset. in: path @@ -77814,9 +78498,9 @@ paths: description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: *524 + default: *527 '404': *7 '500': *41 put: @@ -77834,8 +78518,8 @@ paths: category: repos subcategory: rules parameters: - - *239 - - *240 + - *242 + - *243 - name: ruleset_id description: The ID of the ruleset. in: path @@ -77860,16 +78544,16 @@ paths: - branch - tag - push - enforcement: *208 + enforcement: *211 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *209 - conditions: *206 + items: *212 + conditions: *209 rules: description: An array of rules within the ruleset. type: array - items: *211 + items: *214 examples: default: value: @@ -77897,9 +78581,9 @@ paths: description: Response content: application/json: - schema: *212 + schema: *215 examples: - default: *524 + default: *527 '404': *7 '500': *41 delete: @@ -77917,8 +78601,8 @@ paths: category: repos subcategory: rules parameters: - - *239 - - *240 + - *242 + - *243 - name: ruleset_id description: The ID of the ruleset. in: path @@ -77946,20 +78630,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: - - *239 - - *240 - - *214 - - *215 - - *216 + - *242 + - *243 - *217 - - *42 - - *20 - - *18 - - *525 - - *526 - *218 - *219 - *220 + - *42 + - *20 + - *18 + - *528 + - *529 + - *221 + - *222 + - *223 responses: '200': description: Response @@ -77967,7 +78651,7 @@ paths: application/json: schema: type: array - items: &529 + items: &532 type: object properties: number: *48 @@ -77986,8 +78670,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *527 - resolution: *528 + state: *530 + resolution: *531 resolved_at: type: string format: date-time @@ -78130,7 +78814,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78152,15 +78836,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: - - *239 - - *240 - - *339 + - *242 + - *243 + - *342 responses: '200': description: Response content: application/json: - schema: *529 + schema: *532 examples: default: value: @@ -78187,7 +78871,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78208,9 +78892,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: - - *239 - - *240 - - *339 + - *242 + - *243 + - *342 requestBody: required: true content: @@ -78218,8 +78902,8 @@ paths: schema: type: object properties: - state: *527 - resolution: *528 + state: *530 + resolution: *531 resolution_comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -78237,7 +78921,7 @@ paths: description: Response content: application/json: - schema: *529 + schema: *532 examples: default: value: @@ -78286,7 +78970,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *60 + '503': *63 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -78308,9 +78992,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: - - *239 - - *240 - - *339 + - *242 + - *243 + - *342 - *20 - *18 responses: @@ -78321,7 +79005,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &661 + items: &664 type: object properties: type: @@ -78658,7 +79342,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78680,8 +79364,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -78689,14 +79373,14 @@ paths: schema: type: object properties: - reason: &531 + reason: &534 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *530 + placeholder_id: *533 required: - reason - placeholder_id @@ -78713,7 +79397,7 @@ paths: schema: type: object properties: - reason: *531 + reason: *534 expire_at: type: string format: date-time @@ -78736,7 +79420,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *60 + '503': *63 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -78758,8 +79442,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *239 - - *240 + - *242 + - *243 - *42 - name: sort description: The property to sort the results by. @@ -78803,9 +79487,9 @@ paths: application/json: schema: type: array - items: *532 + items: *535 examples: - default: *533 + default: *536 '400': *15 '404': *7 x-github: @@ -78828,8 +79512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -78902,7 +79586,7 @@ paths: login: type: string description: The username of the user credited. - type: *223 + type: *226 required: - login - type @@ -78989,9 +79673,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *535 examples: - default: &535 + default: &538 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -79224,8 +79908,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -79329,7 +80013,7 @@ paths: description: Response content: application/json: - schema: *532 + schema: *535 examples: default: value: @@ -79476,17 +80160,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: - - *239 - - *240 - - *534 + - *242 + - *243 + - *537 responses: '200': description: Response content: application/json: - schema: *532 + schema: *535 examples: - default: *535 + default: *538 '403': *29 '404': *7 x-github: @@ -79510,9 +80194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: - - *239 - - *240 - - *534 + - *242 + - *243 + - *537 requestBody: required: true content: @@ -79585,7 +80269,7 @@ paths: login: type: string description: The username of the user credited. - type: *223 + type: *226 required: - login - type @@ -79671,17 +80355,17 @@ paths: description: Response content: application/json: - schema: *532 + schema: *535 examples: - default: *535 - add_credit: *535 + default: *538 + add_credit: *538 '403': *29 '404': *7 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *94 + schema: *97 examples: invalid_state_transition: value: @@ -79712,11 +80396,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: - - *239 - - *240 - - *534 + - *242 + - *243 + - *537 responses: - '202': *96 + '202': *99 '400': *15 '403': *29 '404': *7 @@ -79741,17 +80425,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: - - *239 - - *240 - - *534 + - *242 + - *243 + - *537 responses: '202': description: Response content: application/json: - schema: *250 + schema: *253 examples: - default: *252 + default: *255 '400': *15 '422': *16 '403': *29 @@ -79777,8 +80461,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -79877,8 +80561,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -79887,7 +80571,7 @@ paths: application/json: schema: type: array - items: &536 + items: &539 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -79899,8 +80583,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *96 - '204': *134 + '202': *99 + '204': *137 '422': description: Repository contains more than 10,000 commits x-github: @@ -79920,8 +80604,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -79969,8 +80653,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *96 - '204': *134 + '202': *99 + '204': *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79997,8 +80681,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -80071,8 +80755,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *96 - '204': *134 + '202': *99 + '204': *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80094,8 +80778,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -80249,8 +80933,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -80260,7 +80944,7 @@ paths: application/json: schema: type: array - items: *536 + items: *539 examples: default: value: @@ -80273,7 +80957,7 @@ paths: - - 0 - 2 - 21 - '204': *134 + '204': *137 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80293,8 +80977,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: - - *239 - - *240 + - *242 + - *243 - name: sha in: path required: true @@ -80348,7 +81032,7 @@ paths: description: Response content: application/json: - schema: *537 + schema: *540 examples: default: value: @@ -80402,8 +81086,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -80415,7 +81099,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 x-github: @@ -80435,14 +81119,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &538 + schema: &541 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -80510,8 +81194,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: false content: @@ -80537,7 +81221,7 @@ paths: description: Response content: application/json: - schema: *538 + schema: *541 examples: default: value: @@ -80564,8 +81248,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -80585,8 +81269,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -80665,8 +81349,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -80674,7 +81358,7 @@ paths: application/json: schema: type: array - items: &539 + items: &542 title: Tag protection description: Tag protection type: object @@ -80726,8 +81410,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: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -80750,7 +81434,7 @@ paths: description: Response content: application/json: - schema: *539 + schema: *542 examples: default: value: @@ -80781,8 +81465,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: - - *239 - - *240 + - *242 + - *243 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -80819,8 +81503,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *239 - - *240 + - *242 + - *243 - name: ref in: path required: true @@ -80856,8 +81540,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: - - *239 - - *240 + - *242 + - *243 - *18 - *20 responses: @@ -80867,9 +81551,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - default: *183 + default: *186 headers: Link: *39 '404': *7 @@ -80889,8 +81573,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: - - *239 - - *240 + - *242 + - *243 - *20 - *18 responses: @@ -80898,7 +81582,7 @@ paths: description: Response content: application/json: - schema: &540 + schema: &543 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -80910,7 +81594,7 @@ paths: required: - names examples: - default: &541 + default: &544 value: names: - octocat @@ -80933,8 +81617,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -80965,9 +81649,9 @@ paths: description: Response content: application/json: - schema: *540 + schema: *543 examples: - default: *541 + default: *544 '404': *7 '422': *8 x-github: @@ -80988,9 +81672,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: - - *239 - - *240 - - &542 + - *242 + - *243 + - &545 name: per description: The time frame to display results for. in: query @@ -81019,7 +81703,7 @@ paths: example: 128 clones: type: array - items: &543 + items: &546 title: Traffic type: object properties: @@ -81106,8 +81790,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -81197,8 +81881,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: - - *239 - - *240 + - *242 + - *243 responses: '200': description: Response @@ -81258,9 +81942,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: - - *239 - - *240 - - *542 + - *242 + - *243 + - *545 responses: '200': description: Response @@ -81279,7 +81963,7 @@ paths: example: 3782 views: type: array - items: *543 + items: *546 required: - uniques - count @@ -81356,8 +82040,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: - - *239 - - *240 + - *242 + - *243 requestBody: required: true content: @@ -81393,7 +82077,7 @@ paths: description: Response content: application/json: - schema: *110 + schema: *113 examples: default: value: @@ -81631,8 +82315,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -81655,8 +82339,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -81678,8 +82362,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -81705,8 +82389,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *239 - - *240 + - *242 + - *243 - name: ref in: path required: true @@ -81798,9 +82482,9 @@ paths: description: Response content: application/json: - schema: *250 + schema: *253 examples: - default: *252 + default: *255 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -81841,7 +82525,7 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: default: value: @@ -82030,7 +82714,7 @@ paths: html_url: type: string format: uri - repository: *110 + repository: *113 score: type: number file_size: @@ -82048,7 +82732,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &544 + text_matches: &547 title: Search Result Text Matches type: array items: @@ -82162,7 +82846,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *37 - '503': *60 + '503': *63 '422': *16 '403': *29 x-github: @@ -82210,7 +82894,7 @@ paths: enum: - author-date - committer-date - - &545 + - &548 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 @@ -82281,7 +82965,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *305 + properties: *308 nullable: true comment_count: type: integer @@ -82301,7 +82985,7 @@ paths: url: type: string format: uri - verification: *419 + verification: *422 required: - author - committer @@ -82320,7 +83004,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *305 + properties: *308 nullable: true parents: type: array @@ -82333,12 +83017,12 @@ paths: type: string sha: type: string - repository: *110 + repository: *113 score: type: number node_id: type: string - text_matches: *544 + text_matches: *547 required: - sha - node_id @@ -82530,7 +83214,7 @@ paths: - interactions - created - updated - - *545 + - *548 - *18 - *20 responses: @@ -82635,8 +83319,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *371 - required: *372 + properties: *374 + required: *375 nullable: true comments: type: integer @@ -82650,7 +83334,7 @@ paths: type: string format: date-time nullable: true - text_matches: *544 + text_matches: *547 pull_request: type: object properties: @@ -82683,10 +83367,10 @@ paths: type: string score: type: number - author_association: *58 + author_association: *61 draft: type: boolean - repository: *55 + repository: *58 body_html: type: string body_text: @@ -82703,9 +83387,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 - reactions: *59 + properties: *59 + required: *60 + reactions: *62 required: - assignee - closed_at @@ -82821,7 +83505,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *60 + '503': *63 '422': *16 '304': *37 '403': *29 @@ -82874,7 +83558,7 @@ paths: enum: - created - updated - - *545 + - *548 - *18 - *20 responses: @@ -82918,7 +83602,7 @@ paths: nullable: true score: type: number - text_matches: *544 + text_matches: *547 required: - id - node_id @@ -83003,7 +83687,7 @@ paths: - forks - help-wanted-issues - updated - - *545 + - *548 - *18 - *20 responses: @@ -83222,8 +83906,8 @@ paths: title: License Simple description: License Simple type: object - properties: *73 - required: *74 + properties: *76 + required: *77 nullable: true permissions: type: object @@ -83242,7 +83926,7 @@ paths: - admin - pull - push - text_matches: *544 + text_matches: *547 temp_clone_token: type: string allow_merge_commit: @@ -83444,7 +84128,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *60 + '503': *63 '422': *16 '304': *37 x-github: @@ -83542,7 +84226,7 @@ paths: type: string format: uri nullable: true - text_matches: *544 + text_matches: *547 related: type: array nullable: true @@ -83733,7 +84417,7 @@ paths: - followers - repositories - joined - - *545 + - *548 - *18 - *20 responses: @@ -83837,7 +84521,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *544 + text_matches: *547 blog: type: string nullable: true @@ -83896,7 +84580,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *37 - '503': *60 + '503': *63 '422': *16 x-github: githubCloudOnly: false @@ -83916,7 +84600,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &546 + - &549 name: team_id description: The unique identifier of the team. in: path @@ -83928,9 +84612,9 @@ paths: description: Response content: application/json: - schema: *224 + schema: *227 examples: - default: *225 + default: *228 '404': *7 x-github: githubCloudOnly: false @@ -83957,7 +84641,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *546 + - *549 requestBody: required: true content: @@ -84020,16 +84704,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *224 + schema: *227 examples: - default: *225 + default: *228 '201': description: Response content: application/json: - schema: *224 + schema: *227 examples: - default: *225 + default: *228 '404': *7 '422': *16 '403': *29 @@ -84057,7 +84741,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *546 + - *549 responses: '204': description: Response @@ -84088,7 +84772,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *546 + - *549 - *42 - *18 - *20 @@ -84099,9 +84783,9 @@ paths: application/json: schema: type: array - items: *226 + items: *229 examples: - default: *547 + default: *550 headers: Link: *39 x-github: @@ -84130,7 +84814,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *546 + - *549 requestBody: required: true content: @@ -84164,9 +84848,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: *227 + default: *230 x-github: triggersNotification: true githubCloudOnly: false @@ -84193,16 +84877,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *546 - - *228 + - *549 + - *231 responses: '200': description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: *227 + default: *230 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84227,8 +84911,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *546 - - *228 + - *549 + - *231 requestBody: required: false content: @@ -84251,9 +84935,9 @@ paths: description: Response content: application/json: - schema: *226 + schema: *229 examples: - default: *548 + default: *551 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84278,8 +84962,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *546 - - *228 + - *549 + - *231 responses: '204': description: Response @@ -84308,8 +84992,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *546 - - *228 + - *549 + - *231 - *42 - *18 - *20 @@ -84320,9 +85004,9 @@ paths: application/json: schema: type: array - items: *229 + items: *232 examples: - default: *549 + default: *552 headers: Link: *39 x-github: @@ -84351,8 +85035,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *546 - - *228 + - *549 + - *231 requestBody: required: true content: @@ -84374,9 +85058,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *232 examples: - default: *230 + default: *233 x-github: triggersNotification: true githubCloudOnly: false @@ -84403,17 +85087,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *546 - - *228 + - *549 - *231 + - *234 responses: '200': description: Response content: application/json: - schema: *229 + schema: *232 examples: - default: *230 + default: *233 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84438,9 +85122,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *546 - - *228 + - *549 - *231 + - *234 requestBody: required: true content: @@ -84462,9 +85146,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *232 examples: - default: *550 + default: *553 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84489,9 +85173,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *546 - - *228 + - *549 - *231 + - *234 responses: '204': description: Response @@ -84520,9 +85204,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *546 - - *228 + - *549 - *231 + - *234 - 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. @@ -84548,9 +85232,9 @@ paths: application/json: schema: type: array - items: *232 + items: *235 examples: - default: *234 + default: *237 headers: Link: *39 x-github: @@ -84579,9 +85263,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *546 - - *228 + - *549 - *231 + - *234 requestBody: required: true content: @@ -84613,9 +85297,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84641,8 +85325,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *546 - - *228 + - *549 + - *231 - 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. @@ -84668,9 +85352,9 @@ paths: application/json: schema: type: array - items: *232 + items: *235 examples: - default: *234 + default: *237 headers: Link: *39 x-github: @@ -84699,8 +85383,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *546 - - *228 + - *549 + - *231 requestBody: required: true content: @@ -84732,9 +85416,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *235 examples: - default: *233 + default: *236 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -84758,7 +85442,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *546 + - *549 - *18 - *20 responses: @@ -84768,9 +85452,9 @@ paths: application/json: schema: type: array - items: *163 + items: *166 examples: - default: *164 + default: *167 headers: Link: *39 x-github: @@ -84796,7 +85480,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *546 + - *549 - name: role description: Filters members returned by their role in the team. in: query @@ -84819,7 +85503,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 '404': *7 @@ -84847,8 +85531,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *546 - - *123 + - *549 + - *126 responses: '204': description: if user is a member @@ -84884,8 +85568,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *546 - - *123 + - *549 + - *126 responses: '204': description: Response @@ -84924,8 +85608,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *546 - - *123 + - *549 + - *126 responses: '204': description: Response @@ -84961,16 +85645,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *546 - - *123 + - *549 + - *126 responses: '200': description: Response content: application/json: - schema: *236 + schema: *239 examples: - response-if-user-is-a-team-maintainer: *551 + response-if-user-is-a-team-maintainer: *554 '404': *7 x-github: githubCloudOnly: false @@ -85003,8 +85687,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *546 - - *123 + - *549 + - *126 requestBody: required: false content: @@ -85029,9 +85713,9 @@ paths: description: Response content: application/json: - schema: *236 + schema: *239 examples: - response-if-users-membership-with-team-is-now-pending: *552 + response-if-users-membership-with-team-is-now-pending: *555 '403': description: Forbidden if team synchronization is set up '422': @@ -85065,8 +85749,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *546 - - *123 + - *549 + - *126 responses: '204': description: Response @@ -85095,7 +85779,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *546 + - *549 - *18 - *20 responses: @@ -85105,9 +85789,9 @@ paths: application/json: schema: type: array - items: *237 + items: *240 examples: - default: *553 + default: *556 headers: Link: *39 '404': *7 @@ -85134,16 +85818,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *546 - - *238 + - *549 + - *241 responses: '200': description: Response content: application/json: - schema: *237 + schema: *240 examples: - default: *554 + default: *557 '404': description: Not Found if project is not managed by this team x-github: @@ -85168,8 +85852,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *546 - - *238 + - *549 + - *241 requestBody: required: false content: @@ -85237,8 +85921,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *546 - - *238 + - *549 + - *241 responses: '204': description: Response @@ -85265,7 +85949,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *546 + - *549 - *18 - *20 responses: @@ -85275,9 +85959,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 '404': *7 @@ -85307,15 +85991,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *546 - - *239 - - *240 + - *549 + - *242 + - *243 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *555 + schema: *558 examples: alternative-response-with-extra-repository-information: value: @@ -85466,9 +86150,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *546 - - *239 - - *240 + - *549 + - *242 + - *243 requestBody: required: false content: @@ -85518,9 +86202,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *546 - - *239 - - *240 + - *549 + - *242 + - *243 responses: '204': description: Response @@ -85545,7 +86229,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *546 + - *549 - *18 - *20 responses: @@ -85555,9 +86239,9 @@ paths: application/json: schema: type: array - items: *166 + items: *169 examples: - response-if-child-teams-exist: *556 + response-if-child-teams-exist: *559 headers: Link: *39 '404': *7 @@ -85590,7 +86274,7 @@ paths: application/json: schema: oneOf: - - &558 + - &561 title: Private User description: Private User type: object @@ -85793,7 +86477,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *557 + - *560 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -85946,7 +86630,7 @@ paths: description: Response content: application/json: - schema: *558 + schema: *561 examples: default: value: @@ -86025,7 +86709,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 '304': *37 '404': *7 '403': *29 @@ -86048,7 +86732,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: - - *123 + - *126 responses: '204': description: If the user is blocked @@ -86076,7 +86760,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *123 + - *126 responses: '204': description: Response @@ -86100,7 +86784,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *123 + - *126 responses: '204': description: Response @@ -86149,9 +86833,9 @@ paths: type: integer codespaces: type: array - items: *170 + items: *173 examples: - default: *171 + default: *174 '304': *37 '500': *41 '401': *25 @@ -86290,21 +86974,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '401': *25 '403': *29 '404': *7 - '503': *60 + '503': *63 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -86344,7 +87028,7 @@ paths: type: integer secrets: type: array - items: &559 + items: &562 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -86384,7 +87068,7 @@ paths: - visibility - selected_repositories_url examples: - default: *359 + default: *362 headers: Link: *39 x-github: @@ -86454,13 +87138,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *118 + - *121 responses: '200': description: Response content: application/json: - schema: *559 + schema: *562 examples: default: value: @@ -86490,7 +87174,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *118 + - *121 requestBody: required: true content: @@ -86535,7 +87219,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -86563,7 +87247,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *118 + - *121 responses: '204': description: Response @@ -86588,7 +87272,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *118 + - *121 responses: '200': description: Response @@ -86604,9 +87288,9 @@ paths: type: integer repositories: type: array - items: *110 + items: *113 examples: - default: *560 + default: *563 '401': *25 '403': *29 '404': *7 @@ -86631,7 +87315,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *118 + - *121 requestBody: required: true content: @@ -86685,7 +87369,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *118 + - *121 - name: repository_id in: path required: true @@ -86718,7 +87402,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *118 + - *121 - name: repository_id in: path required: true @@ -86750,15 +87434,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *172 + - *175 responses: '200': description: Response content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '304': *37 '500': *41 '401': *25 @@ -86784,7 +87468,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *172 + - *175 requestBody: required: false content: @@ -86814,9 +87498,9 @@ paths: description: Response content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '401': *25 '403': *29 '404': *7 @@ -86838,9 +87522,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *172 + - *175 responses: - '202': *96 + '202': *99 '304': *37 '500': *41 '401': *25 @@ -86867,13 +87551,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *172 + - *175 responses: '202': description: Response content: application/json: - schema: &561 + schema: &564 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -86914,7 +87598,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &562 + default: &565 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -86946,7 +87630,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *172 + - *175 - name: export_id in: path required: true @@ -86959,9 +87643,9 @@ paths: description: Response content: application/json: - schema: *561 + schema: *564 examples: - default: *562 + default: *565 '404': *7 x-github: githubCloudOnly: false @@ -86982,7 +87666,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *172 + - *175 responses: '200': description: Response @@ -86998,9 +87682,9 @@ paths: type: integer machines: type: array - items: *563 + items: *566 examples: - default: *564 + default: *567 '304': *37 '500': *41 '401': *25 @@ -87029,7 +87713,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *172 + - *175 requestBody: required: true content: @@ -87079,13 +87763,13 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *250 + repository: *253 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *357 - required: *358 + properties: *360 + required: *361 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -87859,15 +88543,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *172 + - *175 responses: '200': description: Response content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '304': *37 '500': *41 '400': *15 @@ -87879,7 +88563,7 @@ paths: schema: *3 '403': *29 '404': *7 - '409': *131 + '409': *134 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -87899,15 +88583,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *172 + - *175 responses: '200': description: Response content: application/json: - schema: *170 + schema: *173 examples: - default: *356 + default: *359 '500': *41 '401': *25 '403': *29 @@ -87937,9 +88621,9 @@ paths: application/json: schema: type: array - items: *184 + items: *187 examples: - default: &577 + default: &580 value: - id: 197 name: hello_docker @@ -88040,7 +88724,7 @@ paths: application/json: schema: type: array - items: &565 + items: &568 title: Email description: Email type: object @@ -88105,9 +88789,9 @@ paths: application/json: schema: type: array - items: *565 + items: *568 examples: - default: &579 + default: &582 value: - email: octocat@github.com verified: true @@ -88182,7 +88866,7 @@ paths: application/json: schema: type: array - items: *565 + items: *568 examples: default: value: @@ -88292,7 +88976,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 '304': *37 @@ -88325,7 +89009,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 '304': *37 @@ -88347,7 +89031,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: - - *123 + - *126 responses: '204': description: if the person is followed by the authenticated user @@ -88377,7 +89061,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *123 + - *126 responses: '204': description: Response @@ -88401,7 +89085,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *123 + - *126 responses: '204': description: Response @@ -88437,7 +89121,7 @@ paths: application/json: schema: type: array - items: &566 + items: &569 title: GPG Key description: A unique encryption key type: object @@ -88568,7 +89252,7 @@ paths: - subkeys - revoked examples: - default: &590 + default: &593 value: - id: 3 name: Octocat's GPG Key @@ -88653,9 +89337,9 @@ paths: description: Response content: application/json: - schema: *566 + schema: *569 examples: - default: &567 + default: &570 value: id: 3 name: Octocat's GPG Key @@ -88712,7 +89396,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &568 + - &571 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -88724,9 +89408,9 @@ paths: description: Response content: application/json: - schema: *566 + schema: *569 examples: - default: *567 + default: *570 '404': *7 '304': *37 '403': *29 @@ -88749,7 +89433,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *568 + - *571 responses: '204': description: Response @@ -88938,9 +89622,9 @@ paths: type: string repositories: type: array - items: *55 + items: *58 examples: - default: *569 + default: *572 headers: Link: *39 '404': *7 @@ -88965,7 +89649,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *101 + - *104 responses: '204': description: Response @@ -88991,7 +89675,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *101 + - *104 responses: '204': description: Response @@ -89025,12 +89709,12 @@ paths: application/json: schema: anyOf: - - *161 + - *164 - type: object properties: {} additionalProperties: false examples: - default: *162 + default: *165 '204': description: Response when there are no restrictions x-github: @@ -89054,7 +89738,7 @@ paths: required: true content: application/json: - schema: *430 + schema: *433 examples: default: value: @@ -89065,7 +89749,7 @@ paths: description: Response content: application/json: - schema: *161 + schema: *164 examples: default: value: @@ -89146,7 +89830,7 @@ paths: - closed - all default: open - - *167 + - *170 - name: sort description: What to sort results by. in: query @@ -89159,7 +89843,7 @@ paths: - comments default: created - *42 - - *62 + - *65 - *18 - *20 responses: @@ -89169,9 +89853,9 @@ paths: application/json: schema: type: array - items: *72 + items: *75 examples: - default: *168 + default: *171 headers: Link: *39 '404': *7 @@ -89204,7 +89888,7 @@ paths: application/json: schema: type: array - items: &570 + items: &573 title: Key description: Key type: object @@ -89301,9 +89985,9 @@ paths: description: Response content: application/json: - schema: *570 + schema: *573 examples: - default: &571 + default: &574 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -89336,15 +90020,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *458 + - *461 responses: '200': description: Response content: application/json: - schema: *570 + schema: *573 examples: - default: *571 + default: *574 '404': *7 '304': *37 '403': *29 @@ -89367,7 +90051,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *458 + - *461 responses: '204': description: Response @@ -89400,7 +90084,7 @@ paths: application/json: schema: type: array - items: &572 + items: &575 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -89457,7 +90141,7 @@ paths: - id - type - login - plan: *76 + plan: *79 required: - billing_cycle - next_billing_date @@ -89468,7 +90152,7 @@ paths: - account - plan examples: - default: &573 + default: &576 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -89530,9 +90214,9 @@ paths: application/json: schema: type: array - items: *572 + items: *575 examples: - default: *573 + default: *576 headers: Link: *39 '304': *37 @@ -89572,7 +90256,7 @@ paths: application/json: schema: type: array - items: *174 + items: *177 examples: default: value: @@ -89674,13 +90358,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *91 + - *94 responses: '200': description: Response content: application/json: - schema: *174 + schema: *177 examples: default: value: @@ -89738,7 +90422,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *91 + - *94 requestBody: required: true content: @@ -89763,7 +90447,7 @@ paths: description: Response content: application/json: - schema: *174 + schema: *177 examples: default: value: @@ -89831,7 +90515,7 @@ paths: application/json: schema: type: array - items: *176 + items: *179 examples: default: value: @@ -90084,7 +90768,7 @@ paths: description: Response content: application/json: - schema: *176 + schema: *179 examples: default: value: @@ -90264,7 +90948,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *177 + - *180 - name: exclude in: query required: false @@ -90277,7 +90961,7 @@ paths: description: Response content: application/json: - schema: *176 + schema: *179 examples: default: value: @@ -90471,7 +91155,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *177 + - *180 responses: '302': description: Response @@ -90497,7 +91181,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *177 + - *180 responses: '204': description: Response @@ -90526,8 +91210,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *177 - - *574 + - *180 + - *577 responses: '204': description: Response @@ -90551,7 +91235,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *177 + - *180 - *18 - *20 responses: @@ -90561,9 +91245,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 '404': *7 @@ -90598,9 +91282,9 @@ paths: application/json: schema: type: array - items: *173 + items: *176 examples: - default: *575 + default: *578 headers: Link: *39 '304': *37 @@ -90642,7 +91326,7 @@ paths: - docker - nuget - container - - *576 + - *579 - *20 - *18 responses: @@ -90652,10 +91336,10 @@ paths: application/json: schema: type: array - items: *184 + items: *187 examples: - default: *577 - '400': *578 + default: *580 + '400': *581 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -90675,16 +91359,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *186 - - *187 + - *189 + - *190 responses: '200': description: Response content: application/json: - schema: *184 + schema: *187 examples: - default: &591 + default: &594 value: id: 40201 name: octo-name @@ -90797,8 +91481,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *186 - - *187 + - *189 + - *190 responses: '204': description: Response @@ -90828,8 +91512,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *186 - - *187 + - *189 + - *190 - name: token description: package token schema: @@ -90861,8 +91545,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: - - *186 - - *187 + - *189 + - *190 - *20 - *18 - name: state @@ -90882,7 +91566,7 @@ paths: application/json: schema: type: array - items: *188 + items: *191 examples: default: value: @@ -90931,15 +91615,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *186 - - *187 - *189 + - *190 + - *192 responses: '200': description: Response content: application/json: - schema: *188 + schema: *191 examples: default: value: @@ -90975,9 +91659,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *186 - - *187 - *189 + - *190 + - *192 responses: '204': description: Response @@ -91007,9 +91691,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *186 - - *187 - *189 + - *190 + - *192 responses: '204': description: Response @@ -91065,7 +91749,7 @@ paths: description: Response content: application/json: - schema: *197 + schema: *200 examples: default: value: @@ -91134,9 +91818,9 @@ paths: application/json: schema: type: array - items: *565 + items: *568 examples: - default: *579 + default: *582 headers: Link: *39 '304': *37 @@ -91247,9 +91931,9 @@ paths: application/json: schema: type: array - items: *55 + items: *58 examples: - default: &586 + default: &589 summary: Default response value: - id: 1296269 @@ -91551,9 +92235,9 @@ paths: description: Response content: application/json: - schema: *250 + schema: *253 examples: - default: *252 + default: *255 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -91591,9 +92275,9 @@ paths: application/json: schema: type: array - items: *432 + items: *435 examples: - default: *580 + default: *583 headers: Link: *39 '304': *37 @@ -91616,12 +92300,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *165 + - *168 responses: '204': description: Response '403': *29 - '409': *131 + '409': *134 '404': *7 '304': *37 x-github: @@ -91639,11 +92323,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *165 + - *168 responses: '204': description: Response - '409': *131 + '409': *134 '304': *37 '404': *7 '403': *29 @@ -91672,7 +92356,7 @@ paths: application/json: schema: type: array - items: &581 + items: &584 title: Social account description: Social media account type: object @@ -91687,7 +92371,7 @@ paths: - provider - url examples: - default: &582 + default: &585 value: - provider: twitter url: https://twitter.com/github @@ -91749,9 +92433,9 @@ paths: application/json: schema: type: array - items: *581 + items: *584 examples: - default: *582 + default: *585 '422': *16 '304': *37 '404': *7 @@ -91838,7 +92522,7 @@ paths: application/json: schema: type: array - items: &583 + items: &586 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -91858,7 +92542,7 @@ paths: - title - created_at examples: - default: &598 + default: &601 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -91924,9 +92608,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *586 examples: - default: &584 + default: &587 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -91957,7 +92641,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: - - &585 + - &588 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -91969,9 +92653,9 @@ paths: description: Response content: application/json: - schema: *583 + schema: *586 examples: - default: *584 + default: *587 '404': *7 '304': *37 '403': *29 @@ -91994,7 +92678,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: - - *585 + - *588 responses: '204': description: Response @@ -92023,7 +92707,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &599 + - &602 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 @@ -92046,13 +92730,13 @@ paths: application/json: schema: type: array - items: *55 + items: *58 examples: - default-response: *586 + default-response: *589 application/vnd.github.v3.star+json: schema: type: array - items: &600 + items: &603 title: Starred Repository description: Starred Repository type: object @@ -92060,7 +92744,7 @@ paths: starred_at: type: string format: date-time - repo: *55 + repo: *58 required: - starred_at - repo @@ -92208,8 +92892,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: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response if this repository is starred by you @@ -92237,8 +92921,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -92262,8 +92946,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: - - *239 - - *240 + - *242 + - *243 responses: '204': description: Response @@ -92296,9 +92980,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 '304': *37 @@ -92335,7 +93019,7 @@ paths: application/json: schema: type: array - items: *224 + items: *227 examples: default: value: @@ -92411,7 +93095,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *78 + - *81 responses: '200': description: Response @@ -92419,10 +93103,10 @@ paths: application/json: schema: oneOf: - - *558 - - *557 + - *561 + - *560 examples: - default-response: &588 + default-response: &591 summary: Default response value: login: octocat @@ -92457,7 +93141,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &589 + response-with-git-hub-plan-information: &592 summary: Response with GitHub plan information value: login: octocat @@ -92517,7 +93201,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *587 + - *590 - *18 responses: '200': @@ -92528,7 +93212,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: example: ; rel="next" @@ -92556,7 +93240,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *123 + - *126 responses: '200': description: Response @@ -92564,11 +93248,11 @@ paths: application/json: schema: oneOf: - - *558 - - *557 + - *561 + - *560 examples: - default-response: *588 - response-with-git-hub-plan-information: *589 + default-response: *591 + response-with-git-hub-plan-information: *592 '404': *7 x-github: githubCloudOnly: false @@ -92594,7 +93278,7 @@ paths: - *18 - *43 - *44 - - *123 + - *126 - name: subject_digest description: Subject Digest in: path @@ -92694,7 +93378,7 @@ paths: description: Response content: application/json: - schema: *119 + schema: *122 examples: default: value: @@ -92720,7 +93404,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: - - *123 + - *126 responses: '200': description: Response @@ -92728,9 +93412,9 @@ paths: application/json: schema: type: array - items: *184 + items: *187 examples: - default: *577 + default: *580 '403': *29 '401': *25 x-github: @@ -92753,7 +93437,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -92763,7 +93447,7 @@ paths: application/json: schema: type: array - items: *84 + items: *87 examples: default: value: @@ -92834,8 +93518,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *123 - - *91 + - *126 + - *94 - *18 - *20 responses: @@ -92845,7 +93529,7 @@ paths: application/json: schema: type: array - items: *84 + items: *87 examples: default: value: @@ -92924,7 +93608,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -92934,7 +93618,7 @@ paths: application/json: schema: type: array - items: *84 + items: *87 examples: default: value: @@ -93001,7 +93685,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -93013,7 +93697,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 x-github: @@ -93032,7 +93716,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *123 + - *126 - *18 - *20 responses: @@ -93044,7 +93728,7 @@ paths: type: array items: *19 examples: - default: *169 + default: *172 headers: Link: *39 x-github: @@ -93063,7 +93747,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *123 + - *126 - name: target_user in: path required: true @@ -93090,8 +93774,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *123 - - *62 + - *126 + - *65 - *18 - *20 responses: @@ -93101,9 +93785,9 @@ paths: application/json: schema: type: array - items: *63 + items: *66 examples: - default: *64 + default: *67 headers: Link: *39 '422': *16 @@ -93124,7 +93808,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -93134,9 +93818,9 @@ paths: application/json: schema: type: array - items: *566 + items: *569 examples: - default: *590 + default: *593 headers: Link: *39 x-github: @@ -93160,7 +93844,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *123 + - *126 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -93232,7 +93916,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *123 + - *126 responses: '200': description: Response @@ -93240,7 +93924,7 @@ paths: application/json: schema: *22 examples: - default: *429 + default: *432 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -93258,7 +93942,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -93306,7 +93990,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -93316,9 +94000,9 @@ paths: application/json: schema: type: array - items: *173 + items: *176 examples: - default: *575 + default: *578 headers: Link: *39 x-github: @@ -93357,8 +94041,8 @@ paths: - docker - nuget - container - - *576 - - *123 + - *579 + - *126 - *20 - *18 responses: @@ -93368,12 +94052,12 @@ paths: application/json: schema: type: array - items: *184 + items: *187 examples: - default: *577 + default: *580 '403': *29 '401': *25 - '400': *578 + '400': *581 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -93393,17 +94077,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *186 - - *187 - - *123 + - *189 + - *190 + - *126 responses: '200': description: Response content: application/json: - schema: *184 + schema: *187 examples: - default: *591 + default: *594 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -93424,9 +94108,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *186 - - *187 - - *123 + - *189 + - *190 + - *126 responses: '204': description: Response @@ -93458,9 +94142,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *186 - - *187 - - *123 + - *189 + - *190 + - *126 - name: token description: package token schema: @@ -93492,9 +94176,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: - - *186 - - *187 - - *123 + - *189 + - *190 + - *126 responses: '200': description: Response @@ -93502,7 +94186,7 @@ paths: application/json: schema: type: array - items: *188 + items: *191 examples: default: value: @@ -93560,16 +94244,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *186 - - *187 - *189 - - *123 + - *190 + - *192 + - *126 responses: '200': description: Response content: application/json: - schema: *188 + schema: *191 examples: default: value: @@ -93604,10 +94288,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *186 - - *187 - - *123 - *189 + - *190 + - *126 + - *192 responses: '204': description: Response @@ -93639,10 +94323,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *186 - - *187 - - *123 - *189 + - *190 + - *126 + - *192 responses: '204': description: Response @@ -93665,7 +94349,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-user-projects parameters: - - *123 + - *126 - name: state description: Indicates the state of the projects to return. in: query @@ -93686,7 +94370,7 @@ paths: application/json: schema: type: array - items: *197 + items: *200 examples: default: value: @@ -93745,7 +94429,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -93755,7 +94439,7 @@ paths: application/json: schema: type: array - items: *84 + items: *87 examples: default: value: @@ -93834,7 +94518,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -93844,7 +94528,7 @@ paths: application/json: schema: type: array - items: *84 + items: *87 examples: default: value: @@ -93921,7 +94605,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *123 + - *126 - name: type description: Limit results to repositories of the specified type. in: query @@ -93964,9 +94648,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 x-github: @@ -93990,15 +94674,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *123 + - *126 responses: '200': description: Response content: application/json: - schema: *592 + schema: *595 examples: - default: *593 + default: *596 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -94020,15 +94704,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *123 + - *126 responses: '200': description: Response content: application/json: - schema: *594 + schema: *597 examples: - default: *595 + default: *598 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -94050,15 +94734,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *123 + - *126 responses: '200': description: Response content: application/json: - schema: *596 + schema: *599 examples: - default: *597 + default: *600 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -94076,7 +94760,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -94086,9 +94770,9 @@ paths: application/json: schema: type: array - items: *581 + items: *584 examples: - default: *582 + default: *585 headers: Link: *39 x-github: @@ -94108,7 +94792,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -94118,9 +94802,9 @@ paths: application/json: schema: type: array - items: *583 + items: *586 examples: - default: *598 + default: *601 headers: Link: *39 x-github: @@ -94144,8 +94828,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *123 - - *599 + - *126 + - *602 - *42 - *18 - *20 @@ -94157,11 +94841,11 @@ paths: schema: anyOf: - type: array - items: *600 + items: *603 - type: array - items: *55 + items: *58 examples: - default-response: *586 + default-response: *589 headers: Link: *39 x-github: @@ -94180,7 +94864,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *123 + - *126 - *18 - *20 responses: @@ -94190,9 +94874,9 @@ paths: application/json: schema: type: array - items: *110 + items: *113 examples: - default: *190 + default: *193 headers: Link: *39 x-github: @@ -94320,7 +95004,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &601 + enterprise: &604 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -94378,7 +95062,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &602 + installation: &605 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -94397,7 +95081,7 @@ x-webhooks: required: - id - node_id - organization: &603 + organization: &606 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -94457,13 +95141,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &604 + repository: &607 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &634 + properties: &637 id: description: Unique identifier of the repository example: 42 @@ -94483,8 +95167,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *73 - required: *74 + properties: *76 + required: *77 nullable: true organization: title: Simple User @@ -95146,7 +95830,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &635 + required: &638 - archive_url - assignees_url - blobs_url @@ -95297,10 +95981,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -95376,11 +96060,11 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - rule: &605 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + rule: &608 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) @@ -95603,11 +96287,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - rule: *605 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + rule: *608 sender: *19 required: - action @@ -95790,11 +96474,11 @@ x-webhooks: - everyone required: - from - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - rule: *605 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + rule: *608 sender: *19 required: - action @@ -95878,7 +96562,7 @@ x-webhooks: type: string enum: - completed - check_run: &607 + check_run: &610 title: CheckRun description: A check performed on the code of a given code change type: object @@ -95892,8 +96576,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 check_suite: description: A suite of checks performed on the code of a given code change @@ -95941,8 +96625,8 @@ x-webhooks: type: string pull_requests: type: array - items: *318 - repository: *110 + items: *321 + repository: *113 status: example: completed type: string @@ -95979,7 +96663,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *606 + deployment: *609 details_url: example: https://example.com type: string @@ -96029,7 +96713,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *318 + items: *321 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -96064,9 +96748,9 @@ x-webhooks: - output - app - pull_requests - installation: *602 - organization: *603 - repository: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - check_run @@ -96459,10 +97143,10 @@ x-webhooks: type: string enum: - created - check_run: *607 - installation: *602 - organization: *603 - repository: *604 + check_run: *610 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - check_run @@ -96858,10 +97542,10 @@ x-webhooks: type: string enum: - requested_action - check_run: *607 - installation: *602 - organization: *603 - repository: *604 + check_run: *610 + installation: *605 + organization: *606 + repository: *607 requested_action: description: The action requested by the user. type: object @@ -97266,10 +97950,10 @@ x-webhooks: type: string enum: - rerequested - check_run: *607 - installation: *602 - organization: *603 - repository: *604 + check_run: *610 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - check_run @@ -98246,10 +98930,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -98919,10 +99603,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -99586,10 +100270,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -99889,20 +100573,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &608 + commit_oid: &611 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: *601 - installation: *602 - organization: *603 - ref: &609 + enterprise: *604 + installation: *605 + organization: *606 + ref: &612 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: *604 + repository: *607 sender: *19 required: - action @@ -100220,12 +100904,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *608 - enterprise: *601 - installation: *602 - organization: *603 - ref: *609 - repository: *604 + commit_oid: *611 + enterprise: *604 + installation: *605 + organization: *606 + ref: *612 + repository: *607 sender: *19 required: - action @@ -100320,7 +101004,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *334 + dismissed_comment: *337 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -100482,12 +101166,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *608 - enterprise: *601 - installation: *602 - organization: *603 - ref: *609 - repository: *604 + commit_oid: *611 + enterprise: *604 + installation: *605 + organization: *606 + ref: *612 + repository: *607 sender: *19 required: - action @@ -100808,12 +101492,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *608 - enterprise: *601 - installation: *602 - organization: *603 - ref: *609 - repository: *604 + commit_oid: *611 + enterprise: *604 + installation: *605 + organization: *606 + ref: *612 + repository: *607 sender: *19 required: - action @@ -101070,16 +101754,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *604 + repository: *607 sender: *19 required: - action @@ -101305,12 +101989,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *608 - enterprise: *601 - installation: *602 - organization: *603 - ref: *609 - repository: *604 + commit_oid: *611 + enterprise: *604 + installation: *605 + organization: *606 + ref: *612 + repository: *607 sender: *19 required: - action @@ -101567,10 +102251,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -101650,18 +102334,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *603 - pusher_type: &610 + organization: *606 + pusher_type: &613 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &611 + ref: &614 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -101671,7 +102355,7 @@ x-webhooks: enum: - tag - branch - repository: *604 + repository: *607 sender: *19 required: - ref @@ -101753,10 +102437,10 @@ x-webhooks: type: string enum: - created - definition: *198 - enterprise: *601 - installation: *602 - organization: *603 + definition: *201 + enterprise: *604 + installation: *605 + organization: *606 sender: *19 required: - action @@ -101840,9 +102524,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 sender: *19 required: - action @@ -101918,10 +102602,10 @@ x-webhooks: type: string enum: - updated - definition: *198 - enterprise: *601 - installation: *602 - organization: *603 + definition: *201 + enterprise: *604 + installation: *605 + organization: *606 sender: *19 required: - action @@ -101997,19 +102681,19 @@ x-webhooks: type: string enum: - updated - enterprise: *601 - installation: *602 - repository: *604 - organization: *603 + enterprise: *604 + installation: *605 + repository: *607 + organization: *606 sender: *19 new_property_values: type: array description: The new custom property values for the repository. - items: *202 + items: *205 old_property_values: type: array description: The old custom property values for the repository. - items: *202 + items: *205 required: - action - repository @@ -102085,18 +102769,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *601 - installation: *602 - organization: *603 - pusher_type: *610 - ref: *611 + enterprise: *604 + installation: *605 + organization: *606 + pusher_type: *613 + ref: *614 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *604 + repository: *607 sender: *19 required: - ref @@ -102180,11 +102864,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *388 - installation: *602 - organization: *603 - enterprise: *601 - repository: *604 + alert: *391 + installation: *605 + organization: *606 + enterprise: *604 + repository: *607 sender: *19 required: - action @@ -102268,11 +102952,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *388 - installation: *602 - organization: *603 - enterprise: *601 - repository: *604 + alert: *391 + installation: *605 + organization: *606 + enterprise: *604 + repository: *607 sender: *19 required: - action @@ -102356,11 +103040,11 @@ x-webhooks: type: string enum: - created - alert: *388 - installation: *602 - organization: *603 - enterprise: *601 - repository: *604 + alert: *391 + installation: *605 + organization: *606 + enterprise: *604 + repository: *607 sender: *19 required: - action @@ -102442,11 +103126,11 @@ x-webhooks: type: string enum: - dismissed - alert: *388 - installation: *602 - organization: *603 - enterprise: *601 - repository: *604 + alert: *391 + installation: *605 + organization: *606 + enterprise: *604 + repository: *607 sender: *19 required: - action @@ -102528,11 +103212,11 @@ x-webhooks: type: string enum: - fixed - alert: *388 - installation: *602 - organization: *603 - enterprise: *601 - repository: *604 + alert: *391 + installation: *605 + organization: *606 + enterprise: *604 + repository: *607 sender: *19 required: - action @@ -102615,11 +103299,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *388 - installation: *602 - organization: *603 - enterprise: *601 - repository: *604 + alert: *391 + installation: *605 + organization: *606 + enterprise: *604 + repository: *607 sender: *19 required: - action @@ -102701,11 +103385,11 @@ x-webhooks: type: string enum: - reopened - alert: *388 - installation: *602 - organization: *603 - enterprise: *601 - repository: *604 + alert: *391 + installation: *605 + organization: *606 + enterprise: *604 + repository: *607 sender: *19 required: - action @@ -102782,9 +103466,9 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - key: &612 + enterprise: *604 + installation: *605 + key: &615 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -102818,8 +103502,8 @@ x-webhooks: - verified - created_at - read_only - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -102896,11 +103580,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - key: *612 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + key: *615 + organization: *606 + repository: *607 sender: *19 required: - action @@ -103461,12 +104145,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - workflow: &616 + workflow: &619 title: Workflow type: object nullable: true @@ -104192,13 +104876,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *394 + deployment: *397 pull_requests: type: array - items: *479 - repository: *604 - organization: *603 - installation: *602 + items: *482 + repository: *607 + organization: *606 + installation: *605 sender: *19 responses: '200': @@ -104269,7 +104953,7 @@ x-webhooks: type: string enum: - approved - approver: &613 + approver: &616 type: object properties: avatar_url: @@ -104312,11 +104996,11 @@ x-webhooks: type: string comment: type: string - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - reviewers: &614 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + reviewers: &617 type: array items: type: object @@ -104395,7 +105079,7 @@ x-webhooks: sender: *19 since: type: string - workflow_job_run: &615 + workflow_job_run: &618 type: object properties: conclusion: @@ -105126,18 +105810,18 @@ x-webhooks: type: string enum: - rejected - approver: *613 + approver: *616 comment: type: string - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - reviewers: *614 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + reviewers: *617 sender: *19 since: type: string - workflow_job_run: *615 + workflow_job_run: *618 workflow_job_runs: type: array items: @@ -105841,13 +106525,13 @@ x-webhooks: type: string enum: - requested - enterprise: *601 + enterprise: *604 environment: type: string - installation: *602 - organization: *603 - repository: *604 - requestor: &621 + installation: *605 + organization: *606 + repository: *607 + requestor: &624 title: User type: object nullable: true @@ -107746,12 +108430,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - workflow: *616 + workflow: *619 workflow_run: title: Deployment Workflow Run type: object @@ -108431,7 +109115,7 @@ x-webhooks: type: string enum: - answered - answer: &619 + answer: &622 type: object properties: author_association: @@ -108588,7 +109272,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &617 + discussion: &620 title: Discussion description: A Discussion in a repository. type: object @@ -108874,7 +109558,7 @@ x-webhooks: - id labels: type: array - items: *441 + items: *444 required: - repository_url - category @@ -108896,10 +109580,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109026,11 +109710,11 @@ x-webhooks: - from required: - category - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109113,11 +109797,11 @@ x-webhooks: type: string enum: - closed - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109199,7 +109883,7 @@ x-webhooks: type: string enum: - created - comment: &618 + comment: &621 type: object properties: author_association: @@ -109356,11 +110040,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109443,12 +110127,12 @@ x-webhooks: type: string enum: - deleted - comment: *618 - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + comment: *621 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109543,12 +110227,12 @@ x-webhooks: - from required: - body - comment: *618 - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + comment: *621 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109632,11 +110316,11 @@ x-webhooks: type: string enum: - created - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109718,11 +110402,11 @@ x-webhooks: type: string enum: - deleted - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109822,11 +110506,11 @@ x-webhooks: type: string required: - from - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -109908,10 +110592,10 @@ x-webhooks: type: string enum: - labeled - discussion: *617 - enterprise: *601 - installation: *602 - label: &620 + discussion: *620 + enterprise: *604 + installation: *605 + label: &623 title: Label type: object properties: @@ -109943,8 +110627,8 @@ x-webhooks: - color - default - description - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110027,11 +110711,11 @@ x-webhooks: type: string enum: - locked - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110113,11 +110797,11 @@ x-webhooks: type: string enum: - pinned - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110199,11 +110883,11 @@ x-webhooks: type: string enum: - reopened - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110288,16 +110972,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *617 - new_repository: *604 + new_discussion: *620 + new_repository: *607 required: - new_discussion - new_repository - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110380,10 +111064,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *617 - old_answer: *619 - organization: *603 - repository: *604 + discussion: *620 + old_answer: *622 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110465,12 +111149,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *617 - enterprise: *601 - installation: *602 - label: *620 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + label: *623 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110553,11 +111237,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110639,11 +111323,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *617 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + discussion: *620 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -110716,7 +111400,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *601 + enterprise: *604 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -111376,9 +112060,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *602 - organization: *603 - repository: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - forkee @@ -111524,9 +112208,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 pages: description: The pages that were updated. type: array @@ -111563,7 +112247,7 @@ x-webhooks: - action - sha - html_url - repository: *604 + repository: *607 sender: *19 required: - pages @@ -111639,10 +112323,10 @@ x-webhooks: type: string enum: - created - enterprise: *601 + enterprise: *604 installation: *22 - organization: *603 - repositories: &622 + organization: *606 + repositories: &625 description: An array of repository objects that the installation can access. type: array @@ -111668,8 +112352,8 @@ x-webhooks: - name - full_name - private - repository: *604 - requester: *621 + repository: *607 + requester: *624 sender: *19 required: - action @@ -111744,11 +112428,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 + enterprise: *604 installation: *22 - organization: *603 - repositories: *622 - repository: *604 + organization: *606 + repositories: *625 + repository: *607 requester: nullable: true sender: *19 @@ -111824,11 +112508,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *601 + enterprise: *604 installation: *22 - organization: *603 - repositories: *622 - repository: *604 + organization: *606 + repositories: *625 + repository: *607 requester: nullable: true sender: *19 @@ -111904,10 +112588,10 @@ x-webhooks: type: string enum: - added - enterprise: *601 + enterprise: *604 installation: *22 - organization: *603 - repositories_added: &623 + organization: *606 + repositories_added: &626 description: An array of repository objects, which were added to the installation. type: array @@ -111953,15 +112637,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *604 - repository_selection: &624 + repository: *607 + repository_selection: &627 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *621 + requester: *624 sender: *19 required: - action @@ -112040,10 +112724,10 @@ x-webhooks: type: string enum: - removed - enterprise: *601 + enterprise: *604 installation: *22 - organization: *603 - repositories_added: *623 + organization: *606 + repositories_added: *626 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -112070,9 +112754,9 @@ x-webhooks: - name - full_name - private - repository: *604 - repository_selection: *624 - requester: *621 + repository: *607 + repository_selection: *627 + requester: *624 sender: *19 required: - action @@ -112151,11 +112835,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *601 + enterprise: *604 installation: *22 - organization: *603 - repositories: *622 - repository: *604 + organization: *606 + repositories: *625 + repository: *607 requester: nullable: true sender: *19 @@ -112333,10 +113017,10 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 target_type: type: string @@ -112415,11 +113099,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *601 + enterprise: *604 installation: *22 - organization: *603 - repositories: *622 - repository: *604 + organization: *606 + repositories: *625 + repository: *607 requester: nullable: true sender: *19 @@ -112543,8 +113227,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *56 - required: *57 + properties: *59 + required: *60 reactions: title: Reactions type: object @@ -112671,8 +113355,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -113813,8 +114497,8 @@ x-webhooks: - state - locked - assignee - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -113894,7 +114578,7 @@ x-webhooks: type: string enum: - deleted - comment: &625 + comment: &628 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -114059,8 +114743,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -115199,8 +115883,8 @@ x-webhooks: - state - locked - assignee - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -115280,7 +115964,7 @@ x-webhooks: type: string enum: - edited - changes: &653 + changes: &656 description: The changes to the comment. type: object properties: @@ -115292,9 +115976,9 @@ x-webhooks: type: string required: - from - comment: *625 - enterprise: *601 - installation: *602 + comment: *628 + enterprise: *604 + installation: *605 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -116434,8 +117118,8 @@ x-webhooks: - state - locked - assignee - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -116517,10 +117201,10 @@ x-webhooks: type: string enum: - assigned - assignee: *621 - enterprise: *601 - installation: *602 - issue: &628 + assignee: *624 + enterprise: *604 + installation: *605 + issue: &631 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -117424,8 +118108,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -117505,8 +118189,8 @@ x-webhooks: type: string enum: - closed - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -118550,8 +119234,8 @@ x-webhooks: required: - state - closed_at - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -118630,8 +119314,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -119528,8 +120212,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -119608,8 +120292,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -120509,7 +121193,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &626 + milestone: &629 title: Milestone description: A collection of related issues and pull requests. type: object @@ -120647,8 +121331,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -120747,8 +121431,8 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -121652,9 +122336,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *620 - organization: *603 - repository: *604 + label: *623 + organization: *606 + repository: *607 sender: *19 required: - action @@ -121734,8 +122418,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -122638,9 +123322,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *620 - organization: *603 - repository: *604 + label: *623 + organization: *606 + repository: *607 sender: *19 required: - action @@ -122720,8 +123404,8 @@ x-webhooks: type: string enum: - locked - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -123625,8 +124309,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -123705,8 +124389,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -124604,9 +125288,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *626 - organization: *603 - repository: *604 + milestone: *629 + organization: *606 + repository: *607 sender: *19 required: - action @@ -126053,8 +126737,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -126957,8 +127641,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -127038,9 +127722,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *601 - installation: *602 - issue: &627 + enterprise: *604 + installation: *605 + issue: &630 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -127937,8 +128621,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -128017,8 +128701,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -128921,8 +129605,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -130370,11 +131054,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *601 - installation: *602 - issue: *627 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + issue: *630 + organization: *606 + repository: *607 sender: *19 required: - action @@ -130455,7 +131139,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &656 + assignee: &659 title: User type: object nullable: true @@ -130525,11 +131209,11 @@ x-webhooks: required: - login - id - enterprise: *601 - installation: *602 - issue: *628 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + issue: *631 + organization: *606 + repository: *607 sender: *19 required: - action @@ -130608,12 +131292,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *601 - installation: *602 - issue: *628 - label: *620 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + issue: *631 + label: *623 + organization: *606 + repository: *607 sender: *19 required: - action @@ -130693,8 +131377,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -131596,8 +132280,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -131677,11 +132361,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *601 - installation: *602 - issue: *627 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + issue: *630 + organization: *606 + repository: *607 sender: *19 required: - action @@ -131760,11 +132444,11 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - label: *620 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + label: *623 + organization: *606 + repository: *607 sender: *19 required: - action @@ -131842,11 +132526,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - label: *620 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + label: *623 + organization: *606 + repository: *607 sender: *19 required: - action @@ -131956,11 +132640,11 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 - label: *620 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + label: *623 + organization: *606 + repository: *607 sender: *19 required: - action @@ -132042,9 +132726,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *601 - installation: *602 - marketplace_purchase: &629 + enterprise: *604 + installation: *605 + marketplace_purchase: &632 title: Marketplace Purchase type: object required: @@ -132127,8 +132811,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *603 - previous_marketplace_purchase: &630 + organization: *606 + previous_marketplace_purchase: &633 title: Marketplace Purchase type: object properties: @@ -132208,7 +132892,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *604 + repository: *607 sender: *19 required: - action @@ -132288,10 +132972,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *601 - installation: *602 - marketplace_purchase: *629 - organization: *603 + enterprise: *604 + installation: *605 + marketplace_purchase: *632 + organization: *606 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -132374,7 +133058,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *604 + repository: *607 sender: *19 required: - action @@ -132456,10 +133140,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *601 - installation: *602 - marketplace_purchase: *629 - organization: *603 + enterprise: *604 + installation: *605 + marketplace_purchase: *632 + organization: *606 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -132541,7 +133225,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *604 + repository: *607 sender: *19 required: - action @@ -132622,8 +133306,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 marketplace_purchase: title: Marketplace Purchase type: object @@ -132705,9 +133389,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *603 - previous_marketplace_purchase: *630 - repository: *604 + organization: *606 + previous_marketplace_purchase: *633 + repository: *607 sender: *19 required: - action @@ -132787,12 +133471,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *601 - installation: *602 - marketplace_purchase: *629 - organization: *603 - previous_marketplace_purchase: *630 - repository: *604 + enterprise: *604 + installation: *605 + marketplace_purchase: *632 + organization: *606 + previous_marketplace_purchase: *633 + repository: *607 sender: *19 required: - action @@ -132894,11 +133578,11 @@ x-webhooks: type: string required: - to - enterprise: *601 - installation: *602 - member: *621 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + member: *624 + organization: *606 + repository: *607 sender: *19 required: - action @@ -132998,11 +133682,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *601 - installation: *602 - member: *621 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + member: *624 + organization: *606 + repository: *607 sender: *19 required: - action @@ -133081,11 +133765,11 @@ x-webhooks: type: string enum: - removed - enterprise: *601 - installation: *602 - member: *621 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + member: *624 + organization: *606 + repository: *607 sender: *19 required: - action @@ -133163,11 +133847,11 @@ x-webhooks: type: string enum: - added - enterprise: *601 - installation: *602 - member: *621 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + member: *624 + organization: *606 + repository: *607 scope: description: The scope of the membership. Currently, can only be `team`. @@ -133243,7 +133927,7 @@ x-webhooks: required: - login - id - team: &631 + team: &634 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -133433,11 +134117,11 @@ x-webhooks: type: string enum: - removed - enterprise: *601 - installation: *602 - member: *621 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + member: *624 + organization: *606 + repository: *607 scope: description: The scope of the membership. Currently, can only be `team`. @@ -133514,7 +134198,7 @@ x-webhooks: required: - login - id - team: *631 + team: *634 required: - action - scope @@ -133596,8 +134280,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *602 - merge_group: &633 + installation: *605 + merge_group: &636 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -133616,15 +134300,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *632 + head_commit: *635 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -133710,10 +134394,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *602 - merge_group: *633 - organization: *603 - repository: *604 + installation: *605 + merge_group: *636 + organization: *606 + repository: *607 sender: *19 required: - action @@ -133786,7 +134470,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 + enterprise: *604 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -133894,16 +134578,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *602 - organization: *603 + installation: *605 + organization: *606 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *634 - required: *635 + properties: *637 + required: *638 nullable: true sender: *19 required: @@ -133984,11 +134668,11 @@ x-webhooks: type: string enum: - closed - enterprise: *601 - installation: *602 - milestone: *626 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + milestone: *629 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134067,9 +134751,9 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - milestone: &636 + enterprise: *604 + installation: *605 + milestone: &639 title: Milestone description: A collection of related issues and pull requests. type: object @@ -134206,8 +134890,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134286,11 +134970,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - milestone: *626 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + milestone: *629 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134400,11 +135084,11 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 - milestone: *626 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + milestone: *629 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134484,11 +135168,11 @@ x-webhooks: type: string enum: - opened - enterprise: *601 - installation: *602 - milestone: *636 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + milestone: *639 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134567,11 +135251,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *621 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + blocked_user: *624 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134650,11 +135334,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *621 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + blocked_user: *624 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134733,9 +135417,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - membership: &637 + enterprise: *604 + installation: *605 + membership: &640 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -134827,8 +135511,8 @@ x-webhooks: - role - organization_url - user - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134906,11 +135590,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *601 - installation: *602 - membership: *637 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + membership: *640 + organization: *606 + repository: *607 sender: *19 required: - action @@ -134989,8 +135673,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -135106,10 +135790,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 - user: *621 + user: *624 required: - action - invitation @@ -135187,11 +135871,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *601 - installation: *602 - membership: *637 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + membership: *640 + organization: *606 + repository: *607 sender: *19 required: - action @@ -135278,11 +135962,11 @@ x-webhooks: properties: from: type: string - enterprise: *601 - installation: *602 - membership: *637 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + membership: *640 + organization: *606 + repository: *607 sender: *19 required: - action @@ -135358,9 +136042,9 @@ x-webhooks: type: string enum: - published - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 package: description: Information about the package. type: object @@ -135859,7 +136543,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &638 + items: &641 title: Ruby Gems metadata type: object properties: @@ -135954,7 +136638,7 @@ x-webhooks: - owner - package_version - registry - repository: *604 + repository: *607 sender: *19 required: - action @@ -136030,9 +136714,9 @@ x-webhooks: type: string enum: - updated - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 package: description: Information about the package. type: object @@ -136385,7 +137069,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *638 + items: *641 source_url: type: string format: uri @@ -136455,7 +137139,7 @@ x-webhooks: - owner - package_version - registry - repository: *604 + repository: *607 sender: *19 required: - action @@ -136632,12 +137316,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *601 + enterprise: *604 id: type: integer - installation: *602 - organization: *603 - repository: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - id @@ -136717,7 +137401,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &639 + personal_access_token_request: &642 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -136851,10 +137535,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *601 - organization: *603 + enterprise: *604 + organization: *606 sender: *19 - installation: *602 + installation: *605 required: - action - personal_access_token_request @@ -136933,11 +137617,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *639 - enterprise: *601 - organization: *603 + personal_access_token_request: *642 + enterprise: *604 + organization: *606 sender: *19 - installation: *602 + installation: *605 required: - action - personal_access_token_request @@ -137015,11 +137699,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *639 - enterprise: *601 - organization: *603 + personal_access_token_request: *642 + enterprise: *604 + organization: *606 sender: *19 - installation: *602 + installation: *605 required: - action - personal_access_token_request @@ -137096,11 +137780,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *639 - organization: *603 - enterprise: *601 + personal_access_token_request: *642 + organization: *606 + enterprise: *604 sender: *19 - installation: *602 + installation: *605 required: - action - personal_access_token_request @@ -137204,7 +137888,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *640 + last_response: *643 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -137236,8 +137920,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 zen: description: Random string of GitHub zen. @@ -137482,10 +138166,10 @@ x-webhooks: - from required: - note - enterprise: *601 - installation: *602 - organization: *603 - project_card: &641 + enterprise: *604 + installation: *605 + organization: *606 + project_card: &644 title: Project Card type: object properties: @@ -137604,7 +138288,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *604 + repository: *607 sender: *19 required: - action @@ -137685,11 +138369,11 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - project_card: *641 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + project_card: *644 + repository: *607 sender: *19 required: - action @@ -137769,9 +138453,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 project_card: title: Project Card type: object @@ -137899,8 +138583,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *634 - required: *635 + properties: *637 + required: *638 nullable: true sender: *19 required: @@ -137994,11 +138678,11 @@ x-webhooks: - from required: - note - enterprise: *601 - installation: *602 - organization: *603 - project_card: *641 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + project_card: *644 + repository: *607 sender: *19 required: - action @@ -138092,9 +138776,9 @@ x-webhooks: - from required: - column_id - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 project_card: allOf: - title: Project Card @@ -138284,7 +138968,7 @@ x-webhooks: type: string required: - after_id - repository: *604 + repository: *607 sender: *19 required: - action @@ -138364,10 +139048,10 @@ x-webhooks: type: string enum: - closed - enterprise: *601 - installation: *602 - organization: *603 - project: &643 + enterprise: *604 + installation: *605 + organization: *606 + project: &646 title: Project type: object properties: @@ -138491,7 +139175,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *604 + repository: *607 sender: *19 required: - action @@ -138571,10 +139255,10 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - project_column: &642 + enterprise: *604 + installation: *605 + organization: *606 + project_column: &645 title: Project Column type: object properties: @@ -138613,7 +139297,7 @@ x-webhooks: - name - created_at - updated_at - repository: *604 + repository: *607 sender: *19 required: - action @@ -138692,18 +139376,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 - project_column: *642 + enterprise: *604 + installation: *605 + organization: *606 + project_column: *645 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *634 - required: *635 + properties: *637 + required: *638 nullable: true sender: *19 required: @@ -138793,11 +139477,11 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 - organization: *603 - project_column: *642 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + project_column: *645 + repository: *607 sender: *19 required: - action @@ -138877,11 +139561,11 @@ x-webhooks: type: string enum: - moved - enterprise: *601 - installation: *602 - organization: *603 - project_column: *642 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + project_column: *645 + repository: *607 sender: *19 required: - action @@ -138961,11 +139645,11 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - project: *643 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + project: *646 + repository: *607 sender: *19 required: - action @@ -139045,18 +139729,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 - project: *643 + enterprise: *604 + installation: *605 + organization: *606 + project: *646 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *634 - required: *635 + properties: *637 + required: *638 nullable: true sender: *19 required: @@ -139158,11 +139842,11 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 - organization: *603 - project: *643 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + project: *646 + repository: *607 sender: *19 required: - action @@ -139241,11 +139925,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *601 - installation: *602 - organization: *603 - project: *643 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + project: *646 + repository: *607 sender: *19 required: - action @@ -139326,9 +140010,9 @@ x-webhooks: type: string enum: - closed - installation: *602 - organization: *603 - projects_v2: &644 + installation: *605 + organization: *606 + projects_v2: &647 title: Projects v2 Project description: A projects v2 project type: object @@ -139471,9 +140155,9 @@ x-webhooks: type: string enum: - created - installation: *602 - organization: *603 - projects_v2: *644 + installation: *605 + organization: *606 + projects_v2: *647 sender: *19 required: - action @@ -139554,9 +140238,9 @@ x-webhooks: type: string enum: - deleted - installation: *602 - organization: *603 - projects_v2: *644 + installation: *605 + organization: *606 + projects_v2: *647 sender: *19 required: - action @@ -139673,9 +140357,9 @@ x-webhooks: type: string to: type: string - installation: *602 - organization: *603 - projects_v2: *644 + installation: *605 + organization: *606 + projects_v2: *647 sender: *19 required: - action @@ -139758,7 +140442,7 @@ x-webhooks: type: string enum: - archived - changes: &648 + changes: &651 type: object properties: archived_at: @@ -139772,9 +140456,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *602 - organization: *603 - projects_v2_item: &645 + installation: *605 + organization: *606 + projects_v2_item: &648 title: Projects v2 Item description: An item belonging to a project type: object @@ -139908,9 +140592,9 @@ x-webhooks: nullable: true to: type: string - installation: *602 - organization: *603 - projects_v2_item: *645 + installation: *605 + organization: *606 + projects_v2_item: *648 sender: *19 required: - action @@ -139992,9 +140676,9 @@ x-webhooks: type: string enum: - created - installation: *602 - organization: *603 - projects_v2_item: *645 + installation: *605 + organization: *606 + projects_v2_item: *648 sender: *19 required: - action @@ -140075,9 +140759,9 @@ x-webhooks: type: string enum: - deleted - installation: *602 - organization: *603 - projects_v2_item: *645 + installation: *605 + organization: *606 + projects_v2_item: *648 sender: *19 required: - action @@ -140183,7 +140867,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &646 + - &649 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -140201,7 +140885,7 @@ x-webhooks: required: - id - name - - &647 + - &650 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -140224,8 +140908,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *646 - - *647 + - *649 + - *650 required: - field_value - type: object @@ -140241,9 +140925,9 @@ x-webhooks: nullable: true required: - body - installation: *602 - organization: *603 - projects_v2_item: *645 + installation: *605 + organization: *606 + projects_v2_item: *648 sender: *19 required: - action @@ -140338,9 +141022,9 @@ x-webhooks: to: type: string nullable: true - installation: *602 - organization: *603 - projects_v2_item: *645 + installation: *605 + organization: *606 + projects_v2_item: *648 sender: *19 required: - action @@ -140423,10 +141107,10 @@ x-webhooks: type: string enum: - restored - changes: *648 - installation: *602 - organization: *603 - projects_v2_item: *645 + changes: *651 + installation: *605 + organization: *606 + projects_v2_item: *648 sender: *19 required: - action @@ -140508,9 +141192,9 @@ x-webhooks: type: string enum: - reopened - installation: *602 - organization: *603 - projects_v2: *644 + installation: *605 + organization: *606 + projects_v2: *647 sender: *19 required: - action @@ -140591,9 +141275,9 @@ x-webhooks: type: string enum: - created - installation: *602 - organization: *603 - projects_v2_status_update: &649 + installation: *605 + organization: *606 + projects_v2_status_update: &652 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -140720,9 +141404,9 @@ x-webhooks: type: string enum: - deleted - installation: *602 - organization: *603 - projects_v2_status_update: *649 + installation: *605 + organization: *606 + projects_v2_status_update: *652 sender: *19 required: - action @@ -140858,9 +141542,9 @@ x-webhooks: type: string format: date nullable: true - installation: *602 - organization: *603 - projects_v2_status_update: *649 + installation: *605 + organization: *606 + projects_v2_status_update: *652 sender: *19 required: - action @@ -140931,10 +141615,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - repository @@ -141011,13 +141695,13 @@ x-webhooks: type: string enum: - assigned - assignee: *621 - enterprise: *601 - installation: *602 - number: &650 + assignee: *624 + enterprise: *604 + installation: *605 + number: &653 description: The pull request number. type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -143300,7 +143984,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -143382,11 +144066,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 number: type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -145664,7 +146348,7 @@ x-webhooks: - draft reason: type: string - repository: *604 + repository: *607 sender: *19 required: - action @@ -145746,11 +146430,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 number: type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -148028,7 +148712,7 @@ x-webhooks: - draft reason: type: string - repository: *604 + repository: *607 sender: *19 required: - action @@ -148110,13 +148794,13 @@ x-webhooks: type: string enum: - closed - enterprise: *601 - installation: *602 - number: *650 - organization: *603 - pull_request: &651 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 + pull_request: &654 allOf: - - *479 + - *482 - type: object properties: allow_auto_merge: @@ -148178,7 +148862,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *604 + repository: *607 sender: *19 required: - action @@ -148259,12 +148943,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *601 - installation: *602 - number: *650 - organization: *603 - pull_request: *651 - repository: *604 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 + pull_request: *654 + repository: *607 sender: *19 required: - action @@ -148344,11 +149028,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *601 - milestone: *461 - number: *650 - organization: *603 - pull_request: &652 + enterprise: *604 + milestone: *464 + number: *653 + organization: *606 + pull_request: &655 title: Pull Request type: object properties: @@ -150611,7 +151295,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -150690,11 +151374,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 number: type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -152976,7 +153660,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *604 + repository: *607 sender: *19 required: - action @@ -153100,12 +153784,12 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 - number: *650 - organization: *603 - pull_request: *651 - repository: *604 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 + pull_request: *654 + repository: *607 sender: *19 required: - action @@ -153185,11 +153869,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 number: type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -155456,7 +156140,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -155536,11 +156220,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *601 - installation: *602 - label: *620 - number: *650 - organization: *603 + enterprise: *604 + installation: *605 + label: *623 + number: *653 + organization: *606 pull_request: title: Pull Request type: object @@ -157822,7 +158506,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -157903,10 +158587,10 @@ x-webhooks: type: string enum: - locked - enterprise: *601 - installation: *602 - number: *650 - organization: *603 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 pull_request: title: Pull Request type: object @@ -160186,7 +160870,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -160266,12 +160950,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *601 - milestone: *461 - number: *650 - organization: *603 - pull_request: *652 - repository: *604 + enterprise: *604 + milestone: *464 + number: *653 + organization: *606 + pull_request: *655 + repository: *607 sender: *19 required: - action @@ -160350,12 +161034,12 @@ x-webhooks: type: string enum: - opened - enterprise: *601 - installation: *602 - number: *650 - organization: *603 - pull_request: *651 - repository: *604 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 + pull_request: *654 + repository: *607 sender: *19 required: - action @@ -160436,12 +161120,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *601 - installation: *602 - number: *650 - organization: *603 - pull_request: *651 - repository: *604 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 + pull_request: *654 + repository: *607 sender: *19 required: - action @@ -160521,12 +161205,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *601 - installation: *602 - number: *650 - organization: *603 - pull_request: *651 - repository: *604 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 + pull_request: *654 + repository: *607 sender: *19 required: - action @@ -160892,9 +161576,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 pull_request: type: object properties: @@ -163064,7 +163748,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *604 + repository: *607 sender: *19 required: - action @@ -163144,7 +163828,7 @@ x-webhooks: type: string enum: - deleted - comment: &654 + comment: &657 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -163429,9 +164113,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 pull_request: type: object properties: @@ -165589,7 +166273,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *604 + repository: *607 sender: *19 required: - action @@ -165669,11 +166353,11 @@ x-webhooks: type: string enum: - edited - changes: *653 - comment: *654 - enterprise: *601 - installation: *602 - organization: *603 + changes: *656 + comment: *657 + enterprise: *604 + installation: *605 + organization: *606 pull_request: type: object properties: @@ -167834,7 +168518,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *604 + repository: *607 sender: *19 required: - action @@ -167915,9 +168599,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 pull_request: title: Simple Pull Request type: object @@ -170090,7 +170774,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *604 + repository: *607 review: description: The review that was affected. type: object @@ -170333,9 +171017,9 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 pull_request: title: Simple Pull Request type: object @@ -172389,8 +173073,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *604 - review: &655 + repository: *607 + review: &658 description: The review that was affected. type: object properties: @@ -172619,12 +173303,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 number: description: The pull request number. type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -174907,7 +175591,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 requested_reviewer: title: User type: object @@ -174991,12 +175675,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 number: description: The pull request number. type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -177286,7 +177970,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 requested_team: title: Team description: Groups of organization members that gives permissions @@ -177478,12 +178162,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 number: description: The pull request number. type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -179768,7 +180452,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 requested_reviewer: title: User type: object @@ -179853,12 +180537,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *601 - installation: *602 + enterprise: *604 + installation: *605 number: description: The pull request number. type: integer - organization: *603 + organization: *606 pull_request: title: Pull Request type: object @@ -182134,7 +182818,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 requested_team: title: Team description: Groups of organization members that gives permissions @@ -182315,9 +182999,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 pull_request: title: Simple Pull Request type: object @@ -184492,8 +185176,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *604 - review: *655 + repository: *607 + review: *658 sender: *19 required: - action @@ -184573,9 +185257,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 pull_request: title: Simple Pull Request type: object @@ -186645,7 +187329,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *604 + repository: *607 sender: *19 thread: type: object @@ -187028,9 +187712,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 pull_request: title: Simple Pull Request type: object @@ -189086,7 +189770,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *604 + repository: *607 sender: *19 thread: type: object @@ -189472,10 +190156,10 @@ x-webhooks: type: string before: type: string - enterprise: *601 - installation: *602 - number: *650 - organization: *603 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 pull_request: title: Pull Request type: object @@ -191746,7 +192430,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -191828,11 +192512,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *656 - enterprise: *601 - installation: *602 - number: *650 - organization: *603 + assignee: *659 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 pull_request: title: Pull Request type: object @@ -194115,7 +194799,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -194194,11 +194878,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *601 - installation: *602 - label: *620 - number: *650 - organization: *603 + enterprise: *604 + installation: *605 + label: *623 + number: *653 + organization: *606 pull_request: title: Pull Request type: object @@ -196471,7 +197155,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -196552,10 +197236,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *601 - installation: *602 - number: *650 - organization: *603 + enterprise: *604 + installation: *605 + number: *653 + organization: *606 pull_request: title: Pull Request type: object @@ -198820,7 +199504,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *604 + repository: *607 sender: *19 required: - action @@ -199020,7 +199704,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *601 + enterprise: *604 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -199112,8 +199796,8 @@ x-webhooks: - url - author - committer - installation: *602 - organization: *603 + installation: *605 + organization: *606 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -199688,9 +200372,9 @@ x-webhooks: type: string enum: - published - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 registry_package: type: object properties: @@ -200136,7 +200820,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *638 + items: *641 summary: type: string tag_name: @@ -200190,7 +200874,7 @@ x-webhooks: - owner - package_version - registry - repository: *604 + repository: *607 sender: *19 required: - action @@ -200268,9 +200952,9 @@ x-webhooks: type: string enum: - updated - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 registry_package: type: object properties: @@ -200578,7 +201262,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *638 + items: *641 summary: type: string tag_name: @@ -200627,7 +201311,7 @@ x-webhooks: - owner - package_version - registry - repository: *604 + repository: *607 sender: *19 required: - action @@ -200704,10 +201388,10 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - release: &657 + enterprise: *604 + installation: *605 + organization: *606 + release: &660 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -201012,7 +201696,7 @@ x-webhooks: - tarball_url - zipball_url - body - repository: *604 + repository: *607 sender: *19 required: - action @@ -201089,11 +201773,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 - release: *657 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + release: *660 + repository: *607 sender: *19 required: - action @@ -201201,11 +201885,11 @@ x-webhooks: type: boolean required: - to - enterprise: *601 - installation: *602 - organization: *603 - release: *657 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + release: *660 + repository: *607 sender: *19 required: - action @@ -201283,9 +201967,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -201594,7 +202278,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *604 + repository: *607 sender: *19 required: - action @@ -201670,10 +202354,10 @@ x-webhooks: type: string enum: - published - enterprise: *601 - installation: *602 - organization: *603 - release: &658 + enterprise: *604 + installation: *605 + organization: *606 + release: &661 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -201979,7 +202663,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *604 + repository: *607 sender: *19 required: - action @@ -202055,11 +202739,11 @@ x-webhooks: type: string enum: - released - enterprise: *601 - installation: *602 - organization: *603 - release: *657 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + release: *660 + repository: *607 sender: *19 required: - action @@ -202135,11 +202819,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *601 - installation: *602 - organization: *603 - release: *658 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + release: *661 + repository: *607 sender: *19 required: - action @@ -202215,11 +202899,11 @@ x-webhooks: type: string enum: - published - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - repository_advisory: *532 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + repository_advisory: *535 sender: *19 required: - action @@ -202295,11 +202979,11 @@ x-webhooks: type: string enum: - reported - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - repository_advisory: *532 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + repository_advisory: *535 sender: *19 required: - action @@ -202375,10 +203059,10 @@ x-webhooks: type: string enum: - archived - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -202455,10 +203139,10 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -202536,10 +203220,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -202623,10 +203307,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -202738,10 +203422,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -202813,10 +203497,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 status: type: string @@ -202897,10 +203581,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -202977,10 +203661,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -203074,10 +203758,10 @@ x-webhooks: - name required: - repository - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -203157,11 +203841,11 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - repository_ruleset: *212 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + repository_ruleset: *215 sender: *19 required: - action @@ -203239,11 +203923,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - repository_ruleset: *212 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + repository_ruleset: *215 sender: *19 required: - action @@ -203321,11 +204005,11 @@ x-webhooks: type: string enum: - edited - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - repository_ruleset: *212 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + repository_ruleset: *215 changes: type: object properties: @@ -203344,16 +204028,16 @@ x-webhooks: properties: added: type: array - items: *206 + items: *209 deleted: type: array - items: *206 + items: *209 updated: type: array items: type: object properties: - condition: *206 + condition: *209 changes: type: object properties: @@ -203386,16 +204070,16 @@ x-webhooks: properties: added: type: array - items: *211 + items: *214 deleted: type: array - items: *211 + items: *214 updated: type: array items: type: object properties: - rule: *211 + rule: *214 changes: type: object properties: @@ -203629,10 +204313,10 @@ x-webhooks: - from required: - owner - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -203710,10 +204394,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -203791,7 +204475,7 @@ x-webhooks: type: string enum: - create - alert: &659 + alert: &662 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -203912,10 +204596,10 @@ x-webhooks: type: string enum: - open - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -204121,10 +204805,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -204202,11 +204886,11 @@ x-webhooks: type: string enum: - reopen - alert: *659 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + alert: *662 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -204405,10 +205089,10 @@ x-webhooks: enum: - fixed - open - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -204486,7 +205170,7 @@ x-webhooks: type: string enum: - created - alert: &660 + alert: &663 type: object properties: number: *48 @@ -204575,10 +205259,10 @@ x-webhooks: description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -204659,11 +205343,11 @@ x-webhooks: type: string enum: - created - alert: *660 - installation: *602 - location: *661 - organization: *603 - repository: *604 + alert: *663 + installation: *605 + location: *664 + organization: *606 + repository: *607 sender: *19 required: - location @@ -204901,11 +205585,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *660 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + alert: *663 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -204983,11 +205667,11 @@ x-webhooks: type: string enum: - reopened - alert: *660 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + alert: *663 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -205065,11 +205749,11 @@ x-webhooks: type: string enum: - resolved - alert: *660 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + alert: *663 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -205147,11 +205831,11 @@ x-webhooks: type: string enum: - validated - alert: *660 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + alert: *663 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -205227,11 +205911,11 @@ x-webhooks: type: string enum: - published - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - security_advisory: &662 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + security_advisory: &665 description: The details of the security advisory, including summary, description, and severity. type: object @@ -205414,11 +206098,11 @@ x-webhooks: type: string enum: - updated - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 - security_advisory: *662 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 + security_advisory: *665 sender: *19 required: - action @@ -205491,10 +206175,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -205678,11 +206362,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *205 - enterprise: *601 - installation: *602 - organization: *603 - repository: *250 + security_and_analysis: *208 + enterprise: *604 + installation: *605 + organization: *606 + repository: *253 sender: *19 required: - changes @@ -205760,12 +206444,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - sponsorship: &663 + sponsorship: &666 type: object properties: created_at: @@ -206066,12 +206750,12 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - sponsorship: *663 + sponsorship: *666 required: - action - sponsorship @@ -206159,12 +206843,12 @@ x-webhooks: type: string required: - from - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - sponsorship: *663 + sponsorship: *666 required: - action - changes @@ -206241,17 +206925,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &664 + effective_date: &667 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: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - sponsorship: *663 + sponsorship: *666 required: - action - sponsorship @@ -206325,7 +207009,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &665 + changes: &668 type: object properties: tier: @@ -206369,13 +207053,13 @@ x-webhooks: - from required: - tier - effective_date: *664 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + effective_date: *667 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - sponsorship: *663 + sponsorship: *666 required: - action - changes @@ -206452,13 +207136,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *665 - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + changes: *668 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - sponsorship: *663 + sponsorship: *666 required: - action - changes @@ -206532,10 +207216,10 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 starred_at: description: 'The time the star was created. This is a timestamp @@ -206618,10 +207302,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 starred_at: description: 'The time the star was created. This is a timestamp @@ -207037,15 +207721,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *601 + enterprise: *604 id: description: The unique identifier of the status. type: integer - installation: *602 + installation: *605 name: type: string - organization: *603 - repository: *604 + organization: *606 + repository: *607 sender: *19 sha: description: The Commit SHA. @@ -207154,15 +207838,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *72 - parent_issue_repo: *55 + parent_issue: *75 + parent_issue_repo: *58 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *72 - installation: *602 - organization: *603 - repository: *604 + sub_issue: *75 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -207246,15 +207930,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *72 - parent_issue_repo: *55 + parent_issue: *75 + parent_issue_repo: *58 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *72 - installation: *602 - organization: *603 - repository: *604 + sub_issue: *75 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -207338,15 +208022,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *72 - sub_issue_repo: *55 + sub_issue: *75 + sub_issue_repo: *58 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *72 - installation: *602 - organization: *603 - repository: *604 + parent_issue: *75 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -207430,15 +208114,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *72 - sub_issue_repo: *55 + sub_issue: *75 + sub_issue_repo: *58 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *72 - installation: *602 - organization: *603 - repository: *604 + parent_issue: *75 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -207515,12 +208199,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - team: &666 + team: &669 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -207710,9 +208394,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 repository: title: Repository description: A git repository @@ -208170,7 +208854,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *666 + team: *669 required: - action - team @@ -208246,9 +208930,9 @@ x-webhooks: type: string enum: - created - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 repository: title: Repository description: A git repository @@ -208706,7 +209390,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *666 + team: *669 required: - action - team @@ -208783,9 +209467,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 repository: title: Repository description: A git repository @@ -209243,7 +209927,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *666 + team: *669 required: - action - team @@ -209387,9 +210071,9 @@ x-webhooks: - from required: - permissions - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 repository: title: Repository description: A git repository @@ -209847,7 +210531,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *666 + team: *669 required: - action - changes @@ -209925,9 +210609,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *601 - installation: *602 - organization: *603 + enterprise: *604 + installation: *605 + organization: *606 repository: title: Repository description: A git repository @@ -210385,7 +211069,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *666 + team: *669 required: - action - team @@ -210461,10 +211145,10 @@ x-webhooks: type: string enum: - started - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 required: - action @@ -210537,16 +211221,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *601 + enterprise: *604 inputs: type: object nullable: true additionalProperties: true - installation: *602 - organization: *603 + installation: *605 + organization: *606 ref: type: string - repository: *604 + repository: *607 sender: *19 workflow: type: string @@ -210628,10 +211312,10 @@ x-webhooks: type: string enum: - completed - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 workflow_job: allOf: @@ -210868,7 +211552,7 @@ x-webhooks: type: string required: - conclusion - deployment: *394 + deployment: *397 required: - action - repository @@ -210947,10 +211631,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 workflow_job: allOf: @@ -211210,7 +211894,7 @@ x-webhooks: required: - status - steps - deployment: *394 + deployment: *397 required: - action - repository @@ -211289,10 +211973,10 @@ x-webhooks: type: string enum: - queued - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 workflow_job: type: object @@ -211427,7 +212111,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *394 + deployment: *397 required: - action - repository @@ -211506,10 +212190,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 workflow_job: type: object @@ -211645,7 +212329,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *394 + deployment: *397 required: - action - repository @@ -211725,12 +212409,12 @@ x-webhooks: type: string enum: - completed - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - workflow: *616 + workflow: *619 workflow_run: title: Workflow Run type: object @@ -212729,12 +213413,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - workflow: *616 + workflow: *619 workflow_run: title: Workflow Run type: object @@ -213718,12 +214402,12 @@ x-webhooks: type: string enum: - requested - enterprise: *601 - installation: *602 - organization: *603 - repository: *604 + enterprise: *604 + installation: *605 + organization: *606 + repository: *607 sender: *19 - workflow: *616 + workflow: *619 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index e4f7d9d680..4a209198b0 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -25167,6 +25167,646 @@ } } }, + "/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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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", @@ -30027,6 +30667,655 @@ } } }, + "/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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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", @@ -81038,6 +82327,646 @@ } } }, + "/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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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", @@ -141186,6 +143115,655 @@ } } }, + "/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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 394f149deb..166e28dd08 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -846,7 +846,7 @@ paths: - subscriptions_url - type - url - type: &264 + type: &267 type: string description: The type of credit the user is receiving. enum: @@ -979,7 +979,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &125 + schema: &128 title: Validation Error Simple description: Validation Error Simple type: object @@ -1012,7 +1012,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: - - &575 + - &578 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1130,7 +1130,7 @@ paths: GitHub. type: object nullable: true - properties: &89 + properties: &92 id: description: Unique identifier of the GitHub app example: 37 @@ -1219,7 +1219,7 @@ paths: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' - required: &90 + required: &93 - id - node_id - owner @@ -1524,7 +1524,7 @@ paths: schema: type: integer default: 30 - - &196 + - &199 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 @@ -1545,7 +1545,7 @@ paths: application/json: schema: type: array - items: &197 + items: &200 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1622,7 +1622,7 @@ paths: - installation_id - repository_id examples: - default: &198 + default: &201 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1654,7 +1654,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &585 + schema: &588 title: Scim Error description: Scim Error type: object @@ -1681,7 +1681,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &124 + schema: &127 title: Validation Error description: Validation Error type: object @@ -1750,7 +1750,7 @@ paths: description: Response content: application/json: - schema: &199 + schema: &202 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1864,7 +1864,7 @@ paths: - request - response examples: - default: &200 + default: &203 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1924,7 +1924,7 @@ paths: parameters: - *17 responses: - '202': &127 + '202': &130 description: Accepted content: application/json: @@ -2119,7 +2119,7 @@ paths: parameters: - *18 - *20 - - &94 + - &97 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) @@ -2847,7 +2847,7 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: &242 + properties: &245 id: description: Unique identifier of the repository example: 42 @@ -2867,7 +2867,7 @@ paths: title: License Simple description: License Simple type: object - properties: &105 + properties: &108 key: type: string example: mit @@ -2889,7 +2889,7 @@ paths: html_url: type: string format: uri - required: &106 + required: &109 - key - name - url @@ -3276,7 +3276,7 @@ paths: type: boolean description: Whether anonymous git access is enabled for this repository - required: &243 + required: &246 - archive_url - assignees_url - blobs_url @@ -7289,7 +7289,7 @@ paths: description: Response content: application/json: - schema: &128 + schema: &131 type: object properties: total_active_caches_count: @@ -7304,7 +7304,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &129 + default: &132 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7398,7 +7398,7 @@ paths: - all - local_only - selected - selected_actions_url: &132 + selected_actions_url: &135 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` @@ -7766,7 +7766,7 @@ paths: description: Success response content: application/json: - schema: &135 + schema: &138 type: object properties: default_workflow_permissions: &46 @@ -7814,7 +7814,7 @@ paths: required: true content: application/json: - schema: &136 + schema: &139 type: object properties: default_workflow_permissions: *46 @@ -8635,7 +8635,7 @@ paths: application/json: schema: type: array - items: &140 + items: &143 title: Runner Application description: Runner Application type: object @@ -8660,7 +8660,7 @@ paths: - download_url - filename examples: - default: &141 + default: &144 value: - os: osx architecture: x64 @@ -8744,7 +8744,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &142 + '201': &145 description: Response content: application/json: @@ -8854,7 +8854,7 @@ paths: - token - expires_at examples: - default: &143 + default: &146 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -8894,7 +8894,7 @@ paths: application/json: schema: *58 examples: - default: &144 + default: &147 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -8926,7 +8926,7 @@ paths: application/json: schema: *55 examples: - default: &145 + default: &148 value: id: 23 name: MBP @@ -9140,7 +9140,7 @@ paths: - *40 - *54 responses: - '200': &146 + '200': &149 description: Response content: application/json: @@ -9196,7 +9196,7 @@ paths: parameters: - *40 - *54 - - &147 + - &150 name: name description: The name of a self-hosted runner's custom label. in: path @@ -9287,7 +9287,7 @@ paths: required: true content: application/json: - schema: &154 + schema: &157 title: Enterprise Announcement description: Enterprise global announcement type: object @@ -9358,7 +9358,7 @@ paths: required: false schema: type: string - - &155 + - &158 name: include description: |- The event types to include: @@ -9376,7 +9376,7 @@ paths: - web - git - all - - &156 + - &159 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. @@ -9384,7 +9384,7 @@ paths: required: false schema: type: string - - &157 + - &160 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. @@ -9392,7 +9392,7 @@ paths: required: false schema: type: string - - &158 + - &161 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -9414,7 +9414,7 @@ paths: application/json: schema: type: array - items: &159 + items: &162 type: object properties: "@timestamp": @@ -9536,7 +9536,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &160 + default: &163 value: - "@timestamp": 1606929874512 action: team.add_member @@ -9582,7 +9582,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *40 - - &162 + - &165 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`, @@ -9592,7 +9592,7 @@ paths: schema: &68 type: string description: The name of the tool used to generate the code scanning analysis. - - &163 + - &166 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 @@ -9615,7 +9615,7 @@ paths: be returned. in: query required: false - schema: &164 + schema: &167 type: string description: State of a code scanning alert. enum: @@ -9640,7 +9640,7 @@ paths: application/json: schema: type: array - items: &165 + items: &168 type: object properties: number: &74 @@ -9669,7 +9669,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &373 + instances_url: &376 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -9704,7 +9704,7 @@ paths: format: date-time readOnly: true nullable: true - dismissed_reason: &374 + dismissed_reason: &377 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -9713,13 +9713,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &375 + dismissed_comment: &378 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &376 + rule: &379 type: object properties: id: @@ -9772,7 +9772,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &377 + tool: &380 type: object properties: name: *68 @@ -9782,15 +9782,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *69 - most_recent_instance: &378 + most_recent_instance: &381 type: object properties: - ref: &371 + ref: &374 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &384 + analysis_key: &387 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -9801,7 +9801,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &385 + category: &388 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -10139,7 +10139,7 @@ paths: - most_recent_instance - repository examples: - default: &166 + default: &169 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -10776,7 +10776,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &172 + items: &175 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -10794,7 +10794,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &207 + - &210 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -10853,7 +10853,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &220 + properties: &223 id: description: Unique identifier of the team type: integer @@ -10909,7 +10909,7 @@ paths: maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string - required: &221 + required: &224 - id - node_id - url @@ -11020,7 +11020,7 @@ paths: - created_at additionalProperties: false examples: - default: &173 + default: &176 value: total_seats: 2 seats: @@ -11102,6 +11102,479 @@ 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: + - *40 + - 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 + - *20 + - 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: &87 + 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 + description: Usage metrics for Copilot editor code completions + in the IDE. + nullable: true + 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 + nullable: true + 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 + description: Usage metrics for Copilot Chat in the IDE. + nullable: true + 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 + nullable: true + 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 + description: Usage metrics for Copilot Chat in github.com + nullable: true + 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 + description: The training date for the custom model + (if applicable). + nullable: true + 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 + description: Usage metrics for Copilot for pull requests. + nullable: true + 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 + nullable: true + 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: &88 + 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': *73 + '403': *29 + '404': *7 + '422': &89 + 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 @@ -11159,7 +11632,7 @@ paths: application/json: schema: type: array - items: &87 + items: &90 title: Copilot Usage Metrics description: Summary of Copilot usage. type: object @@ -11338,7 +11811,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &180 + - &183 name: state in: query description: |- @@ -11347,7 +11820,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &181 + - &184 name: severity in: query description: |- @@ -11356,7 +11829,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &182 + - &185 name: ecosystem in: query description: |- @@ -11365,14 +11838,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &183 + - &186 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 - - &184 + - &187 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -11382,7 +11855,7 @@ paths: enum: - development - runtime - - &185 + - &188 name: sort in: query description: |- @@ -11398,7 +11871,7 @@ paths: - *67 - *65 - *66 - - &186 + - &189 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -11411,7 +11884,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &187 + - &190 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -11431,7 +11904,7 @@ paths: application/json: schema: type: array - items: &188 + items: &191 type: object description: A Dependabot alert. properties: @@ -11481,7 +11954,7 @@ paths: enum: - development - runtime - security_advisory: &427 + security_advisory: &430 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -11712,7 +12185,7 @@ paths: nullable: true maxLength: 280 fixed_at: *83 - auto_dismissed_at: &428 + auto_dismissed_at: &431 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -11738,7 +12211,7 @@ paths: - repository additionalProperties: false examples: - default: &189 + default: &192 value: - number: 2 state: dismissed @@ -12144,7 +12617,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *40 - - &255 + - &258 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -12155,7 +12628,7 @@ paths: enum: - open - resolved - - &256 + - &259 name: secret_type in: query description: |- @@ -12165,7 +12638,7 @@ paths: required: false schema: type: string - - &257 + - &260 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -12174,7 +12647,7 @@ paths: required: false schema: type: string - - &258 + - &261 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. @@ -12190,7 +12663,7 @@ paths: - *18 - *65 - *66 - - &259 + - &262 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -12199,7 +12672,7 @@ paths: required: false schema: type: string - - &260 + - &263 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -12208,7 +12681,7 @@ paths: schema: type: boolean default: false - - &261 + - &264 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -12224,7 +12697,7 @@ paths: application/json: schema: type: array - items: &262 + items: &265 type: object properties: number: *74 @@ -12243,14 +12716,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &568 + state: &571 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: &569 + resolution: &572 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -12325,7 +12798,7 @@ paths: repositories in the same organization or enterprise. nullable: true examples: - default: &263 + default: &266 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -12562,7 +13035,7 @@ paths: description: Response content: application/json: - schema: &265 + schema: &268 type: object properties: total_minutes_used: @@ -12632,7 +13105,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &266 + default: &269 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -12670,7 +13143,7 @@ paths: description: Success content: application/json: - schema: &267 + schema: &270 type: object properties: total_advanced_security_committers: @@ -12725,7 +13198,7 @@ paths: required: - repositories examples: - default: &268 + default: &271 value: total_advanced_security_committers: 2 total_count: 2 @@ -12876,7 +13349,7 @@ paths: message: Resources successfully added to the cost center. '400': *15 '403': *29 - '409': &126 + '409': &129 description: Conflict content: application/json: @@ -12968,7 +13441,7 @@ paths: description: Response content: application/json: - schema: &269 + schema: &272 type: object properties: total_gigabytes_bandwidth_used: @@ -12986,7 +13459,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &270 + default: &273 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -13018,7 +13491,7 @@ paths: description: Response content: application/json: - schema: &271 + schema: &274 type: object properties: days_left_in_billing_cycle: @@ -13036,7 +13509,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &272 + default: &275 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -13177,6 +13650,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: + - *40 + - 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 + - *20 + - 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: *87 + examples: + default: *88 + '500': *73 + '403': *29 + '404': *7 + '422': *89 + 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 @@ -13206,7 +13753,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: - *40 - - &219 + - &222 name: team_slug description: The slug of the team name. in: path @@ -13244,9 +13791,9 @@ paths: application/json: schema: type: array - items: *87 + items: *90 examples: - default: &174 + default: &177 value: - day: '2023-10-15' total_suggestions_count: 1000 @@ -13402,7 +13949,7 @@ paths: application/json: schema: type: array - items: &116 + items: &119 title: Event description: Event type: object @@ -13412,7 +13959,7 @@ paths: type: type: string nullable: true - actor: &88 + actor: &91 title: Actor description: Actor type: object @@ -13452,18 +13999,18 @@ paths: - id - name - url - org: *88 + org: *91 payload: type: object properties: action: type: string - issue: &104 + issue: &107 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &476 + properties: &479 id: type: integer format: int64 @@ -13574,7 +14121,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &412 + properties: &415 url: type: string format: uri @@ -13644,7 +14191,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &413 + required: &416 - closed_issues - creator - description @@ -13733,9 +14280,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 - author_association: &91 + properties: *92 + required: *93 + author_association: &94 title: author_association type: string example: OWNER @@ -13749,7 +14296,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &92 + reactions: &95 title: Reaction Rollup type: object properties: @@ -13785,7 +14332,7 @@ paths: - hooray - eyes - rocket - required: &477 + required: &480 - assignee - closed_at - comments @@ -13807,7 +14354,7 @@ paths: - author_association - created_at - updated_at - comment: &474 + comment: &477 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -13855,7 +14402,7 @@ paths: issue_url: type: string format: uri - author_association: *91 + author_association: *94 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -13865,9 +14412,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 - reactions: *92 + properties: *92 + required: *93 + reactions: *95 required: - id - node_id @@ -14043,7 +14590,7 @@ paths: _links: type: object properties: - timeline: &93 + timeline: &96 title: Link With Type description: Hypermedia Link with Type type: object @@ -14055,17 +14602,17 @@ paths: required: - href - type - user: *93 - security_advisories: *93 - current_user: *93 - current_user_public: *93 - current_user_actor: *93 - current_user_organization: *93 + user: *96 + security_advisories: *96 + current_user: *96 + current_user_public: *96 + current_user_actor: *96 + current_user_organization: *96 current_user_organizations: type: array - items: *93 - repository_discussions: *93 - repository_discussions_category: *93 + items: *96 + repository_discussions: *96 + repository_discussions_category: *96 required: - timeline - user @@ -14127,7 +14674,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *94 + - *97 - *18 - *20 responses: @@ -14137,7 +14684,7 @@ paths: application/json: schema: type: array - items: &95 + items: &98 title: Base Gist description: Base Gist type: object @@ -14229,7 +14776,7 @@ paths: - created_at - updated_at examples: - default: &96 + default: &99 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -14350,7 +14897,7 @@ paths: description: Response content: application/json: - schema: &97 + schema: &100 title: Gist Simple description: Gist Simple type: object @@ -14367,7 +14914,7 @@ paths: url: type: string format: uri - user: &624 + user: &627 title: Public User description: Public User type: object @@ -14720,7 +15267,7 @@ paths: truncated: type: boolean examples: - default: &98 + default: &101 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -14822,7 +15369,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *94 + - *97 - *18 - *20 responses: @@ -14832,9 +15379,9 @@ paths: application/json: schema: type: array - items: *95 + items: *98 examples: - default: *96 + default: *99 headers: Link: *39 '422': *16 @@ -14856,7 +15403,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *94 + - *97 - *18 - *20 responses: @@ -14866,9 +15413,9 @@ paths: application/json: schema: type: array - items: *95 + items: *98 examples: - default: *96 + default: *99 headers: Link: *39 '401': *25 @@ -14896,7 +15443,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &99 + - &102 name: gist_id description: The unique identifier of the gist. in: path @@ -14908,10 +15455,10 @@ paths: description: Response content: application/json: - schema: *97 + schema: *100 examples: - default: *98 - '403': &102 + default: *101 + '403': &105 description: Forbidden Gist content: application/json: @@ -14959,7 +15506,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *99 + - *102 requestBody: required: true content: @@ -15019,9 +15566,9 @@ paths: description: Response content: application/json: - schema: *97 + schema: *100 examples: - updateGist: *98 + updateGist: *101 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -15179,7 +15726,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *99 + - *102 responses: '204': description: Response @@ -15208,7 +15755,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *99 + - *102 - *18 - *20 responses: @@ -15218,7 +15765,7 @@ paths: application/json: schema: type: array - items: &100 + items: &103 title: Gist Comment description: A comment made to a gist. type: object @@ -15253,7 +15800,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *91 + author_association: *94 required: - url - id @@ -15318,7 +15865,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *99 + - *102 requestBody: required: true content: @@ -15343,9 +15890,9 @@ paths: description: Response content: application/json: - schema: *100 + schema: *103 examples: - default: &101 + default: &104 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -15403,8 +15950,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *99 - - &103 + - *102 + - &106 name: comment_id description: The unique identifier of the comment. in: path @@ -15417,12 +15964,12 @@ paths: description: Response content: application/json: - schema: *100 + schema: *103 examples: - default: *101 + default: *104 '304': *37 '404': *7 - '403': *102 + '403': *105 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -15444,8 +15991,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *99 - - *103 + - *102 + - *106 requestBody: required: true content: @@ -15470,9 +16017,9 @@ paths: description: Response content: application/json: - schema: *100 + schema: *103 examples: - default: *101 + default: *104 '404': *7 x-github: githubCloudOnly: false @@ -15489,8 +16036,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *99 - - *103 + - *102 + - *106 responses: '204': description: Response @@ -15513,7 +16060,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *99 + - *102 - *18 - *20 responses: @@ -15614,7 +16161,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *99 + - *102 - *18 - *20 responses: @@ -15624,7 +16171,7 @@ paths: application/json: schema: type: array - items: *97 + items: *100 examples: default: value: @@ -15689,13 +16236,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *99 + - *102 responses: '201': description: Response content: application/json: - schema: *95 + schema: *98 examples: default: value: @@ -15766,7 +16313,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *99 + - *102 responses: '204': description: Response if gist is starred @@ -15796,7 +16343,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *99 + - *102 responses: '204': description: Response @@ -15818,7 +16365,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *99 + - *102 responses: '204': description: Response @@ -15847,7 +16394,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *99 + - *102 - name: sha in: path required: true @@ -15858,9 +16405,9 @@ paths: description: Response content: application/json: - schema: *97 + schema: *100 examples: - default: *98 + default: *101 '422': *16 '404': *7 '403': *29 @@ -16226,7 +16773,7 @@ paths: - closed - all default: open - - &208 + - &211 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -16245,7 +16792,7 @@ paths: - comments default: created - *67 - - *94 + - *97 - name: collab in: query required: false @@ -16275,9 +16822,9 @@ paths: application/json: schema: type: array - items: *104 + items: *107 examples: - default: &209 + default: &212 value: - id: 1 node_id: MDU6SXNzdWUx @@ -16561,8 +17108,8 @@ paths: title: License Simple description: License Simple type: object - properties: *105 - required: *106 + properties: *108 + required: *109 examples: default: value: @@ -16846,7 +17393,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &107 + X-CommonMarker-Version: &110 example: 0.17.4 schema: type: string @@ -16901,7 +17448,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *107 + X-CommonMarker-Version: *110 content: text/html: schema: @@ -16930,7 +17477,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: - - &110 + - &113 name: account_id description: account_id parameter in: path @@ -16942,7 +17489,7 @@ paths: description: Response content: application/json: - schema: &109 + schema: &112 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -16972,7 +17519,7 @@ paths: nullable: true id: type: integer - plan: &108 + plan: &111 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -17061,7 +17608,7 @@ paths: nullable: true updated_at: type: string - plan: *108 + plan: *111 required: - url - id @@ -17069,7 +17616,7 @@ paths: - login - marketplace_purchase examples: - default: &111 + default: &114 value: url: https://api.github.com/orgs/github type: Organization @@ -17154,9 +17701,9 @@ paths: application/json: schema: type: array - items: *108 + items: *111 examples: - default: &112 + default: &115 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -17196,14 +17743,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &113 + - &116 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &114 + - &117 name: sort description: The property to sort the results by. in: query @@ -17233,9 +17780,9 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: - default: &115 + default: &118 value: - url: https://api.github.com/orgs/github type: Organization @@ -17309,15 +17856,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: - - *110 + - *113 responses: '200': description: Response content: application/json: - schema: *109 + schema: *112 examples: - default: *111 + default: *114 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -17349,9 +17896,9 @@ paths: application/json: schema: type: array - items: *108 + items: *111 examples: - default: *112 + default: *115 headers: Link: *39 '401': *25 @@ -17374,8 +17921,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *113 - - *114 + - *116 + - *117 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -17395,9 +17942,9 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: - default: *115 + default: *118 headers: Link: *39 '401': *25 @@ -17646,14 +18193,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: - - &292 + - &295 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &293 + - &296 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -17670,7 +18217,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: default: value: @@ -17724,7 +18271,7 @@ paths: '404': *7 '403': *29 '304': *37 - '301': &306 + '301': &309 description: Moved permanently content: application/json: @@ -17746,7 +18293,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &505 + - &508 name: all description: If `true`, show notifications marked as read. in: query @@ -17754,7 +18301,7 @@ paths: schema: type: boolean default: false - - &506 + - &509 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -17763,8 +18310,8 @@ paths: schema: type: boolean default: false - - *94 - - &507 + - *97 + - &510 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: @@ -17789,18 +18336,18 @@ paths: application/json: schema: type: array - items: &117 + items: &120 title: Thread description: Thread type: object properties: id: type: string - repository: &139 + repository: &142 title: Minimal Repository description: Minimal Repository type: object - properties: &191 + properties: &194 id: type: integer format: int64 @@ -18076,7 +18623,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &244 + security_and_analysis: &247 nullable: true type: object properties: @@ -18140,7 +18687,7 @@ paths: enum: - enabled - disabled - required: &192 + required: &195 - archive_url - assignees_url - blobs_url @@ -18228,7 +18775,7 @@ paths: - url - subscription_url examples: - default: &508 + default: &511 value: - id: '1' repository: @@ -18394,7 +18941,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &118 + - &121 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 @@ -18408,7 +18955,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *120 examples: default: value: @@ -18511,7 +19058,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *118 + - *121 responses: '205': description: Reset Content @@ -18534,7 +19081,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *118 + - *121 responses: '204': description: No content @@ -18557,13 +19104,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: - - *118 + - *121 responses: '200': description: Response content: application/json: - schema: &119 + schema: &122 title: Thread Subscription description: Thread Subscription type: object @@ -18600,7 +19147,7 @@ paths: - url - subscribed examples: - default: &120 + default: &123 value: subscribed: true ignored: false @@ -18631,7 +19178,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *118 + - *121 requestBody: required: false content: @@ -18652,9 +19199,9 @@ paths: description: Response content: application/json: - schema: *119 + schema: *122 examples: - default: *120 + default: *123 '304': *37 '403': *29 '401': *25 @@ -18677,7 +19224,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *118 + - *121 responses: '204': description: Response @@ -18774,7 +19321,7 @@ paths: type: array items: *52 examples: - default: &642 + default: &645 value: - login: github id: 1 @@ -18838,7 +19385,7 @@ paths: type: integer custom_roles: type: array - items: &175 + items: &178 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -18886,7 +19433,7 @@ paths: - created_at - updated_at examples: - default: &176 + default: &179 value: id: 8030 name: Security Engineer @@ -18938,7 +19485,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - &121 + - &124 name: org description: The organization name. The name is not case sensitive. in: path @@ -18950,7 +19497,7 @@ paths: description: Response content: application/json: - schema: &122 + schema: &125 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -19247,7 +19794,7 @@ paths: - updated_at - archived_at examples: - default-response: &123 + default-response: &126 value: login: github id: 1 @@ -19339,7 +19886,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *121 + - *124 requestBody: required: false content: @@ -19558,18 +20105,18 @@ paths: description: Response content: application/json: - schema: *122 + schema: *125 examples: - default: *123 + default: *126 '422': description: Validation failed content: application/json: schema: oneOf: - - *124 - - *125 - '409': *126 + - *127 + - *128 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19592,9 +20139,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *121 + - *124 responses: - '202': *127 + '202': *130 '404': *7 '403': *29 x-github: @@ -19617,15 +20164,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: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: *128 + schema: *131 examples: - default: *129 + default: *132 headers: Link: *39 x-github: @@ -19648,7 +20195,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: - - *121 + - *124 - *18 - *20 responses: @@ -19666,7 +20213,7 @@ paths: type: integer repository_cache_usages: type: array - items: &311 + items: &314 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -19721,13 +20268,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: - - *121 + - *124 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &130 + schema: &133 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -19741,7 +20288,7 @@ paths: required: - include_claim_keys examples: - default: &131 + default: &134 value: include_claim_keys: - repo @@ -19763,20 +20310,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: - - *121 + - *124 requestBody: required: true content: application/json: - schema: *130 + schema: *133 examples: - default: *131 + default: *134 responses: '201': description: Empty response content: application/json: - schema: &150 + schema: &153 title: Empty Object description: An object without any properties. type: object @@ -19806,7 +20353,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: - - *121 + - *124 responses: '200': description: Response @@ -19815,7 +20362,7 @@ paths: schema: type: object properties: - enabled_repositories: &133 + enabled_repositories: &136 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -19829,7 +20376,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *42 - selected_actions_url: *132 + selected_actions_url: *135 required: - enabled_repositories examples: @@ -19858,7 +20405,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: - - *121 + - *124 responses: '204': description: Response @@ -19869,7 +20416,7 @@ paths: schema: type: object properties: - enabled_repositories: *133 + enabled_repositories: *136 allowed_actions: *42 required: - enabled_repositories @@ -19897,7 +20444,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: - - *121 + - *124 - *18 - *20 responses: @@ -19917,7 +20464,7 @@ paths: type: array items: *57 examples: - default: &636 + default: &639 value: total_count: 1 repositories: @@ -20057,7 +20604,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: - - *121 + - *124 responses: '204': description: Response @@ -20101,8 +20648,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: - - *121 - - &134 + - *124 + - &137 name: repository_id description: The unique identifier of the repository. in: path @@ -20130,8 +20677,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: - - *121 - - *134 + - *124 + - *137 responses: '204': description: Response @@ -20154,7 +20701,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: - - *121 + - *124 responses: '200': description: Response @@ -20185,7 +20732,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: - - *121 + - *124 responses: '204': description: Response @@ -20217,13 +20764,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: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: *135 + schema: *138 examples: default: *48 x-github: @@ -20246,7 +20793,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: - - *121 + - *124 responses: '204': description: Success response @@ -20257,7 +20804,7 @@ paths: required: false content: application/json: - schema: *136 + schema: *139 examples: default: *48 x-github: @@ -20279,7 +20826,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: - - *121 + - *124 - *18 - *20 - name: visible_to_repository @@ -20304,7 +20851,7 @@ paths: type: number runner_groups: type: array - items: &137 + items: &140 type: object properties: id: @@ -20416,7 +20963,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: - - *121 + - *124 requestBody: required: true content: @@ -20485,9 +21032,9 @@ paths: description: Response content: application/json: - schema: *137 + schema: *140 examples: - default: &138 + default: &141 value: id: 2 name: octo-runner-group @@ -20522,14 +21069,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: - - *121 + - *124 - *51 responses: '200': description: Response content: application/json: - schema: *137 + schema: *140 examples: default: value: @@ -20565,7 +21112,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: - - *121 + - *124 - *51 requestBody: required: true @@ -20616,9 +21163,9 @@ paths: description: Response content: application/json: - schema: *137 + schema: *140 examples: - default: *138 + default: *141 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20637,7 +21184,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: - - *121 + - *124 - *51 responses: '204': @@ -20661,7 +21208,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: - - *121 + - *124 - *51 - *20 - *18 @@ -20680,9 +21227,9 @@ paths: type: number repositories: type: array - items: *139 + items: *142 examples: - default: &627 + default: &630 value: total_count: 1 repositories: @@ -20934,7 +21481,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: - - *121 + - *124 - *51 requestBody: required: true @@ -20979,9 +21526,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: - - *121 + - *124 - *51 - - *134 + - *137 responses: '204': description: Response @@ -21003,9 +21550,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: - - *121 + - *124 - *51 - - *134 + - *137 responses: '204': description: Response @@ -21028,7 +21575,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: - - *121 + - *124 - *51 - *18 - *20 @@ -21070,7 +21617,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: - - *121 + - *124 - *51 requestBody: required: true @@ -21115,7 +21662,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: - - *121 + - *124 - *51 - *54 responses: @@ -21139,7 +21686,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: - - *121 + - *124 - *51 - *54 responses: @@ -21171,7 +21718,7 @@ paths: in: query schema: type: string - - *121 + - *124 - *18 - *20 responses: @@ -21215,7 +21762,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: - - *121 + - *124 responses: '200': description: Response @@ -21223,9 +21770,9 @@ paths: application/json: schema: type: array - items: *140 + items: *143 examples: - default: *141 + default: *144 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21247,7 +21794,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: - - *121 + - *124 requestBody: required: true content: @@ -21290,7 +21837,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *142 + '201': *145 '404': *7 '422': *8 x-github: @@ -21320,7 +21867,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: - - *121 + - *124 responses: '201': description: Response @@ -21328,7 +21875,7 @@ paths: application/json: schema: *58 examples: - default: *143 + default: *146 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21356,7 +21903,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: - - *121 + - *124 responses: '201': description: Response @@ -21364,7 +21911,7 @@ paths: application/json: schema: *58 examples: - default: *144 + default: *147 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21386,7 +21933,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: - - *121 + - *124 - *54 responses: '200': @@ -21395,7 +21942,7 @@ paths: application/json: schema: *55 examples: - default: *145 + default: *148 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21416,7 +21963,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: - - *121 + - *124 - *54 responses: '204': @@ -21442,7 +21989,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: - - *121 + - *124 - *54 responses: '200': *60 @@ -21467,7 +22014,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: - - *121 + - *124 - *54 requestBody: required: true @@ -21516,7 +22063,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: - - *121 + - *124 - *54 requestBody: required: true @@ -21566,10 +22113,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: - - *121 + - *124 - *54 responses: - '200': *146 + '200': *149 '404': *7 x-github: githubCloudOnly: false @@ -21596,9 +22143,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: - - *121 + - *124 - *54 - - *147 + - *150 responses: '200': *60 '404': *7 @@ -21625,7 +22172,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *121 + - *124 - *18 - *20 responses: @@ -21643,7 +22190,7 @@ paths: type: integer secrets: type: array - items: &148 + items: &151 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -21716,13 +22263,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: &331 + schema: &334 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -21751,7 +22298,7 @@ paths: - key_id - key examples: - default: &332 + default: &335 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -21776,8 +22323,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *121 - - &149 + - *124 + - &152 name: secret_name description: The name of the secret. in: path @@ -21789,7 +22336,7 @@ paths: description: Response content: application/json: - schema: *148 + schema: *151 examples: default: value: @@ -21819,8 +22366,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *121 - - *149 + - *124 + - *152 requestBody: required: true content: @@ -21875,7 +22422,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -21901,8 +22448,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *121 - - *149 + - *124 + - *152 responses: '204': description: Response @@ -21928,8 +22475,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: - - *121 - - *149 + - *124 + - *152 - *20 - *18 responses: @@ -21947,9 +22494,9 @@ paths: type: integer repositories: type: array - items: *139 + items: *142 examples: - default: &153 + default: &156 value: total_count: 1 repositories: @@ -22041,8 +22588,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: - - *121 - - *149 + - *124 + - *152 requestBody: required: true content: @@ -22094,8 +22641,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: - - *121 - - *149 + - *124 + - *152 - name: repository_id in: path required: true @@ -22128,8 +22675,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: - - *121 - - *149 + - *124 + - *152 - name: repository_id in: path required: true @@ -22161,8 +22708,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *121 - - &316 + - *124 + - &319 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)." @@ -22186,7 +22733,7 @@ paths: type: integer variables: type: array - items: &151 + items: &154 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -22271,7 +22818,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *121 + - *124 requestBody: required: true content: @@ -22319,7 +22866,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -22344,8 +22891,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *121 - - &152 + - *124 + - &155 name: name description: The name of the variable. in: path @@ -22357,7 +22904,7 @@ paths: description: Response content: application/json: - schema: *151 + schema: *154 examples: default: value: @@ -22387,8 +22934,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *121 - - *152 + - *124 + - *155 requestBody: required: true content: @@ -22450,8 +22997,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *121 - - *152 + - *124 + - *155 responses: '204': description: Response @@ -22477,8 +23024,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: - - *121 - - *152 + - *124 + - *155 - *20 - *18 responses: @@ -22496,9 +23043,9 @@ paths: type: integer repositories: type: array - items: *139 + items: *142 examples: - default: *153 + default: *156 '409': description: Response when the visibility of the variable is not set to `selected` @@ -22524,8 +23071,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: - - *121 - - *152 + - *124 + - *155 requestBody: required: true content: @@ -22574,8 +23121,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: - - *121 - - *152 + - *124 + - *155 - name: repository_id in: path required: true @@ -22609,8 +23156,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: - - *121 - - *152 + - *124 + - *155 - name: repository_id in: path required: true @@ -22641,7 +23188,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *121 + - *124 responses: '200': description: Response @@ -22668,11 +23215,11 @@ paths: required: true content: application/json: - schema: *154 + schema: *157 examples: default: *63 parameters: - - *121 + - *124 responses: '200': description: Response @@ -22696,7 +23243,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *121 + - *124 responses: '204': description: Response @@ -22724,7 +23271,7 @@ paths: - *18 - *65 - *66 - - *121 + - *124 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -22765,7 +23312,7 @@ paths: repository_id: type: integer examples: - default: &345 + default: &348 value: attestations: - bundle: @@ -22883,7 +23430,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: - - *121 + - *124 - 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). @@ -22891,10 +23438,10 @@ paths: required: false schema: type: string - - *155 - - *156 - - *157 - *158 + - *159 + - *160 + - *161 - *18 responses: '200': @@ -22903,9 +23450,9 @@ paths: application/json: schema: type: array - items: *159 + items: *162 examples: - default: *160 + default: *163 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -22922,7 +23469,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *121 + - *124 - *18 - *20 responses: @@ -22934,7 +23481,7 @@ paths: type: array items: *19 examples: - default: &210 + default: &213 value: - login: octocat id: 1 @@ -22972,8 +23519,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: - - *121 - - &161 + - *124 + - &164 name: username description: The handle for the GitHub user account. in: path @@ -23004,8 +23551,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response @@ -23025,8 +23572,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response @@ -23051,9 +23598,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: - - *121 - - *162 - - *163 + - *124 + - *165 + - *166 - *65 - *66 - *20 @@ -23064,7 +23611,7 @@ paths: be returned. in: query required: false - schema: *164 + schema: *167 - name: sort description: The property by which to sort the results. in: query @@ -23080,7 +23627,7 @@ paths: be returned. in: query required: false - schema: &372 + schema: &375 type: string description: Severity of a code scanning alert. enum: @@ -23098,9 +23645,9 @@ paths: application/json: schema: type: array - items: *165 + items: *168 examples: - default: *166 + default: *169 headers: Link: *39 '404': *7 @@ -23126,7 +23673,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: - - *121 + - *124 - name: target_type in: query description: The target type of the code security configuration @@ -23154,7 +23701,7 @@ paths: application/json: schema: type: array - items: &167 + items: &170 type: object description: A code security configuration properties: @@ -23393,7 +23940,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *121 + - *124 requestBody: required: true content: @@ -23565,9 +24112,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *167 + schema: *170 examples: - default: &168 + default: &171 value: id: 1325 target_type: organization @@ -23613,7 +24160,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *121 + - *124 responses: '200': description: Response @@ -23633,7 +24180,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *167 + configuration: *170 examples: default: value: @@ -23717,7 +24264,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *121 + - *124 requestBody: required: true content: @@ -23740,12 +24287,12 @@ paths: - 32 - 91 responses: - '204': &170 + '204': &173 description: A header with no content is returned. '400': *15 '403': *29 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23767,8 +24314,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *121 - - &169 + - *124 + - &172 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -23780,9 +24327,9 @@ paths: description: Response content: application/json: - schema: *167 + schema: *170 examples: - default: *168 + default: *171 '304': *37 '403': *29 '404': *7 @@ -23806,8 +24353,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *121 - - *169 + - *124 + - *172 requestBody: required: true content: @@ -23959,7 +24506,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *167 + schema: *170 examples: default: value: @@ -24010,14 +24557,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *121 - - *169 + - *124 + - *172 responses: - '204': *170 + '204': *173 '400': *15 '403': *29 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24041,8 +24588,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *121 - - *169 + - *124 + - *172 requestBody: required: true content: @@ -24081,7 +24628,7 @@ paths: - 32 - 91 responses: - '202': *127 + '202': *130 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24105,8 +24652,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: - - *121 - - *169 + - *124 + - *172 requestBody: required: true content: @@ -24146,12 +24693,12 @@ paths: - none - private_and_internal - public - configuration: *167 + configuration: *170 examples: default: value: default_for_new_repos: all - configuration: *168 + configuration: *171 '403': *29 '404': *7 x-github: @@ -24175,8 +24722,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: - - *121 - - *169 + - *124 + - *172 - 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)." @@ -24319,7 +24866,7 @@ paths: parameters: - *18 - *20 - - *121 + - *124 responses: '200': description: Response @@ -24335,7 +24882,7 @@ paths: type: integer codespaces: type: array - items: &211 + items: &214 type: object title: Codespace description: A codespace. @@ -24360,12 +24907,12 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *139 + repository: *142 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &398 + properties: &401 name: type: string description: The name of the machine. @@ -24407,7 +24954,7 @@ paths: - ready - in_progress nullable: true - required: &399 + required: &402 - name - display_name - operating_system @@ -24612,7 +25159,7 @@ paths: - pulls_url - recent_folders examples: - default: &212 + default: &215 value: total_count: 3 codespaces: @@ -25044,7 +25591,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *121 + - *124 deprecated: true requestBody: required: true @@ -25111,7 +25658,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: - - *121 + - *124 deprecated: true requestBody: required: true @@ -25166,7 +25713,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *121 + - *124 requestBody: required: true content: @@ -25218,7 +25765,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *121 + - *124 - *18 - *20 responses: @@ -25236,7 +25783,7 @@ paths: type: integer secrets: type: array - items: &171 + items: &174 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -25275,7 +25822,7 @@ paths: - updated_at - visibility examples: - default: &400 + default: &403 value: total_count: 2 secrets: @@ -25307,13 +25854,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: &401 + schema: &404 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -25342,7 +25889,7 @@ paths: - key_id - key examples: - default: &402 + default: &405 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -25365,16 +25912,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *121 - - *149 + - *124 + - *152 responses: '200': description: Response content: application/json: - schema: *171 + schema: *174 examples: - default: &404 + default: &407 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -25401,8 +25948,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: - - *121 - - *149 + - *124 + - *152 requestBody: required: true content: @@ -25457,7 +26004,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -25483,8 +26030,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *121 - - *149 + - *124 + - *152 responses: '204': description: Response @@ -25509,8 +26056,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: - - *121 - - *149 + - *124 + - *152 - *20 - *18 responses: @@ -25528,9 +26075,9 @@ paths: type: integer repositories: type: array - items: *139 + items: *142 examples: - default: *153 + default: *156 '404': *7 x-github: githubCloudOnly: false @@ -25552,8 +26099,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: - - *121 - - *149 + - *124 + - *152 requestBody: required: true content: @@ -25603,8 +26150,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: - - *121 - - *149 + - *124 + - *152 - name: repository_id in: path required: true @@ -25637,8 +26184,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: - - *121 - - *149 + - *124 + - *152 - name: repository_id in: path required: true @@ -25677,7 +26224,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: - - *121 + - *124 responses: '200': description: OK @@ -25817,7 +26364,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: - - *121 + - *124 - *20 - name: per_page description: The number of results per page (max 100). For more information, @@ -25840,9 +26387,9 @@ paths: currently being billed. seats: type: array - items: *172 + items: *175 examples: - default: *173 + default: *176 headers: Link: *39 '500': *73 @@ -25880,7 +26427,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: - - *121 + - *124 requestBody: content: application/json: @@ -25958,7 +26505,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: - - *121 + - *124 requestBody: content: application/json: @@ -26039,7 +26586,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: - - *121 + - *124 requestBody: content: application/json: @@ -26117,7 +26664,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: - - *121 + - *124 requestBody: content: application/json: @@ -26173,6 +26720,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: + - *124 + - 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 + - *20 + - 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: *87 + examples: + default: *88 + '500': *73 + '403': *29 + '404': *7 + '422': *89 + 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 @@ -26198,7 +26813,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: - - *121 + - *124 - 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`). @@ -26230,9 +26845,9 @@ paths: application/json: schema: type: array - items: *87 + items: *90 examples: - default: *174 + default: *177 '500': *73 '401': *25 '403': *29 @@ -26258,7 +26873,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: - - *121 + - *124 - *18 - name: page description: Page token @@ -26402,7 +27017,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: - - *121 + - *124 - name: credential_id in: path required: true @@ -26433,7 +27048,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: - - *121 + - *124 responses: '200': description: Response - list of custom role names @@ -26448,7 +27063,7 @@ paths: type: integer custom_roles: type: array - items: *175 + items: *178 examples: default: value: @@ -26535,12 +27150,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *121 + - *124 requestBody: required: true content: application/json: - schema: &178 + schema: &181 type: object properties: name: @@ -26581,9 +27196,9 @@ paths: description: Response content: application/json: - schema: *175 + schema: *178 examples: - default: *176 + default: *179 '422': *16 '404': *7 x-github: @@ -26607,8 +27222,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *121 - - &177 + - *124 + - &180 name: role_id description: The unique identifier of the role. in: path @@ -26620,9 +27235,9 @@ paths: description: Response content: application/json: - schema: *175 + schema: *178 examples: - default: *176 + default: *179 '404': *7 x-github: githubCloudOnly: true @@ -26644,13 +27259,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *121 - - *177 + - *124 + - *180 requestBody: required: true content: application/json: - schema: &179 + schema: &182 type: object properties: name: @@ -26688,9 +27303,9 @@ paths: description: Response content: application/json: - schema: *175 + schema: *178 examples: - default: *176 + default: *179 '422': *16 '404': *7 x-github: @@ -26714,8 +27329,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *121 - - *177 + - *124 + - *180 responses: '204': description: Response @@ -26743,12 +27358,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: - - *121 + - *124 requestBody: required: true content: application/json: - schema: *178 + schema: *181 examples: default: value: @@ -26762,9 +27377,9 @@ paths: description: Response content: application/json: - schema: *175 + schema: *178 examples: - default: *176 + default: *179 '422': *16 '404': *7 x-github: @@ -26794,16 +27409,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: - - *121 - - *177 + - *124 + - *180 responses: '200': description: Response content: application/json: - schema: *175 + schema: *178 examples: - default: *176 + default: *179 '404': *7 x-github: githubCloudOnly: true @@ -26831,13 +27446,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: - - *121 - - *177 + - *124 + - *180 requestBody: required: true content: application/json: - schema: *179 + schema: *182 examples: default: value: @@ -26852,9 +27467,9 @@ paths: description: Response content: application/json: - schema: *175 + schema: *178 examples: - default: *176 + default: *179 '422': *16 '404': *7 x-github: @@ -26884,8 +27499,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: - - *121 - - *177 + - *124 + - *180 responses: '204': description: Response @@ -26913,18 +27528,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *121 - - *180 - - *181 - - *182 + - *124 - *183 - *184 - *185 + - *186 + - *187 + - *188 - *67 - *65 - *66 - - *186 - - *187 + - *189 + - *190 - *18 responses: '200': @@ -26933,9 +27548,9 @@ paths: application/json: schema: type: array - items: *188 + items: *191 examples: - default: *189 + default: *192 '304': *37 '400': *15 '403': *29 @@ -26961,7 +27576,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *121 + - *124 - *18 - *20 responses: @@ -26979,7 +27594,7 @@ paths: type: integer secrets: type: array - items: &190 + items: &193 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -27050,13 +27665,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: &431 + schema: &434 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -27073,7 +27688,7 @@ paths: - key_id - key examples: - default: &432 + default: &435 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -27096,14 +27711,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *121 - - *149 + - *124 + - *152 responses: '200': description: Response content: application/json: - schema: *190 + schema: *193 examples: default: value: @@ -27131,8 +27746,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *121 - - *149 + - *124 + - *152 requestBody: required: true content: @@ -27187,7 +27802,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -27211,8 +27826,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *121 - - *149 + - *124 + - *152 responses: '204': description: Response @@ -27236,8 +27851,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: - - *121 - - *149 + - *124 + - *152 - *20 - *18 responses: @@ -27255,9 +27870,9 @@ paths: type: integer repositories: type: array - items: *139 + items: *142 examples: - default: *153 + default: *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27278,8 +27893,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: - - *121 - - *149 + - *124 + - *152 requestBody: required: true content: @@ -27329,8 +27944,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: - - *121 - - *149 + - *124 + - *152 - name: repository_id in: path required: true @@ -27361,8 +27976,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: - - *121 - - *149 + - *124 + - *152 - name: repository_id in: path required: true @@ -27392,7 +28007,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: - - *121 + - *124 responses: '200': description: Response @@ -27400,7 +28015,7 @@ paths: application/json: schema: type: array - items: &223 + items: &226 title: Package description: A software package type: object @@ -27450,8 +28065,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *191 - required: *192 + properties: *194 + required: *195 nullable: true created_at: type: string @@ -27470,7 +28085,7 @@ paths: - created_at - updated_at examples: - default: &224 + default: &227 value: - id: 197 name: hello_docker @@ -27548,7 +28163,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *121 + - *124 - *18 - *20 responses: @@ -27558,7 +28173,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: 200-response: value: @@ -27628,7 +28243,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *121 + - *124 - name: group_id description: The unique identifier of the group. in: path @@ -27654,7 +28269,7 @@ paths: description: Response content: application/json: - schema: &287 + schema: &290 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -27735,7 +28350,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &288 + default: &291 value: group_id: '123' group_name: Octocat admins @@ -27773,7 +28388,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: - - *121 + - *124 - *18 - name: page description: Page token @@ -27790,7 +28405,7 @@ paths: description: Response content: application/json: - schema: &285 + schema: &288 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -27827,7 +28442,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &286 + default: &289 value: groups: - group_id: '123' @@ -27861,7 +28476,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *121 + - *124 - *18 - *20 responses: @@ -27871,7 +28486,7 @@ paths: application/json: schema: type: array - items: &204 + items: &207 title: Organization Invitation description: Organization Invitation type: object @@ -27918,7 +28533,7 @@ paths: - invitation_teams_url - node_id examples: - default: &205 + default: &208 value: - id: 1 login: monalisa @@ -27977,7 +28592,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: - - *121 + - *124 responses: '200': description: Response @@ -27985,7 +28600,7 @@ paths: application/json: schema: type: array - items: &245 + items: &248 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -27999,7 +28614,7 @@ paths: - name - description examples: - default: &246 + default: &249 value: - name: add_assignee description: Assign or remove a user @@ -28030,7 +28645,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *121 + - *124 - *18 - *20 responses: @@ -28040,7 +28655,7 @@ paths: application/json: schema: type: array - items: &193 + items: &196 title: Org Hook description: Org Hook type: object @@ -28149,7 +28764,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *121 + - *124 requestBody: required: true content: @@ -28209,9 +28824,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *196 examples: - default: &194 + default: &197 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -28255,8 +28870,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *121 - - &195 + - *124 + - &198 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. @@ -28269,9 +28884,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *196 examples: - default: *194 + default: *197 '404': *7 x-github: githubCloudOnly: false @@ -28292,8 +28907,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *121 - - *195 + - *124 + - *198 requestBody: required: false content: @@ -28338,7 +28953,7 @@ paths: description: Response content: application/json: - schema: *193 + schema: *196 examples: default: value: @@ -28377,8 +28992,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *121 - - *195 + - *124 + - *198 responses: '204': description: Response @@ -28403,8 +29018,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: - - *121 - - *195 + - *124 + - *198 responses: '200': description: Response @@ -28432,8 +29047,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: - - *121 - - *195 + - *124 + - *198 requestBody: required: false content: @@ -28481,10 +29096,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *121 - - *195 + - *124 + - *198 - *18 - - *196 + - *199 - name: redelivery in: query required: false @@ -28497,9 +29112,9 @@ paths: application/json: schema: type: array - items: *197 + items: *200 examples: - default: *198 + default: *201 '400': *15 '422': *16 x-github: @@ -28522,17 +29137,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: - - *121 - - *195 + - *124 + - *198 - *17 responses: '200': description: Response content: application/json: - schema: *199 + schema: *202 examples: - default: *200 + default: *203 '400': *15 '422': *16 x-github: @@ -28555,11 +29170,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: - - *121 - - *195 + - *124 + - *198 - *17 responses: - '202': *127 + '202': *130 '400': *15 '422': *16 x-github: @@ -28582,8 +29197,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *121 - - *195 + - *124 + - *198 responses: '204': description: Response @@ -28607,7 +29222,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: - - *121 + - *124 responses: '200': description: Response @@ -28615,7 +29230,7 @@ paths: application/json: schema: *22 examples: - default: &470 + default: &473 value: id: 1 account: @@ -28684,7 +29299,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *121 + - *124 - *18 - *20 responses: @@ -28773,7 +29388,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *121 + - *124 responses: '200': description: Response @@ -28781,12 +29396,12 @@ paths: application/json: schema: anyOf: - - &202 + - &205 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &201 + limit: &204 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -28811,7 +29426,7 @@ paths: properties: {} additionalProperties: false examples: - default: &203 + default: &206 value: limit: collaborators_only origin: organization @@ -28835,18 +29450,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *121 + - *124 requestBody: required: true content: application/json: - schema: &471 + schema: &474 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *201 + limit: *204 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -28870,9 +29485,9 @@ paths: description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *203 + default: *206 '422': *16 x-github: githubCloudOnly: false @@ -28890,7 +29505,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *121 + - *124 responses: '204': description: Response @@ -28916,7 +29531,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *121 + - *124 - *18 - *20 - name: role @@ -28950,9 +29565,9 @@ paths: application/json: schema: type: array - items: *204 + items: *207 examples: - default: *205 + default: *208 headers: Link: *39 '404': *7 @@ -28976,7 +29591,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *121 + - *124 requestBody: required: false content: @@ -29030,7 +29645,7 @@ paths: description: Response content: application/json: - schema: *204 + schema: *207 examples: default: value: @@ -29086,8 +29701,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *121 - - &206 + - *124 + - &209 name: invitation_id description: The unique identifier of the invitation. in: path @@ -29120,8 +29735,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *121 - - *206 + - *124 + - *209 - *18 - *20 responses: @@ -29131,9 +29746,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - default: &222 + default: &225 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -29178,7 +29793,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: - - *121 + - *124 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -29208,7 +29823,7 @@ paths: - closed - all default: open - - *208 + - *211 - name: sort description: What to sort results by. in: query @@ -29221,7 +29836,7 @@ paths: - comments default: created - *67 - - *94 + - *97 - *18 - *20 responses: @@ -29231,9 +29846,9 @@ paths: application/json: schema: type: array - items: *104 + items: *107 examples: - default: *209 + default: *212 headers: Link: *39 '404': *7 @@ -29255,7 +29870,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *121 + - *124 - 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) @@ -29291,7 +29906,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 '422': *16 @@ -29311,8 +29926,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response if requester is an organization member and user is @@ -29343,8 +29958,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response @@ -29370,8 +29985,8 @@ paths: parameters: - *18 - *20 - - *121 - - *161 + - *124 + - *164 responses: '200': description: Response @@ -29387,9 +30002,9 @@ paths: type: integer codespaces: type: array - items: *211 + items: *214 examples: - default: *212 + default: *215 '304': *37 '500': *73 '401': *25 @@ -29414,9 +30029,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *121 - - *161 - - &213 + - *124 + - *164 + - &216 name: codespace_name in: path required: true @@ -29424,7 +30039,7 @@ paths: schema: type: string responses: - '202': *127 + '202': *130 '304': *37 '500': *73 '401': *25 @@ -29449,17 +30064,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: - - *121 - - *161 - - *213 + - *124 + - *164 + - *216 responses: '200': description: Response content: application/json: - schema: *211 + schema: *214 examples: - default: &397 + default: &400 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -29629,14 +30244,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: - - *121 - - *161 + - *124 + - *164 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *172 + schema: *175 examples: default: value: @@ -29704,14 +30319,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *121 - - *161 + - *124 + - *164 responses: '200': description: Response content: application/json: - schema: &214 + schema: &217 title: Org Membership description: Org Membership type: object @@ -29763,7 +30378,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &215 + response-if-user-has-an-active-admin-membership-with-organization: &218 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -29831,8 +30446,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *121 - - *161 + - *124 + - *164 requestBody: required: false content: @@ -29860,9 +30475,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *217 examples: - response-if-user-already-had-membership-with-organization: *215 + response-if-user-already-had-membership-with-organization: *218 '422': *16 '403': *29 x-github: @@ -29883,8 +30498,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response @@ -29909,7 +30524,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *121 + - *124 - *18 - *20 - name: exclude @@ -29930,7 +30545,7 @@ paths: application/json: schema: type: array - items: &216 + items: &219 title: Migration description: A migration. type: object @@ -30183,7 +30798,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *121 + - *124 requestBody: required: true content: @@ -30259,7 +30874,7 @@ paths: description: Response content: application/json: - schema: *216 + schema: *219 examples: default: value: @@ -30437,8 +31052,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *121 - - &217 + - *124 + - &220 name: migration_id description: The unique identifier of the migration. in: path @@ -30465,7 +31080,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *216 + schema: *219 examples: default: value: @@ -30634,8 +31249,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *121 - - *217 + - *124 + - *220 responses: '302': description: Response @@ -30656,8 +31271,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *121 - - *217 + - *124 + - *220 responses: '204': description: Response @@ -30680,9 +31295,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *121 - - *217 - - &641 + - *124 + - *220 + - &644 name: repo_name description: repo_name parameter in: path @@ -30709,8 +31324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *121 - - *217 + - *124 + - *220 - *18 - *20 responses: @@ -30720,9 +31335,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: &229 + default: &232 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -30861,7 +31476,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: - - *121 + - *124 responses: '200': description: Response @@ -30915,7 +31530,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: - - *121 + - *124 responses: '200': description: Response - list of organization roles @@ -30931,7 +31546,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &218 + items: &221 title: Organization Role description: Organization roles type: object @@ -31071,7 +31686,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *121 + - *124 requestBody: required: true content: @@ -31118,7 +31733,7 @@ paths: description: Response content: application/json: - schema: *218 + schema: *221 examples: default: value: @@ -31147,7 +31762,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *16 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -31169,8 +31784,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: - - *121 - - *219 + - *124 + - *222 responses: '204': description: Response @@ -31195,9 +31810,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: - - *121 - - *219 - - *177 + - *124 + - *222 + - *180 responses: '204': description: Response @@ -31226,9 +31841,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: - - *121 - - *219 - - *177 + - *124 + - *222 + - *180 responses: '204': description: Response @@ -31253,8 +31868,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: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response @@ -31279,9 +31894,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: - - *121 - - *161 - - *177 + - *124 + - *164 + - *180 responses: '204': description: Response @@ -31311,9 +31926,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: - - *121 - - *161 - - *177 + - *124 + - *164 + - *180 responses: '204': description: Response @@ -31341,14 +31956,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *121 - - *177 + - *124 + - *180 responses: '200': description: Response content: application/json: - schema: *218 + schema: *221 examples: default: value: @@ -31405,8 +32020,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *121 - - *177 + - *124 + - *180 requestBody: required: true content: @@ -31445,7 +32060,7 @@ paths: description: Response content: application/json: - schema: *218 + schema: *221 examples: default: value: @@ -31473,7 +32088,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *16 - '409': *126 + '409': *129 '404': *7 x-github: githubCloudOnly: true @@ -31498,8 +32113,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *121 - - *177 + - *124 + - *180 responses: '204': description: Response @@ -31524,8 +32139,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: - - *121 - - *177 + - *124 + - *180 - *18 - *20 responses: @@ -31594,8 +32209,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *220 - required: *221 + properties: *223 + required: *224 nullable: true required: - id @@ -31610,7 +32225,7 @@ paths: - slug - parent examples: - default: *222 + default: *225 headers: Link: *39 '404': @@ -31639,8 +32254,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: - - *121 - - *177 + - *124 + - *180 - *18 - *20 responses: @@ -31750,7 +32365,7 @@ paths: - type - url examples: - default: *210 + default: *213 headers: Link: *39 '404': @@ -31774,7 +32389,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: - - *121 + - *124 - 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) @@ -31798,7 +32413,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 x-github: @@ -31823,8 +32438,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: - - *121 - - *161 + - *124 + - *164 requestBody: required: false content: @@ -31881,8 +32496,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: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response @@ -31939,8 +32554,8 @@ paths: - docker - nuget - container - - *121 - - &643 + - *124 + - &646 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -31976,12 +32591,12 @@ paths: application/json: schema: type: array - items: *223 + items: *226 examples: - default: *224 + default: *227 '403': *29 '401': *25 - '400': &645 + '400': &648 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -32003,7 +32618,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &225 + - &228 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 @@ -32021,20 +32636,20 @@ paths: - docker - nuget - container - - &226 + - &229 name: package_name description: The name of the package. in: path required: true schema: type: string - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: *223 + schema: *226 examples: default: value: @@ -32086,9 +32701,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *225 - - *226 - - *121 + - *228 + - *229 + - *124 responses: '204': description: Response @@ -32120,9 +32735,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *225 - - *226 - - *121 + - *228 + - *229 + - *124 - name: token description: package token schema: @@ -32154,9 +32769,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: - - *225 - - *226 - - *121 + - *228 + - *229 + - *124 - *20 - *18 - name: state @@ -32176,7 +32791,7 @@ paths: application/json: schema: type: array - items: &227 + items: &230 title: Package Version description: A version of a software package type: object @@ -32301,10 +32916,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: - - *225 - - *226 - - *121 - - &228 + - *228 + - *229 + - *124 + - &231 name: package_version_id description: Unique identifier of the package version. in: path @@ -32316,7 +32931,7 @@ paths: description: Response content: application/json: - schema: *227 + schema: *230 examples: default: value: @@ -32352,10 +32967,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *225 - - *226 - - *121 - *228 + - *229 + - *124 + - *231 responses: '204': description: Response @@ -32387,10 +33002,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *225 - - *226 - - *121 - *228 + - *229 + - *124 + - *231 responses: '204': description: Response @@ -32417,10 +33032,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: - - *121 + - *124 - *18 - *20 - - &230 + - &233 name: sort description: The property by which to sort the results. in: query @@ -32431,7 +33046,7 @@ paths: - created_at default: created_at - *67 - - &231 + - &234 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -32442,7 +33057,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &232 + - &235 name: repository description: The name of the repository to use to filter the results. in: query @@ -32450,7 +33065,7 @@ paths: schema: type: string example: Hello-World - - &233 + - &236 name: permission description: The permission to use to filter the results. in: query @@ -32458,7 +33073,7 @@ paths: schema: type: string example: issues_read - - &234 + - &237 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) @@ -32468,7 +33083,7 @@ paths: schema: type: string format: date-time - - &235 + - &238 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) @@ -32617,7 +33232,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: - - *121 + - *124 requestBody: required: true content: @@ -32662,7 +33277,7 @@ paths: '422': *16 '404': *7 '403': *29 - '202': *127 + '202': *130 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32683,7 +33298,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: - - *121 + - *124 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -32723,7 +33338,7 @@ paths: '422': *16 '404': *7 '403': *29 - '204': *170 + '204': *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32744,7 +33359,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: - - *121 + - *124 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -32764,9 +33379,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 x-github: @@ -32789,16 +33404,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: - - *121 + - *124 - *18 - *20 - - *230 - - *67 - - *231 - - *232 - *233 + - *67 - *234 - *235 + - *236 + - *237 + - *238 responses: '500': *73 '422': *16 @@ -32933,7 +33548,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: - - *121 + - *124 requestBody: required: true content: @@ -32970,7 +33585,7 @@ paths: responses: '500': *73 '404': *7 - '202': *127 + '202': *130 '403': *29 '422': *16 x-github: @@ -32993,7 +33608,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: - - *121 + - *124 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -33023,7 +33638,7 @@ paths: responses: '500': *73 '404': *7 - '204': *170 + '204': *173 '403': *29 '422': *16 x-github: @@ -33045,7 +33660,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: - - *121 + - *124 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -33064,9 +33679,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 x-github: @@ -33088,7 +33703,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-organization-projects parameters: - - *121 + - *124 - name: state description: Indicates the state of the projects to return. in: query @@ -33109,7 +33724,7 @@ paths: application/json: schema: type: array - items: &236 + items: &239 title: Project description: Projects are a way to organize columns and cards of work. @@ -33253,7 +33868,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-an-organization-project parameters: - - *121 + - *124 requestBody: required: true content: @@ -33279,7 +33894,7 @@ paths: description: Response content: application/json: - schema: *236 + schema: *239 examples: default: value: @@ -33317,7 +33932,7 @@ paths: '401': *25 '403': *29 '404': *7 - '410': &303 + '410': &306 description: Gone content: application/json: @@ -33341,7 +33956,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: - - *121 + - *124 responses: '200': description: Response @@ -33349,7 +33964,7 @@ paths: application/json: schema: type: array - items: &237 + items: &240 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -33408,7 +34023,7 @@ paths: - property_name - value_type examples: - default: &238 + default: &241 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -33449,7 +34064,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: - - *121 + - *124 requestBody: required: true content: @@ -33460,7 +34075,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *237 + items: *240 minItems: 1 maxItems: 100 required: @@ -33490,9 +34105,9 @@ paths: application/json: schema: type: array - items: *237 + items: *240 examples: - default: *238 + default: *241 '403': *29 '404': *7 x-github: @@ -33513,8 +34128,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: - - *121 - - &239 + - *124 + - &242 name: custom_property_name description: The custom property name in: path @@ -33526,9 +34141,9 @@ paths: description: Response content: application/json: - schema: *237 + schema: *240 examples: - default: &240 + default: &243 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -33561,8 +34176,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: - - *121 - - *239 + - *124 + - *242 requestBody: required: true content: @@ -33621,9 +34236,9 @@ paths: description: Response content: application/json: - schema: *237 + schema: *240 examples: - default: *240 + default: *243 '403': *29 '404': *7 x-github: @@ -33646,10 +34261,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: - - *121 - - *239 + - *124 + - *242 responses: - '204': *170 + '204': *173 '403': *29 '404': *7 x-github: @@ -33670,7 +34285,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: - - *121 + - *124 - *18 - *20 - name: repository_query @@ -33708,7 +34323,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &241 + items: &244 title: Custom Property Value description: Custom property name and associated value type: object @@ -33775,7 +34390,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: - - *121 + - *124 requestBody: required: true content: @@ -33795,7 +34410,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *241 + items: *244 required: - repository_names - properties @@ -33836,7 +34451,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *121 + - *124 - *18 - *20 responses: @@ -33848,7 +34463,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 x-github: @@ -33867,8 +34482,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: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response if user is a public member @@ -33892,8 +34507,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: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response @@ -33914,8 +34529,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: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response @@ -33939,7 +34554,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *121 + - *124 - 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 @@ -33986,9 +34601,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 x-github: @@ -34009,7 +34624,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *121 + - *124 requestBody: required: true content: @@ -34191,7 +34806,7 @@ paths: description: Response content: application/json: - schema: &305 + schema: &308 title: Full Repository description: Full Repository type: object @@ -34468,8 +35083,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *242 - required: *243 + properties: *245 + required: *246 nullable: true temp_clone_token: type: string @@ -34556,8 +35171,8 @@ paths: title: License Simple description: License Simple type: object - properties: *105 - required: *106 + properties: *108 + required: *109 nullable: true organization: title: Simple User @@ -34584,7 +35199,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &419 + properties: &422 url: type: string format: uri @@ -34600,12 +35215,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &420 + required: &423 - url - key - name - html_url - security_and_analysis: *244 + security_and_analysis: *247 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -34689,7 +35304,7 @@ paths: - network_count - subscribers_count examples: - default: &307 + default: &310 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -35207,7 +35822,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: - - *121 + - *124 responses: '200': description: Response @@ -35215,9 +35830,9 @@ paths: application/json: schema: type: array - items: *245 + items: *248 examples: - default: *246 + default: *249 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -35239,10 +35854,10 @@ paths: category: orgs subcategory: rules parameters: - - *121 + - *124 - *18 - *20 - - &555 + - &558 name: targets description: | A comma-separated list of rule targets to filter by. @@ -35260,7 +35875,7 @@ paths: application/json: schema: type: array - items: &253 + items: &256 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -35293,7 +35908,7 @@ paths: source: type: string description: The name of the source - enforcement: &249 + enforcement: &252 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -35305,7 +35920,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &250 + items: &253 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -35372,7 +35987,7 @@ paths: conditions: nullable: true anyOf: - - &247 + - &250 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -35396,7 +36011,7 @@ paths: match. items: type: string - - &251 + - &254 title: Organization ruleset conditions type: object description: |- @@ -35409,7 +36024,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *247 + - *250 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -35443,7 +36058,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *247 + - *250 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -35465,7 +36080,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *247 + - *250 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -35478,7 +36093,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &248 + items: &251 title: Repository ruleset property targeting definition type: object @@ -35511,17 +36126,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *248 + items: *251 required: - repository_property rules: type: array - items: &252 + items: &255 title: Repository Rule type: object description: A repository rule. oneOf: - - &537 + - &540 title: creation description: Only allow users with bypass permission to create matching refs. @@ -35533,7 +36148,7 @@ paths: type: string enum: - creation - - &538 + - &541 title: update description: Only allow users with bypass permission to update matching refs. @@ -35554,7 +36169,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &540 + - &543 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -35566,7 +36181,7 @@ paths: type: string enum: - deletion - - &541 + - &544 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -35578,7 +36193,7 @@ paths: type: string enum: - required_linear_history - - &542 + - &545 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -35656,7 +36271,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &543 + - &546 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -35680,7 +36295,7 @@ paths: type: string required: - required_deployment_environments - - &544 + - &547 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -35692,7 +36307,7 @@ paths: type: string enum: - required_signatures - - &545 + - &548 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -35738,7 +36353,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &546 + - &549 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -35786,7 +36401,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &547 + - &550 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -35798,7 +36413,7 @@ paths: type: string enum: - non_fast_forward - - &548 + - &551 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -35834,7 +36449,7 @@ paths: required: - operator - pattern - - &549 + - &552 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -35870,7 +36485,7 @@ paths: required: - operator - pattern - - &550 + - &553 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -35906,7 +36521,7 @@ paths: required: - operator - pattern - - &551 + - &554 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -35942,7 +36557,7 @@ paths: required: - operator - pattern - - &552 + - &555 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -36068,7 +36683,7 @@ paths: maximum: 100 required: - max_file_size - - &553 + - &556 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -36118,7 +36733,7 @@ paths: - repository_id required: - workflows - - &554 + - &557 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -36231,7 +36846,7 @@ paths: category: orgs subcategory: rules parameters: - - *121 + - *124 requestBody: description: Request body required: true @@ -36251,16 +36866,16 @@ paths: - tag - push default: branch - enforcement: *249 + enforcement: *252 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *250 - conditions: *251 + items: *253 + conditions: *254 rules: type: array description: An array of rules within the ruleset. - items: *252 + items: *255 required: - name - enforcement @@ -36298,9 +36913,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: &254 + default: &257 value: id: 21 name: super cool ruleset @@ -36354,8 +36969,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *121 - - &556 + - *124 + - &559 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 @@ -36371,7 +36986,7 @@ paths: in: query schema: type: integer - - &557 + - &560 name: time_period description: |- The time period to filter by. @@ -36387,14 +37002,14 @@ paths: - week - month default: day - - &558 + - &561 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 - - &559 + - &562 name: rule_suite_result description: The rule results to filter on. When specified, only suites with this result will be returned. @@ -36414,7 +37029,7 @@ paths: description: Response content: application/json: - schema: &560 + schema: &563 title: Rule Suites description: Response type: array @@ -36469,7 +37084,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &561 + default: &564 value: - id: 21 actor_id: 12 @@ -36512,8 +37127,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *121 - - &562 + - *124 + - &565 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -36529,7 +37144,7 @@ paths: description: Response content: application/json: - schema: &563 + schema: &566 title: Rule Suite description: Response type: object @@ -36628,7 +37243,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &564 + default: &567 value: id: 21 actor_id: 12 @@ -36689,7 +37304,7 @@ paths: category: orgs subcategory: rules parameters: - - *121 + - *124 - name: ruleset_id description: The ID of the ruleset. in: path @@ -36701,9 +37316,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: *254 + default: *257 '404': *7 '500': *73 put: @@ -36721,7 +37336,7 @@ paths: category: orgs subcategory: rules parameters: - - *121 + - *124 - name: ruleset_id description: The ID of the ruleset. in: path @@ -36746,16 +37361,16 @@ paths: - branch - tag - push - enforcement: *249 + enforcement: *252 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *250 - conditions: *251 + items: *253 + conditions: *254 rules: description: An array of rules within the ruleset. type: array - items: *252 + items: *255 examples: default: value: @@ -36790,9 +37405,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: *254 + default: *257 '404': *7 '500': *73 delete: @@ -36810,7 +37425,7 @@ paths: category: orgs subcategory: rules parameters: - - *121 + - *124 - name: ruleset_id description: The ID of the ruleset. in: path @@ -36838,15 +37453,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: - - *121 - - *255 - - *256 - - *257 + - *124 - *258 + - *259 + - *260 + - *261 - *67 - *20 - *18 - - &566 + - &569 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 @@ -36856,7 +37471,7 @@ paths: required: false schema: type: string - - &567 + - &570 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 @@ -36866,9 +37481,9 @@ paths: required: false schema: type: string - - *259 - - *260 - - *261 + - *262 + - *263 + - *264 responses: '200': description: Response @@ -36876,9 +37491,9 @@ paths: application/json: schema: type: array - items: *262 + items: *265 examples: - default: *263 + default: *266 headers: Link: *39 '404': *7 @@ -36904,7 +37519,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: - - *121 + - *124 - *67 - name: sort description: The property to sort the results by. @@ -36948,7 +37563,7 @@ paths: application/json: schema: type: array - items: &573 + items: &576 description: A repository security advisory. type: object properties: @@ -37168,7 +37783,7 @@ paths: login: type: string description: The username of the user credited. - type: *264 + type: *267 credits_detailed: type: array nullable: true @@ -37178,7 +37793,7 @@ paths: type: object properties: user: *19 - type: *264 + type: *267 state: type: string description: The state of the user's acceptance of the @@ -37202,7 +37817,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *207 + items: *210 private_fork: readOnly: true nullable: true @@ -37239,7 +37854,7 @@ paths: - private_fork additionalProperties: false examples: - default: &574 + default: &577 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -37621,7 +38236,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *121 + - *124 responses: '200': description: Response @@ -37629,15 +38244,15 @@ paths: application/json: schema: type: array - items: &516 + items: &519 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *220 - required: *221 + properties: *223 + required: *224 examples: - default: *222 + default: *225 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37660,8 +38275,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *121 - - *219 + - *124 + - *222 responses: '204': description: Response @@ -37686,8 +38301,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *121 - - *219 + - *124 + - *222 responses: '204': description: Response @@ -37713,15 +38328,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: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: *265 + schema: *268 examples: - default: *266 + default: *269 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -37745,7 +38360,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: - - *121 + - *124 - *18 - *20 responses: @@ -37753,9 +38368,9 @@ paths: description: Success content: application/json: - schema: *267 + schema: *270 examples: - default: *268 + default: *271 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -37777,15 +38392,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: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -37807,15 +38422,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: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: *271 + schema: *274 examples: - default: *272 + default: *275 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -37832,7 +38447,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: - - *121 + - *124 - *18 - name: page description: Page token @@ -37851,7 +38466,7 @@ paths: description: Response content: application/json: - schema: &294 + schema: &297 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -37897,7 +38512,7 @@ paths: type: string nullable: true examples: - default: &295 + default: &298 value: groups: - group_id: '123' @@ -37918,36 +38533,32 @@ paths: enabledForGitHubApps: true category: teams subcategory: team-sync - "/orgs/{org}/team/{team_slug}/copilot/usage": + "/orgs/{org}/team/{team_slug}/copilot/metrics": get: - summary: Get a summary of Copilot usage for a team + summary: Get Copilot metrics for a team description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - 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. Usage metrics are processed once per day for the previous 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. - > [!NOTE] - > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day. - - Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team. + 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/usage-metrics-for-team + operationId: copilot/copilot-metrics-for-team externalDocs: 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 + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *121 - - *219 + - *124 + - *222 - 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`). @@ -37981,7 +38592,80 @@ paths: type: array items: *87 examples: - default: *174 + default: *88 + '500': *73 + '403': *29 + '404': *7 + '422': *89 + 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 + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE + for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. + See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Usage 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 team had five or more members with active Copilot licenses, as evaluated at the end of that day. + + Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage 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/usage-metrics-for-team + externalDocs: + 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: + - *124 + - *222 + - 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 + - *20 + - 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: *90 + examples: + default: *177 '500': *73 '401': *25 '403': *29 @@ -38003,7 +38687,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *121 + - *124 - *18 - *20 responses: @@ -38013,9 +38697,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - default: *222 + default: *225 headers: Link: *39 '403': *29 @@ -38037,7 +38721,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *121 + - *124 requestBody: required: true content: @@ -38109,7 +38793,7 @@ paths: description: Response content: application/json: - schema: &273 + schema: &276 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -38172,8 +38856,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *220 - required: *221 + properties: *223 + required: *224 nullable: true members_count: type: integer @@ -38419,7 +39103,7 @@ paths: - repos_count - organization examples: - default: &274 + default: &277 value: id: 1 node_id: MDQ6VGVhbTE= @@ -38489,16 +39173,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *121 - - *219 + - *124 + - *222 responses: '200': description: Response content: application/json: - schema: *273 + schema: *276 examples: - default: *274 + default: *277 '404': *7 x-github: githubCloudOnly: false @@ -38519,8 +39203,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *121 - - *219 + - *124 + - *222 requestBody: required: false content: @@ -38582,16 +39266,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *273 + schema: *276 examples: - default: *274 + default: *277 '201': description: Response content: application/json: - schema: *273 + schema: *276 examples: - default: *274 + default: *277 '404': *7 '422': *16 '403': *29 @@ -38616,8 +39300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *121 - - *219 + - *124 + - *222 responses: '204': description: Response @@ -38643,8 +39327,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *121 - - *219 + - *124 + - *222 - *67 - *18 - *20 @@ -38661,7 +39345,7 @@ paths: application/json: schema: type: array - items: &275 + items: &278 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -38740,7 +39424,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *92 + reactions: *95 required: - author - body @@ -38760,7 +39444,7 @@ paths: - updated_at - url examples: - default: &614 + default: &617 value: - author: login: octocat @@ -38834,8 +39518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *121 - - *219 + - *124 + - *222 requestBody: required: true content: @@ -38869,9 +39553,9 @@ paths: description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: &276 + default: &279 value: author: login: octocat @@ -38943,9 +39627,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *121 - - *219 - - &277 + - *124 + - *222 + - &280 name: discussion_number description: The number that identifies the discussion. in: path @@ -38957,9 +39641,9 @@ paths: description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: *276 + default: *279 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38981,9 +39665,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *121 - - *219 - - *277 + - *124 + - *222 + - *280 requestBody: required: false content: @@ -39006,9 +39690,9 @@ paths: description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: &615 + default: &618 value: author: login: octocat @@ -39078,9 +39762,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *121 - - *219 - - *277 + - *124 + - *222 + - *280 responses: '204': description: Response @@ -39106,9 +39790,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *121 - - *219 - - *277 + - *124 + - *222 + - *280 - *67 - *18 - *20 @@ -39119,7 +39803,7 @@ paths: application/json: schema: type: array - items: &278 + items: &281 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -39176,7 +39860,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *92 + reactions: *95 required: - author - body @@ -39191,7 +39875,7 @@ paths: - updated_at - url examples: - default: &616 + default: &619 value: - author: login: octocat @@ -39259,9 +39943,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *121 - - *219 - - *277 + - *124 + - *222 + - *280 requestBody: required: true content: @@ -39283,9 +39967,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *281 examples: - default: &279 + default: &282 value: author: login: octocat @@ -39351,10 +40035,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *121 - - *219 - - *277 - - &280 + - *124 + - *222 + - *280 + - &283 name: comment_number description: The number that identifies the comment. in: path @@ -39366,9 +40050,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *281 examples: - default: *279 + default: *282 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39390,10 +40074,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *121 - - *219 - - *277 + - *124 + - *222 - *280 + - *283 requestBody: required: true content: @@ -39415,9 +40099,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *281 examples: - default: &617 + default: &620 value: author: login: octocat @@ -39481,10 +40165,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *121 - - *219 - - *277 + - *124 + - *222 - *280 + - *283 responses: '204': description: Response @@ -39510,10 +40194,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: - - *121 - - *219 - - *277 + - *124 + - *222 - *280 + - *283 - 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. @@ -39539,7 +40223,7 @@ paths: application/json: schema: type: array - items: &281 + items: &284 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -39582,7 +40266,7 @@ paths: - content - created_at examples: - default: &283 + default: &286 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -39632,10 +40316,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: - - *121 - - *219 - - *277 + - *124 + - *222 - *280 + - *283 requestBody: required: true content: @@ -39668,9 +40352,9 @@ paths: team discussion comment content: application/json: - schema: *281 + schema: *284 examples: - default: &282 + default: &285 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -39699,9 +40383,9 @@ paths: description: Response content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39724,11 +40408,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *121 - - *219 - - *277 + - *124 + - *222 - *280 - - &284 + - *283 + - &287 name: reaction_id description: The unique identifier of the reaction. in: path @@ -39760,9 +40444,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *121 - - *219 - - *277 + - *124 + - *222 + - *280 - 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. @@ -39788,9 +40472,9 @@ paths: application/json: schema: type: array - items: *281 + items: *284 examples: - default: *283 + default: *286 headers: Link: *39 x-github: @@ -39816,9 +40500,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *121 - - *219 - - *277 + - *124 + - *222 + - *280 requestBody: required: true content: @@ -39850,16 +40534,16 @@ paths: description: Response content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '201': description: Response content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -39882,10 +40566,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *121 - - *219 - - *277 - - *284 + - *124 + - *222 + - *280 + - *287 responses: '204': description: Response @@ -39908,16 +40592,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: - - *121 - - *219 + - *124 + - *222 responses: '200': description: Response content: application/json: - schema: *285 + schema: *288 examples: - default: *286 + default: *289 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -39936,8 +40620,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: - - *121 - - *219 + - *124 + - *222 requestBody: required: true content: @@ -39960,9 +40644,9 @@ paths: description: Response content: application/json: - schema: *287 + schema: *290 examples: - default: *288 + default: *291 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -39981,8 +40665,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: - - *121 - - *219 + - *124 + - *222 responses: '204': description: Response @@ -40006,8 +40690,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *121 - - *219 + - *124 + - *222 - *18 - *20 responses: @@ -40017,9 +40701,9 @@ paths: application/json: schema: type: array - items: *204 + items: *207 examples: - default: *205 + default: *208 headers: Link: *39 x-github: @@ -40041,8 +40725,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *121 - - *219 + - *124 + - *222 - name: role description: Filters members returned by their role in the team. in: query @@ -40065,7 +40749,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 x-github: @@ -40095,15 +40779,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *121 - - *219 - - *161 + - *124 + - *222 + - *164 responses: '200': description: Response content: application/json: - schema: &289 + schema: &292 title: Team Membership description: Team Membership type: object @@ -40130,7 +40814,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &618 + response-if-user-is-a-team-maintainer: &621 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -40166,9 +40850,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: - - *121 - - *219 - - *161 + - *124 + - *222 + - *164 requestBody: required: false content: @@ -40193,9 +40877,9 @@ paths: description: Response content: application/json: - schema: *289 + schema: *292 examples: - response-if-users-membership-with-team-is-now-pending: &619 + response-if-users-membership-with-team-is-now-pending: &622 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -40230,9 +40914,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *121 - - *219 - - *161 + - *124 + - *222 + - *164 responses: '204': description: Response @@ -40258,8 +40942,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - - *121 - - *219 + - *124 + - *222 - *18 - *20 responses: @@ -40269,7 +40953,7 @@ paths: application/json: schema: type: array - items: &290 + items: &293 title: Team Project description: A team's access to a project. type: object @@ -40337,7 +41021,7 @@ paths: - updated_at - permissions examples: - default: &620 + default: &623 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -40398,9 +41082,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - - *121 - - *219 - - &291 + - *124 + - *222 + - &294 name: project_id description: The unique identifier of the project. in: path @@ -40412,9 +41096,9 @@ paths: description: Response content: application/json: - schema: *290 + schema: *293 examples: - default: &621 + default: &624 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -40474,9 +41158,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - - *121 - - *219 - - *291 + - *124 + - *222 + - *294 requestBody: required: false content: @@ -40540,9 +41224,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - - *121 - - *219 - - *291 + - *124 + - *222 + - *294 responses: '204': description: Response @@ -40566,8 +41250,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *121 - - *219 + - *124 + - *222 - *18 - *20 responses: @@ -40577,9 +41261,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 x-github: @@ -40608,16 +41292,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *121 - - *219 - - *292 - - *293 + - *124 + - *222 + - *295 + - *296 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &622 + schema: &625 title: Team Repository description: A team's access to a repository. type: object @@ -40640,8 +41324,8 @@ paths: title: License Simple description: License Simple type: object - properties: *105 - required: *106 + properties: *108 + required: *109 nullable: true forks: type: integer @@ -41186,10 +41870,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *121 - - *219 - - *292 - - *293 + - *124 + - *222 + - *295 + - *296 requestBody: required: false content: @@ -41234,10 +41918,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *121 - - *219 - - *292 - - *293 + - *124 + - *222 + - *295 + - *296 responses: '204': description: Response @@ -41263,16 +41947,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: - - *121 - - *219 + - *124 + - *222 responses: '200': description: Response content: application/json: - schema: *294 + schema: *297 examples: - default: *295 + default: *298 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -41294,8 +41978,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: - - *121 - - *219 + - *124 + - *222 requestBody: required: true content: @@ -41338,7 +42022,7 @@ paths: description: Response content: application/json: - schema: *294 + schema: *297 examples: default: value: @@ -41370,8 +42054,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *121 - - *219 + - *124 + - *222 - *18 - *20 responses: @@ -41381,9 +42065,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - response-if-child-teams-exist: &623 + response-if-child-teams-exist: &626 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -41436,7 +42120,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: - - *121 + - *124 - name: security_product in: path description: The security feature to enable or disable. @@ -41507,7 +42191,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#get-a-project-card parameters: - - &296 + - &299 name: card_id description: The unique identifier of the card. in: path @@ -41519,7 +42203,7 @@ paths: description: Response content: application/json: - schema: &297 + schema: &300 title: Project Card description: Project cards represent a scope of work. type: object @@ -41586,7 +42270,7 @@ paths: - created_at - updated_at examples: - default: &298 + default: &301 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -41636,7 +42320,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#update-an-existing-project-card parameters: - - *296 + - *299 requestBody: required: false content: @@ -41663,9 +42347,9 @@ paths: description: Response content: application/json: - schema: *297 + schema: *300 examples: - default: *298 + default: *301 '304': *37 '403': *29 '401': *25 @@ -41686,7 +42370,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#delete-a-project-card parameters: - - *296 + - *299 responses: '204': description: Response @@ -41724,7 +42408,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#move-a-project-card parameters: - - *296 + - *299 requestBody: required: true content: @@ -41829,7 +42513,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#get-a-project-column parameters: - - &299 + - &302 name: column_id description: The unique identifier of the column. in: path @@ -41841,7 +42525,7 @@ paths: description: Response content: application/json: - schema: &300 + schema: &303 title: Project Column description: Project columns contain cards of work. type: object @@ -41887,7 +42571,7 @@ paths: - created_at - updated_at examples: - default: &301 + default: &304 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -41916,7 +42600,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#update-an-existing-project-column parameters: - - *299 + - *302 requestBody: required: true content: @@ -41940,9 +42624,9 @@ paths: description: Response content: application/json: - schema: *300 + schema: *303 examples: - default: *301 + default: *304 '304': *37 '403': *29 '401': *25 @@ -41961,7 +42645,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#delete-a-project-column parameters: - - *299 + - *302 responses: '204': description: Response @@ -41984,7 +42668,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#list-project-cards parameters: - - *299 + - *302 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -42005,7 +42689,7 @@ paths: application/json: schema: type: array - items: *297 + items: *300 examples: default: value: @@ -42058,7 +42742,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#create-a-project-card parameters: - - *299 + - *302 requestBody: required: true content: @@ -42098,9 +42782,9 @@ paths: description: Response content: application/json: - schema: *297 + schema: *300 examples: - default: *298 + default: *301 '304': *37 '403': *29 '401': *25 @@ -42110,8 +42794,8 @@ paths: application/json: schema: oneOf: - - *124 - - *125 + - *127 + - *128 '503': description: Response content: @@ -42150,7 +42834,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#move-a-project-column parameters: - - *299 + - *302 requestBody: required: true content: @@ -42206,15 +42890,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-a-project parameters: - - *291 + - *294 responses: '200': description: Response content: application/json: - schema: *236 + schema: *239 examples: - default: &302 + default: &305 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -42267,7 +42951,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#update-a-project parameters: - - *291 + - *294 requestBody: required: false content: @@ -42313,9 +42997,9 @@ paths: description: Response content: application/json: - schema: *236 + schema: *239 examples: - default: *302 + default: *305 '404': description: Not Found if the authenticated user does not have access to the project @@ -42336,7 +43020,7 @@ paths: items: type: string '401': *25 - '410': *303 + '410': *306 '422': *8 x-github: githubCloudOnly: false @@ -42354,7 +43038,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#delete-a-project parameters: - - *291 + - *294 responses: '204': description: Delete Success @@ -42375,7 +43059,7 @@ paths: items: type: string '401': *25 - '410': *303 + '410': *306 '404': *7 x-github: githubCloudOnly: false @@ -42398,7 +43082,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#list-project-collaborators parameters: - - *291 + - *294 - 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 @@ -42425,7 +43109,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 '404': *7 @@ -42450,8 +43134,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#add-project-collaborator parameters: - - *291 - - *161 + - *294 + - *164 requestBody: required: false content: @@ -42498,8 +43182,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#remove-user-as-a-collaborator parameters: - - *291 - - *161 + - *294 + - *164 responses: '204': description: Response @@ -42527,8 +43211,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#get-project-permission-for-a-user parameters: - - *291 - - *161 + - *294 + - *164 responses: '200': description: Response @@ -42595,7 +43279,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#list-project-columns parameters: - - *291 + - *294 - *18 - *20 responses: @@ -42605,7 +43289,7 @@ paths: application/json: schema: type: array - items: *300 + items: *303 examples: default: value: @@ -42637,7 +43321,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#create-a-project-column parameters: - - *291 + - *294 requestBody: required: true content: @@ -42660,7 +43344,7 @@ paths: description: Response content: application/json: - schema: *300 + schema: *303 examples: default: value: @@ -42721,7 +43405,7 @@ paths: resources: type: object properties: - core: &304 + core: &307 title: Rate Limit type: object properties: @@ -42738,19 +43422,19 @@ paths: - remaining - reset - used - graphql: *304 - search: *304 - code_search: *304 - source_import: *304 - integration_manifest: *304 - code_scanning_upload: *304 - actions_runner_registration: *304 - scim: *304 - dependency_snapshots: *304 + graphql: *307 + search: *307 + code_search: *307 + source_import: *307 + integration_manifest: *307 + code_scanning_upload: *307 + actions_runner_registration: *307 + scim: *307 + dependency_snapshots: *307 required: - core - search - rate: *304 + rate: *307 required: - rate - resources @@ -42849,14 +43533,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: *305 + schema: *308 examples: default-response: summary: Default response @@ -43361,7 +44045,7 @@ paths: status: disabled '403': *29 '404': *7 - '301': *306 + '301': *309 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43379,8 +44063,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: false content: @@ -43626,10 +44310,10 @@ paths: description: Response content: application/json: - schema: *305 + schema: *308 examples: - default: *307 - '307': &308 + default: *310 + '307': &311 description: Temporary Redirect content: application/json: @@ -43658,8 +44342,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -43681,7 +44365,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': *308 + '307': *311 '404': *7 x-github: githubCloudOnly: false @@ -43704,11 +44388,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 - - &323 + - &326 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -43731,7 +44415,7 @@ paths: type: integer artifacts: type: array - items: &309 + items: &312 title: Artifact description: An artifact type: object @@ -43802,7 +44486,7 @@ paths: - expires_at - updated_at examples: - default: &324 + default: &327 value: total_count: 2 artifacts: @@ -43861,9 +44545,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *292 - - *293 - - &310 + - *295 + - *296 + - &313 name: artifact_id description: The unique identifier of the artifact. in: path @@ -43875,7 +44559,7 @@ paths: description: Response content: application/json: - schema: *309 + schema: *312 examples: default: value: @@ -43912,9 +44596,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *292 - - *293 - - *310 + - *295 + - *296 + - *313 responses: '204': description: Response @@ -43938,9 +44622,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *292 - - *293 - - *310 + - *295 + - *296 + - *313 - name: archive_format in: path required: true @@ -43954,7 +44638,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': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43977,14 +44661,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: *311 + schema: *314 examples: default: value: @@ -44010,11 +44694,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: - - *292 - - *293 + - *295 + - *296 - *18 - *20 - - &312 + - &315 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 @@ -44048,7 +44732,7 @@ paths: description: Response content: application/json: - schema: &313 + schema: &316 title: Repository actions caches description: Repository actions caches type: object @@ -44090,7 +44774,7 @@ paths: - total_count - actions_caches examples: - default: &314 + default: &317 value: total_count: 1 actions_caches: @@ -44122,23 +44806,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: - - *292 - - *293 + - *295 + - *296 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *312 + - *315 responses: '200': description: Response content: application/json: - schema: *313 + schema: *316 examples: - default: *314 + default: *317 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44158,8 +44842,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: - - *292 - - *293 + - *295 + - *296 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -44190,9 +44874,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: - - *292 - - *293 - - &315 + - *295 + - *296 + - &318 name: job_id description: The unique identifier of the job. in: path @@ -44204,7 +44888,7 @@ paths: description: Response content: application/json: - schema: &327 + schema: &330 title: Job description: Information of a job execution in a workflow run type: object @@ -44511,9 +45195,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: - - *292 - - *293 - - *315 + - *295 + - *296 + - *318 responses: '302': description: Response @@ -44541,9 +45225,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: - - *292 - - *293 - - *315 + - *295 + - *296 + - *318 requestBody: required: false content: @@ -44564,7 +45248,7 @@ paths: description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -44588,8 +45272,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Status response @@ -44639,8 +45323,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -44674,7 +45358,7 @@ paths: description: Empty response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -44703,8 +45387,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -44722,7 +45406,7 @@ paths: type: integer secrets: type: array - items: &329 + items: &332 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -44742,7 +45426,7 @@ paths: - created_at - updated_at examples: - default: &330 + default: &333 value: total_count: 2 secrets: @@ -44775,9 +45459,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *292 - - *293 - - *316 + - *295 + - *296 + - *319 - *20 responses: '200': @@ -44794,7 +45478,7 @@ paths: type: integer variables: type: array - items: &333 + items: &336 title: Actions Variable type: object properties: @@ -44824,7 +45508,7 @@ paths: - created_at - updated_at examples: - default: &334 + default: &337 value: total_count: 2 variables: @@ -44857,8 +45541,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -44867,11 +45551,11 @@ paths: schema: type: object properties: - enabled: &317 + enabled: &320 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *42 - selected_actions_url: *132 + selected_actions_url: *135 required: - enabled examples: @@ -44900,8 +45584,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: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -44912,7 +45596,7 @@ paths: schema: type: object properties: - enabled: *317 + enabled: *320 allowed_actions: *42 required: - enabled @@ -44943,14 +45627,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: &318 + schema: &321 type: object properties: access_level: @@ -44968,7 +45652,7 @@ paths: required: - access_level examples: - default: &319 + default: &322 value: access_level: organization x-github: @@ -44993,15 +45677,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: application/json: - schema: *318 + schema: *321 examples: - default: *319 + default: *322 responses: '204': description: Response @@ -45025,8 +45709,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -45057,8 +45741,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: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -45090,14 +45774,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: *135 + schema: *138 examples: default: *48 x-github: @@ -45120,8 +45804,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: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Success response @@ -45132,7 +45816,7 @@ paths: required: true content: application/json: - schema: *136 + schema: *139 examples: default: *48 x-github: @@ -45161,8 +45845,8 @@ paths: in: query schema: type: string - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -45206,8 +45890,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -45215,9 +45899,9 @@ paths: application/json: schema: type: array - items: *140 + items: *143 examples: - default: *141 + default: *144 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45239,8 +45923,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -45283,7 +45967,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *142 + '201': *145 '404': *7 '422': *8 x-github: @@ -45313,8 +45997,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: - - *292 - - *293 + - *295 + - *296 responses: '201': description: Response @@ -45322,7 +46006,7 @@ paths: application/json: schema: *58 examples: - default: *143 + default: *146 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45350,8 +46034,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: - - *292 - - *293 + - *295 + - *296 responses: '201': description: Response @@ -45359,7 +46043,7 @@ paths: application/json: schema: *58 examples: - default: *144 + default: *147 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45381,8 +46065,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: - - *292 - - *293 + - *295 + - *296 - *54 responses: '200': @@ -45391,7 +46075,7 @@ paths: application/json: schema: *55 examples: - default: *145 + default: *148 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45412,8 +46096,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: - - *292 - - *293 + - *295 + - *296 - *54 responses: '204': @@ -45439,8 +46123,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: - - *292 - - *293 + - *295 + - *296 - *54 responses: '200': *60 @@ -45465,8 +46149,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: - - *292 - - *293 + - *295 + - *296 - *54 requestBody: required: true @@ -45515,8 +46199,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: - - *292 - - *293 + - *295 + - *296 - *54 requestBody: required: true @@ -45566,11 +46250,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: - - *292 - - *293 + - *295 + - *296 - *54 responses: - '200': *146 + '200': *149 '404': *7 x-github: githubCloudOnly: false @@ -45597,10 +46281,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: - - *292 - - *293 + - *295 + - *296 - *54 - - *147 + - *150 responses: '200': *60 '404': *7 @@ -45628,9 +46312,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: - - *292 - - *293 - - &337 + - *295 + - *296 + - &340 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. @@ -45638,7 +46322,7 @@ paths: required: false schema: type: string - - &338 + - &341 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -45646,7 +46330,7 @@ paths: required: false schema: type: string - - &339 + - &342 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -45655,7 +46339,7 @@ paths: required: false schema: type: string - - &340 + - &343 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 @@ -45682,7 +46366,7 @@ paths: - pending - *18 - *20 - - &341 + - &344 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)." @@ -45691,7 +46375,7 @@ paths: schema: type: string format: date-time - - &320 + - &323 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -45700,13 +46384,13 @@ paths: schema: type: boolean default: false - - &342 + - &345 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &343 + - &346 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -45729,7 +46413,7 @@ paths: type: integer workflow_runs: type: array - items: &321 + items: &324 title: Workflow Run description: An invocation of a workflow type: object @@ -45824,7 +46508,7 @@ paths: that triggered the run. type: array nullable: true - items: &362 + items: &365 title: Pull Request Minimal type: object properties: @@ -45943,7 +46627,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &366 + properties: &369 id: type: string description: SHA for the commit @@ -45994,7 +46678,7 @@ paths: - name - email nullable: true - required: &367 + required: &370 - id - tree_id - message @@ -46002,8 +46686,8 @@ paths: - author - committer nullable: true - repository: *139 - head_repository: *139 + repository: *142 + head_repository: *142 head_repository_id: type: integer example: 5 @@ -46041,7 +46725,7 @@ paths: - workflow_url - pull_requests examples: - default: &344 + default: &347 value: total_count: 1 workflow_runs: @@ -46277,24 +46961,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *292 - - *293 - - &322 + - *295 + - *296 + - &325 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *320 + - *323 responses: '200': description: Response content: application/json: - schema: *321 + schema: *324 examples: - default: &325 + default: &328 value: id: 30433642 name: Build @@ -46535,9 +47219,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '204': description: Response @@ -46560,9 +47244,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: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '200': description: Response @@ -46681,15 +47365,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: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '201': description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -46716,12 +47400,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 - *18 - *20 - - *323 + - *326 responses: '200': description: Response @@ -46737,9 +47421,9 @@ paths: type: integer artifacts: type: array - items: *309 + items: *312 examples: - default: *324 + default: *327 headers: Link: *39 x-github: @@ -46763,25 +47447,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *292 - - *293 - - *322 - - &326 + - *295 + - *296 + - *325 + - &329 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *320 + - *323 responses: '200': description: Response content: application/json: - schema: *321 + schema: *324 examples: - default: *325 + default: *328 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46804,10 +47488,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: - - *292 - - *293 - - *322 - - *326 + - *295 + - *296 + - *325 + - *329 - *18 - *20 responses: @@ -46825,9 +47509,9 @@ paths: type: integer jobs: type: array - items: *327 + items: *330 examples: - default: &328 + default: &331 value: total_count: 1 jobs: @@ -46940,10 +47624,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *292 - - *293 - - *322 - - *326 + - *295 + - *296 + - *325 + - *329 responses: '302': description: Response @@ -46971,19 +47655,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '202': description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47006,9 +47690,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: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 requestBody: required: true content: @@ -47075,19 +47759,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '202': description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47110,9 +47794,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: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 - 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 @@ -47142,9 +47826,9 @@ paths: type: integer jobs: type: array - items: *327 + items: *330 examples: - default: *328 + default: *331 headers: Link: *39 x-github: @@ -47169,9 +47853,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '302': description: Response @@ -47198,9 +47882,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '204': description: Response @@ -47227,9 +47911,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: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '200': description: Response @@ -47289,7 +47973,7 @@ paths: items: type: object properties: - type: &440 + type: &443 type: string description: The type of reviewer. enum: @@ -47299,7 +47983,7 @@ paths: reviewer: anyOf: - *19 - - *207 + - *210 required: - environment - wait_timer @@ -47374,9 +48058,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: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 requestBody: required: true content: @@ -47423,7 +48107,7 @@ paths: application/json: schema: type: array - items: &435 + items: &438 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -47511,8 +48195,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 required: - id - node_id @@ -47529,7 +48213,7 @@ paths: - created_at - updated_at examples: - default: &436 + default: &439 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -47585,9 +48269,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 requestBody: required: false content: @@ -47608,7 +48292,7 @@ paths: description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -47631,9 +48315,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: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 requestBody: required: false content: @@ -47654,7 +48338,7 @@ paths: description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -47679,9 +48363,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '200': description: Response @@ -47818,8 +48502,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -47837,9 +48521,9 @@ paths: type: integer secrets: type: array - items: *329 + items: *332 examples: - default: *330 + default: *333 headers: Link: *39 x-github: @@ -47864,16 +48548,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: *331 + schema: *334 examples: - default: *332 + default: *335 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47895,17 +48579,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 responses: '200': description: Response content: application/json: - schema: *329 + schema: *332 examples: - default: &453 + default: &456 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -47931,9 +48615,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 requestBody: required: true content: @@ -47961,7 +48645,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -47987,9 +48671,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 responses: '204': description: Response @@ -48014,9 +48698,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *292 - - *293 - - *316 + - *295 + - *296 + - *319 - *20 responses: '200': @@ -48033,9 +48717,9 @@ paths: type: integer variables: type: array - items: *333 + items: *336 examples: - default: *334 + default: *337 headers: Link: *39 x-github: @@ -48058,8 +48742,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -48086,7 +48770,7 @@ paths: description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -48111,17 +48795,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *292 - - *293 - - *152 + - *295 + - *296 + - *155 responses: '200': description: Response content: application/json: - schema: *333 + schema: *336 examples: - default: &454 + default: &457 value: name: USERNAME value: octocat @@ -48147,9 +48831,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *292 - - *293 - - *152 + - *295 + - *296 + - *155 requestBody: required: true content: @@ -48191,9 +48875,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *292 - - *293 - - *152 + - *295 + - *296 + - *155 responses: '204': description: Response @@ -48218,8 +48902,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -48237,7 +48921,7 @@ paths: type: integer workflows: type: array - items: &335 + items: &338 title: Workflow description: A GitHub Actions workflow type: object @@ -48344,9 +49028,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *292 - - *293 - - &336 + - *295 + - *296 + - &339 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -48361,7 +49045,7 @@ paths: description: Response content: application/json: - schema: *335 + schema: *338 examples: default: value: @@ -48394,9 +49078,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *292 - - *293 - - *336 + - *295 + - *296 + - *339 responses: '204': description: Response @@ -48421,9 +49105,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *292 - - *293 - - *336 + - *295 + - *296 + - *339 responses: '204': description: Response @@ -48474,9 +49158,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *292 - - *293 - - *336 + - *295 + - *296 + - *339 responses: '204': description: Response @@ -48501,19 +49185,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: - - *292 - - *293 - - *336 - - *337 - - *338 + - *295 + - *296 - *339 - *340 - - *18 - - *20 - *341 - - *320 - *342 - *343 + - *18 + - *20 + - *344 + - *323 + - *345 + - *346 responses: '200': description: Response @@ -48529,9 +49213,9 @@ paths: type: integer workflow_runs: type: array - items: *321 + items: *324 examples: - default: *344 + default: *347 headers: Link: *39 x-github: @@ -48557,9 +49241,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *292 - - *293 - - *336 + - *295 + - *296 + - *339 responses: '200': description: Response @@ -48620,8 +49304,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *292 - - *293 + - *295 + - *296 - *67 - *18 - *65 @@ -48785,8 +49469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -48798,7 +49482,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 '404': *7 @@ -48823,8 +49507,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: - - *292 - - *293 + - *295 + - *296 - name: assignee in: path required: true @@ -48860,8 +49544,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -48973,8 +49657,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *65 - *66 @@ -49018,7 +49702,7 @@ paths: repository_id: type: integer examples: - default: *345 + default: *348 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49038,8 +49722,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -49047,7 +49731,7 @@ paths: application/json: schema: type: array - items: &346 + items: &349 title: Autolink reference description: An autolink reference. type: object @@ -49097,8 +49781,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -49137,9 +49821,9 @@ paths: description: response content: application/json: - schema: *346 + schema: *349 examples: - default: &347 + default: &350 value: id: 1 key_prefix: TICKET- @@ -49170,9 +49854,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: - - *292 - - *293 - - &348 + - *295 + - *296 + - &351 name: autolink_id description: The unique identifier of the autolink. in: path @@ -49184,9 +49868,9 @@ paths: description: Response content: application/json: - schema: *346 + schema: *349 examples: - default: *347 + default: *350 '404': *7 x-github: githubCloudOnly: false @@ -49206,9 +49890,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: - - *292 - - *293 - - *348 + - *295 + - *296 + - *351 responses: '204': description: Response @@ -49232,8 +49916,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response if Dependabot is enabled @@ -49281,8 +49965,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-automated-security-fixes parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -49303,8 +49987,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-automated-security-fixes parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -49324,8 +50008,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *292 - - *293 + - *295 + - *296 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -49363,7 +50047,7 @@ paths: - url protected: type: boolean - protection: &350 + protection: &353 title: Branch Protection description: Branch Protection type: object @@ -49405,7 +50089,7 @@ paths: required: - contexts - checks - enforce_admins: &353 + enforce_admins: &356 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -49420,7 +50104,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &355 + required_pull_request_reviews: &358 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -49441,7 +50125,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *207 + items: *210 apps: description: The list of apps with review dismissal access. @@ -49470,7 +50154,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *207 + items: *210 apps: description: The list of apps allowed to bypass pull request requirements. @@ -49496,7 +50180,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &352 + restrictions: &355 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -49803,9 +50487,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *292 - - *293 - - &351 + - *295 + - *296 + - &354 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). @@ -49819,14 +50503,14 @@ paths: description: Response content: application/json: - schema: &361 + schema: &364 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &408 + commit: &411 title: Commit description: Commit type: object @@ -49860,7 +50544,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &349 + properties: &352 name: type: string example: '"Chris Wanstrath"' @@ -49875,7 +50559,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *349 + properties: *352 nullable: true message: type: string @@ -49896,7 +50580,7 @@ paths: required: - sha - url - verification: &460 + verification: &463 title: Verification type: object properties: @@ -49926,12 +50610,12 @@ paths: nullable: true oneOf: - *19 - - *150 + - *153 committer: nullable: true oneOf: - *19 - - *150 + - *153 parents: type: array items: @@ -49962,7 +50646,7 @@ paths: type: integer files: type: array - items: &423 + items: &426 title: Diff Entry description: Diff Entry type: object @@ -50045,7 +50729,7 @@ paths: - self protected: type: boolean - protection: *350 + protection: *353 protection_url: type: string format: uri @@ -50151,7 +50835,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *306 + '301': *309 '404': *7 x-github: githubCloudOnly: false @@ -50173,15 +50857,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response content: application/json: - schema: *350 + schema: *353 examples: default: value: @@ -50375,9 +51059,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: true content: @@ -50632,7 +51316,7 @@ paths: url: type: string format: uri - required_status_checks: &358 + required_status_checks: &361 title: Status Check Policy description: Status Check Policy type: object @@ -50708,7 +51392,7 @@ paths: items: *19 teams: type: array - items: *207 + items: *210 apps: type: array items: *6 @@ -50726,7 +51410,7 @@ paths: items: *19 teams: type: array - items: *207 + items: *210 apps: type: array items: *6 @@ -50784,7 +51468,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *352 + restrictions: *355 required_conversation_resolution: type: object properties: @@ -50896,9 +51580,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '204': description: Response @@ -50923,17 +51607,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response content: application/json: - schema: *353 + schema: *356 examples: - default: &354 + default: &357 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -50955,17 +51639,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response content: application/json: - schema: *353 + schema: *356 examples: - default: *354 + default: *357 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50984,9 +51668,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '204': description: Response @@ -51011,17 +51695,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response content: application/json: - schema: *355 + schema: *358 examples: - default: &356 + default: &359 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -51117,9 +51801,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: false content: @@ -51217,9 +51901,9 @@ paths: description: Response content: application/json: - schema: *355 + schema: *358 examples: - default: *356 + default: *359 '422': *16 x-github: githubCloudOnly: false @@ -51240,9 +51924,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '204': description: Response @@ -51269,17 +51953,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response content: application/json: - schema: *353 + schema: *356 examples: - default: &357 + default: &360 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -51302,17 +51986,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response content: application/json: - schema: *353 + schema: *356 examples: - default: *357 + default: *360 '404': *7 x-github: githubCloudOnly: false @@ -51332,9 +52016,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '204': description: Response @@ -51359,17 +52043,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response content: application/json: - schema: *358 + schema: *361 examples: - default: &359 + default: &362 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -51395,9 +52079,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: false content: @@ -51449,9 +52133,9 @@ paths: description: Response content: application/json: - schema: *358 + schema: *361 examples: - default: *359 + default: *362 '404': *7 '422': *16 x-github: @@ -51473,9 +52157,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '204': description: Response @@ -51499,9 +52183,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response @@ -51535,9 +52219,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: false content: @@ -51604,9 +52288,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: false content: @@ -51670,9 +52354,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: content: application/json: @@ -51738,15 +52422,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response content: application/json: - schema: *352 + schema: *355 examples: default: value: @@ -51837,9 +52521,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '204': description: Response @@ -51862,9 +52546,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: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response @@ -51874,7 +52558,7 @@ paths: type: array items: *6 examples: - default: &360 + default: &363 value: - id: 1 slug: octoapp @@ -51931,9 +52615,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: true content: @@ -51967,7 +52651,7 @@ paths: type: array items: *6 examples: - default: *360 + default: *363 '422': *16 x-github: githubCloudOnly: false @@ -51988,9 +52672,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: true content: @@ -52024,7 +52708,7 @@ paths: type: array items: *6 examples: - default: *360 + default: *363 '422': *16 x-github: githubCloudOnly: false @@ -52045,9 +52729,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: true content: @@ -52081,7 +52765,7 @@ paths: type: array items: *6 examples: - default: *360 + default: *363 '422': *16 x-github: githubCloudOnly: false @@ -52103,9 +52787,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: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response @@ -52113,9 +52797,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - default: *222 + default: *225 '404': *7 x-github: githubCloudOnly: false @@ -52135,9 +52819,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: false content: @@ -52173,9 +52857,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - default: *222 + default: *225 '422': *16 x-github: githubCloudOnly: false @@ -52196,9 +52880,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: false content: @@ -52234,9 +52918,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - default: *222 + default: *225 '422': *16 x-github: githubCloudOnly: false @@ -52257,9 +52941,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: content: application/json: @@ -52294,9 +52978,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - default: *222 + default: *225 '422': *16 x-github: githubCloudOnly: false @@ -52318,9 +53002,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: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response @@ -52330,7 +53014,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 '404': *7 x-github: githubCloudOnly: false @@ -52354,9 +53038,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: true content: @@ -52389,7 +53073,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 '422': *16 x-github: githubCloudOnly: false @@ -52414,9 +53098,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: true content: @@ -52449,7 +53133,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 '422': *16 x-github: githubCloudOnly: false @@ -52474,9 +53158,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: true content: @@ -52509,7 +53193,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 '422': *16 x-github: githubCloudOnly: false @@ -52536,9 +53220,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: true content: @@ -52560,7 +53244,7 @@ paths: description: Response content: application/json: - schema: *361 + schema: *364 examples: default: value: @@ -52675,8 +53359,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -52955,7 +53639,7 @@ paths: description: Response content: application/json: - schema: &363 + schema: &366 title: CheckRun description: A check performed on the code of a given code change type: object @@ -53066,16 +53750,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *362 - deployment: &674 + items: *365 + deployment: &677 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -53142,8 +53826,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 required: - id - node_id @@ -53355,9 +54039,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *292 - - *293 - - &364 + - *295 + - *296 + - &367 name: check_run_id description: The unique identifier of the check run. in: path @@ -53369,9 +54053,9 @@ paths: description: Response content: application/json: - schema: *363 + schema: *366 examples: - default: &365 + default: &368 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -53471,9 +54155,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *292 - - *293 - - *364 + - *295 + - *296 + - *367 requestBody: required: true content: @@ -53713,9 +54397,9 @@ paths: description: Response content: application/json: - schema: *363 + schema: *366 examples: - default: *365 + default: *368 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53735,9 +54419,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *292 - - *293 - - *364 + - *295 + - *296 + - *367 - *18 - *20 responses: @@ -53834,15 +54518,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *292 - - *293 - - *364 + - *295 + - *296 + - *367 responses: '201': description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -53880,8 +54564,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -53903,7 +54587,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &368 + schema: &371 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -53966,7 +54650,7 @@ paths: nullable: true pull_requests: type: array - items: *362 + items: *365 nullable: true app: title: GitHub app @@ -53977,9 +54661,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 - repository: *139 + properties: *92 + required: *93 + repository: *142 created_at: type: string format: date-time @@ -53988,12 +54672,12 @@ paths: type: string format: date-time nullable: true - head_commit: &700 + head_commit: &703 title: Simple Commit description: A commit. type: object - properties: *366 - required: *367 + properties: *369 + required: *370 latest_check_runs_count: type: integer check_runs_url: @@ -54021,7 +54705,7 @@ paths: - check_runs_url - pull_requests examples: - default: &369 + default: &372 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -54312,9 +54996,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *368 + schema: *371 examples: - default: *369 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54333,8 +55017,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -54395,7 +55079,7 @@ paths: required: - app_id - setting - repository: *139 + repository: *142 examples: default: value: @@ -54643,9 +55327,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *292 - - *293 - - &370 + - *295 + - *296 + - &373 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -54657,9 +55341,9 @@ paths: description: Response content: application/json: - schema: *368 + schema: *371 examples: - default: *369 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54682,17 +55366,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: - - *292 - - *293 - - *370 - - &416 + - *295 + - *296 + - *373 + - &419 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &417 + - &420 name: status description: Returns check runs with the specified `status`. in: query @@ -54731,9 +55415,9 @@ paths: type: integer check_runs: type: array - items: *363 + items: *366 examples: - default: &418 + default: &421 value: total_count: 1 check_runs: @@ -54835,15 +55519,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *292 - - *293 - - *370 + - *295 + - *296 + - *373 responses: '201': description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -54870,21 +55554,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: - - *292 - - *293 - - *162 - - *163 + - *295 + - *296 + - *165 + - *166 - *20 - *18 - - &382 + - &385 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: *371 - - &383 + schema: *374 + - &386 name: pr description: The number of the pull request for the results you want to list. in: query @@ -54909,13 +55593,13 @@ paths: be returned. in: query required: false - schema: *164 + schema: *167 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *372 + schema: *375 responses: '200': description: Response @@ -54931,7 +55615,7 @@ paths: updated_at: *81 url: *78 html_url: *79 - instances_url: *373 + instances_url: *376 state: *70 fixed_at: *83 dismissed_by: @@ -54942,11 +55626,11 @@ paths: required: *5 nullable: true dismissed_at: *82 - dismissed_reason: *374 - dismissed_comment: *375 - rule: *376 - tool: *377 - most_recent_instance: *378 + dismissed_reason: *377 + dismissed_comment: *378 + rule: *379 + tool: *380 + most_recent_instance: *381 required: - number - created_at @@ -55062,7 +55746,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &379 + '403': &382 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -55089,9 +55773,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: - - *292 - - *293 - - &380 + - *295 + - *296 + - &383 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -55105,7 +55789,7 @@ paths: description: Response content: application/json: - schema: &381 + schema: &384 type: object properties: number: *74 @@ -55113,7 +55797,7 @@ paths: updated_at: *81 url: *78 html_url: *79 - instances_url: *373 + instances_url: *376 state: *70 fixed_at: *83 dismissed_by: @@ -55124,8 +55808,8 @@ paths: required: *5 nullable: true dismissed_at: *82 - dismissed_reason: *374 - dismissed_comment: *375 + dismissed_reason: *377 + dismissed_comment: *378 rule: type: object properties: @@ -55179,8 +55863,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *377 - most_recent_instance: *378 + tool: *380 + most_recent_instance: *381 required: - number - created_at @@ -55269,7 +55953,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *379 + '403': *382 '404': *7 '503': *85 x-github: @@ -55289,9 +55973,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: - - *292 - - *293 - - *380 + - *295 + - *296 + - *383 requestBody: required: true content: @@ -55306,8 +55990,8 @@ paths: enum: - open - dismissed - dismissed_reason: *374 - dismissed_comment: *375 + dismissed_reason: *377 + dismissed_comment: *378 required: - state examples: @@ -55322,7 +56006,7 @@ paths: description: Response content: application/json: - schema: *381 + schema: *384 examples: default: value: @@ -55397,7 +56081,7 @@ paths: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '403': &388 + '403': &391 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -55424,13 +56108,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: - - *292 - - *293 - - *380 + - *295 + - *296 + - *383 - *20 - *18 - - *382 - - *383 + - *385 + - *386 responses: '200': description: Response @@ -55438,7 +56122,7 @@ paths: application/json: schema: type: array - items: *378 + items: *381 examples: default: value: @@ -55477,7 +56161,7 @@ paths: end_column: 50 classifications: - source - '403': *379 + '403': *382 '404': *7 '503': *85 x-github: @@ -55511,25 +56195,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: - - *292 - - *293 - - *162 - - *163 + - *295 + - *296 + - *165 + - *166 - *20 - *18 - - *383 + - *386 - 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: *371 + schema: *374 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &386 + schema: &389 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -55550,23 +56234,23 @@ paths: application/json: schema: type: array - items: &387 + items: &390 type: object properties: - ref: *371 - commit_sha: &396 + ref: *374 + commit_sha: &399 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: *384 + analysis_key: *387 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *385 + category: *388 error: type: string example: error reading field xyz @@ -55590,8 +56274,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *386 - tool: *377 + sarif_id: *389 + tool: *380 deletable: type: boolean warning: @@ -55652,7 +56336,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *379 + '403': *382 '404': *7 '503': *85 x-github: @@ -55688,8 +56372,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: - - *292 - - *293 + - *295 + - *296 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -55702,7 +56386,7 @@ paths: description: Response content: application/json: - schema: *387 + schema: *390 examples: response: summary: application/json response @@ -55756,7 +56440,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *379 + '403': *382 '404': *7 '503': *85 x-github: @@ -55838,8 +56522,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: - - *292 - - *293 + - *295 + - *296 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -55892,7 +56576,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': *15 - '403': *388 + '403': *391 '404': *7 '503': *85 x-github: @@ -55914,8 +56598,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -55923,7 +56607,7 @@ paths: application/json: schema: type: array - items: &389 + items: &392 title: CodeQL Database description: A CodeQL database. type: object @@ -56034,7 +56718,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': *379 + '403': *382 '404': *7 '503': *85 x-github: @@ -56063,8 +56747,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: - - *292 - - *293 + - *295 + - *296 - name: language in: path description: The language of the CodeQL database. @@ -56076,7 +56760,7 @@ paths: description: Response content: application/json: - schema: *389 + schema: *392 examples: default: value: @@ -56108,9 +56792,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': &425 + '302': &428 description: Found - '403': *379 + '403': *382 '404': *7 '503': *85 x-github: @@ -56138,8 +56822,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -56148,7 +56832,7 @@ paths: type: object additionalProperties: false properties: - language: &390 + language: &393 type: string description: The language targeted by the CodeQL query enum: @@ -56226,7 +56910,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &394 + schema: &397 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -56236,7 +56920,7 @@ paths: description: The ID of the variant analysis. controller_repo: *84 actor: *19 - query_language: *390 + query_language: *393 query_pack_url: type: string description: The download url for the query pack. @@ -56283,7 +56967,7 @@ paths: items: type: object properties: - repository: &391 + repository: &394 title: Repository Identifier description: Repository Identifier type: object @@ -56319,7 +57003,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &395 + analysis_status: &398 type: string description: The new status of the CodeQL variant analysis repository task. @@ -56351,7 +57035,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &392 + access_mismatch_repos: &395 type: object properties: repository_count: @@ -56365,7 +57049,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: *391 + items: *394 required: - repository_count - repositories @@ -56387,8 +57071,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *392 - over_limit_repos: *392 + no_codeql_db_repos: *395 + over_limit_repos: *395 required: - access_mismatch_repos - not_found_repos @@ -56404,7 +57088,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &393 + value: &396 summary: Default response value: id: 1 @@ -56556,10 +57240,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *393 + value: *396 repository_lists: summary: Response for a successful variant analysis submission - value: *393 + value: *396 '404': *7 '422': description: Unable to process variant analysis submission @@ -56587,8 +57271,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: - - *292 - - *293 + - *295 + - *296 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -56600,9 +57284,9 @@ paths: description: Response content: application/json: - schema: *394 + schema: *397 examples: - default: *393 + default: *396 '404': *7 '503': *85 x-github: @@ -56625,7 +57309,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: - - *292 + - *295 - name: repo in: path description: The name of the controller repository. @@ -56660,7 +57344,7 @@ paths: type: object properties: repository: *84 - analysis_status: *395 + analysis_status: *398 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -56785,8 +57469,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -56847,7 +57531,7 @@ paths: query_suite: default updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *379 + '403': *382 '404': *7 '503': *85 x-github: @@ -56868,8 +57552,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -56914,7 +57598,7 @@ paths: description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -56939,7 +57623,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *388 + '403': *391 '404': *7 '409': description: Response if there is already a validation run in progress with @@ -57004,8 +57688,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -57013,7 +57697,7 @@ paths: schema: type: object properties: - commit_sha: *396 + commit_sha: *399 ref: type: string description: |- @@ -57071,7 +57755,7 @@ paths: schema: type: object properties: - id: *386 + id: *389 url: type: string description: The REST API URL for checking the status of the upload. @@ -57085,7 +57769,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': *388 + '403': *391 '404': *7 '413': description: Payload Too Large if the sarif field is too large @@ -57108,8 +57792,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: - - *292 - - *293 + - *295 + - *296 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -57155,7 +57839,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': *379 + '403': *382 '404': description: Not Found if the sarif id does not match any upload '503': *85 @@ -57180,8 +57864,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -57205,7 +57889,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *167 + configuration: *170 examples: default: value: @@ -57234,7 +57918,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': *170 + '204': *173 '304': *37 '403': *29 '404': *7 @@ -57259,8 +57943,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *292 - - *293 + - *295 + - *296 - 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 @@ -57380,8 +58064,8 @@ paths: parameters: - *18 - *20 - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -57397,7 +58081,7 @@ paths: type: integer codespaces: type: array - items: *211 + items: *214 examples: default: value: @@ -57695,8 +58379,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -57759,17 +58443,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '400': *15 '401': *25 '403': *29 @@ -57798,8 +58482,8 @@ paths: parameters: - *18 - *20 - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -57863,8 +58547,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: - - *292 - - *293 + - *295 + - *296 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -57899,14 +58583,14 @@ paths: type: integer machines: type: array - items: &630 + items: &633 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *398 - required: *399 + properties: *401 + required: *402 examples: - default: &631 + default: &634 value: total_count: 2 machines: @@ -57946,8 +58630,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *292 - - *293 + - *295 + - *296 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -58031,8 +58715,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: - - *292 - - *293 + - *295 + - *296 - 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 @@ -58098,8 +58782,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -58117,7 +58801,7 @@ paths: type: integer secrets: type: array - items: &403 + items: &406 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -58137,7 +58821,7 @@ paths: - created_at - updated_at examples: - default: *400 + default: *403 headers: Link: *39 x-github: @@ -58160,16 +58844,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: *401 + schema: *404 examples: - default: *402 + default: *405 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58189,17 +58873,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 responses: '200': description: Response content: application/json: - schema: *403 + schema: *406 examples: - default: *404 + default: *407 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58219,9 +58903,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: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 requestBody: required: true content: @@ -58249,7 +58933,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -58273,9 +58957,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 responses: '204': description: Response @@ -58303,8 +58987,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *292 - - *293 + - *295 + - *296 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -58346,7 +59030,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &405 + properties: &408 login: type: string example: octocat @@ -58439,7 +59123,7 @@ paths: user_view_type: type: string example: public - required: &406 + required: &409 - avatar_url - events_url - followers_url @@ -58513,9 +59197,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: - - *292 - - *293 - - *161 + - *295 + - *296 + - *164 responses: '204': description: Response if user is a collaborator @@ -58557,9 +59241,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *292 - - *293 - - *161 + - *295 + - *296 + - *164 requestBody: required: false content: @@ -58585,7 +59269,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &473 + schema: &476 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -58596,7 +59280,7 @@ paths: example: 42 type: integer format: int64 - repository: *139 + repository: *142 invitee: title: Simple User description: A GitHub user. @@ -58807,9 +59491,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *292 - - *293 - - *161 + - *295 + - *296 + - *164 responses: '204': description: No Content when collaborator was removed from the repository. @@ -58838,9 +59522,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *292 - - *293 - - *161 + - *295 + - *296 + - *164 responses: '200': description: if user has admin permissions @@ -58860,8 +59544,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *405 - required: *406 + properties: *408 + required: *409 nullable: true required: - permission @@ -58916,8 +59600,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -58927,7 +59611,7 @@ paths: application/json: schema: type: array - items: &407 + items: &410 title: Commit Comment description: Commit Comment type: object @@ -58968,8 +59652,8 @@ paths: updated_at: type: string format: date-time - author_association: *91 - reactions: *92 + author_association: *94 + reactions: *95 required: - url - html_url @@ -58985,7 +59669,7 @@ paths: - created_at - updated_at examples: - default: &410 + default: &413 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -59044,17 +59728,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 responses: '200': description: Response content: application/json: - schema: *407 + schema: *410 examples: - default: &411 + default: &414 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -59111,9 +59795,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 requestBody: required: true content: @@ -59135,7 +59819,7 @@ paths: description: Response content: application/json: - schema: *407 + schema: *410 examples: default: value: @@ -59186,9 +59870,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 responses: '204': description: Response @@ -59209,9 +59893,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 - 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. @@ -59237,9 +59921,9 @@ paths: application/json: schema: type: array - items: *281 + items: *284 examples: - default: *283 + default: *286 headers: Link: *39 '404': *7 @@ -59260,9 +59944,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 requestBody: required: true content: @@ -59294,16 +59978,16 @@ paths: description: Reaction exists content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '201': description: Reaction created content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '422': *16 x-github: githubCloudOnly: false @@ -59325,10 +60009,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *292 - - *293 - - *103 - - *284 + - *295 + - *296 + - *106 + - *287 responses: '204': description: Response @@ -59376,8 +60060,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *292 - - *293 + - *295 + - *296 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -59433,9 +60117,9 @@ paths: application/json: schema: type: array - items: *408 + items: *411 examples: - default: &524 + default: &527 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -59508,7 +60192,7 @@ paths: '500': *73 '400': *15 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59528,9 +60212,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *292 - - *293 - - &409 + - *295 + - *296 + - &412 name: commit_sha description: The SHA of the commit. in: path @@ -59577,7 +60261,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *16 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59602,9 +60286,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *292 - - *293 - - *409 + - *295 + - *296 + - *412 - *18 - *20 responses: @@ -59614,9 +60298,9 @@ paths: application/json: schema: type: array - items: *407 + items: *410 examples: - default: *410 + default: *413 headers: Link: *39 x-github: @@ -59644,9 +60328,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *292 - - *293 - - *409 + - *295 + - *296 + - *412 requestBody: required: true content: @@ -59681,9 +60365,9 @@ paths: description: Response content: application/json: - schema: *407 + schema: *410 examples: - default: *411 + default: *414 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -59711,9 +60395,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: - - *292 - - *293 - - *409 + - *295 + - *296 + - *412 - *18 - *20 responses: @@ -59723,7 +60407,7 @@ paths: application/json: schema: type: array - items: &514 + items: &517 title: Pull Request Simple description: Pull Request Simple type: object @@ -59829,8 +60513,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *412 - required: *413 + properties: *415 + required: *416 nullable: true active_lock_reason: type: string @@ -59875,7 +60559,7 @@ paths: nullable: true requested_teams: type: array - items: *207 + items: *210 nullable: true head: type: object @@ -59926,7 +60610,7 @@ paths: _links: type: object properties: - comments: &414 + comments: &417 title: Link description: Hypermedia Link type: object @@ -59935,13 +60619,13 @@ paths: type: string required: - href - commits: *414 - statuses: *414 - html: *414 - issue: *414 - review_comments: *414 - review_comment: *414 - self: *414 + commits: *417 + statuses: *417 + html: *417 + issue: *417 + review_comments: *417 + review_comment: *417 + self: *417 required: - comments - commits @@ -59951,8 +60635,8 @@ paths: - review_comments - review_comment - self - author_association: *91 - auto_merge: &517 + author_association: *94 + auto_merge: &520 title: Auto merge description: The status of auto merging a pull request. type: object @@ -60015,7 +60699,7 @@ paths: - author_association - auto_merge examples: - default: &515 + default: &518 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -60495,7 +61179,7 @@ paths: draft: false headers: Link: *39 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60551,11 +61235,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *292 - - *293 + - *295 + - *296 - *20 - *18 - - &415 + - &418 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)" @@ -60570,9 +61254,9 @@ paths: description: Response content: application/json: - schema: *408 + schema: *411 examples: - default: &501 + default: &504 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -60659,7 +61343,7 @@ paths: '404': *7 '500': *73 '503': *85 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60684,11 +61368,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: - - *292 - - *293 - - *415 - - *416 - - *417 + - *295 + - *296 + - *418 + - *419 + - *420 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -60722,9 +61406,9 @@ paths: type: integer check_runs: type: array - items: *363 + items: *366 examples: - default: *418 + default: *421 headers: Link: *39 x-github: @@ -60749,9 +61433,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: - - *292 - - *293 - - *415 + - *295 + - *296 + - *418 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -60759,7 +61443,7 @@ paths: schema: type: integer example: 1 - - *416 + - *419 - *18 - *20 responses: @@ -60777,7 +61461,7 @@ paths: type: integer check_suites: type: array - items: *368 + items: *371 examples: default: value: @@ -60977,9 +61661,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: - - *292 - - *293 - - *415 + - *295 + - *296 + - *418 - *18 - *20 responses: @@ -61046,7 +61730,7 @@ paths: type: string total_count: type: integer - repository: *139 + repository: *142 commit_url: type: string format: uri @@ -61177,9 +61861,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *292 - - *293 - - *415 + - *295 + - *296 + - *418 - *18 - *20 responses: @@ -61189,7 +61873,7 @@ paths: application/json: schema: type: array - items: &578 + items: &581 title: Status description: The status of a commit. type: object @@ -61270,7 +61954,7 @@ paths: site_admin: false headers: Link: *39 - '301': *306 + '301': *309 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61298,8 +61982,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -61328,20 +62012,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *419 - required: *420 + properties: *422 + required: *423 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &421 + properties: &424 url: type: string format: uri html_url: type: string format: uri - required: &422 + required: &425 - url - html_url nullable: true @@ -61349,32 +62033,32 @@ paths: title: License Simple description: License Simple type: object - properties: *105 - required: *106 + properties: *108 + required: *109 nullable: true contributing: title: Community Health File type: object - properties: *421 - required: *422 + properties: *424 + required: *425 nullable: true readme: title: Community Health File type: object - properties: *421 - required: *422 + properties: *424 + required: *425 nullable: true issue_template: title: Community Health File type: object - properties: *421 - required: *422 + properties: *424 + required: *425 nullable: true pull_request_template: title: Community Health File type: object - properties: *421 - required: *422 + properties: *424 + required: *425 nullable: true required: - code_of_conduct @@ -61500,8 +62184,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *292 - - *293 + - *295 + - *296 - *20 - *18 - name: basehead @@ -61544,8 +62228,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *408 - merge_base_commit: *408 + base_commit: *411 + merge_base_commit: *411 status: type: string enum: @@ -61565,10 +62249,10 @@ paths: example: 6 commits: type: array - items: *408 + items: *411 files: type: array - items: *423 + items: *426 required: - url - html_url @@ -61851,8 +62535,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *292 - - *293 + - *295 + - *296 - name: path description: path parameter in: path @@ -61993,7 +62677,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &424 + response-if-content-is-a-file: &427 summary: Response if content is a file value: type: file @@ -62125,7 +62809,7 @@ paths: - size - type - url - - &529 + - &532 title: Content File description: Content File type: object @@ -62326,7 +63010,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *424 + response-if-content-is-a-file: *427 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -62395,7 +63079,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *7 '403': *29 - '302': *425 + '302': *428 '304': *37 x-github: githubCloudOnly: false @@ -62418,8 +63102,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *292 - - *293 + - *295 + - *296 - name: path description: path parameter in: path @@ -62512,7 +63196,7 @@ paths: description: Response content: application/json: - schema: &426 + schema: &429 title: File Commit description: File Commit type: object @@ -62660,7 +63344,7 @@ paths: description: Response content: application/json: - schema: *426 + schema: *429 examples: example-for-creating-a-file: value: @@ -62713,7 +63397,7 @@ paths: schema: oneOf: - *3 - - &455 + - &458 description: Repository rule violation was detected type: object properties: @@ -62734,7 +63418,7 @@ paths: items: type: object properties: - placeholder_id: &571 + placeholder_id: &574 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -62766,8 +63450,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *292 - - *293 + - *295 + - *296 - name: path description: path parameter in: path @@ -62828,7 +63512,7 @@ paths: description: Response content: application/json: - schema: *426 + schema: *429 examples: default: value: @@ -62861,7 +63545,7 @@ paths: payload: '422': *16 '404': *7 - '409': *126 + '409': *129 '503': *85 x-github: githubCloudOnly: false @@ -62882,8 +63566,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *292 - - *293 + - *295 + - *296 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -63006,20 +63690,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *292 - - *293 - - *180 - - *181 - - *182 + - *295 + - *296 - *183 + - *184 + - *185 + - *186 - 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 - - *184 - - *185 + - *187 + - *188 - *67 - name: page description: "**Closing down notice**. Page number of the results to fetch. @@ -63039,8 +63723,8 @@ paths: default: 30 - *65 - *66 - - *186 - - *187 + - *189 + - *190 responses: '200': description: Response @@ -63048,7 +63732,7 @@ paths: application/json: schema: type: array - items: &429 + items: &432 type: object description: A Dependabot alert. properties: @@ -63081,7 +63765,7 @@ paths: enum: - development - runtime - security_advisory: *427 + security_advisory: *430 security_vulnerability: *77 url: *78 html_url: *79 @@ -63112,7 +63796,7 @@ paths: nullable: true maxLength: 280 fixed_at: *83 - auto_dismissed_at: *428 + auto_dismissed_at: *431 required: - number - state @@ -63339,9 +64023,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *292 - - *293 - - &430 + - *295 + - *296 + - &433 name: alert_number in: path description: |- @@ -63356,7 +64040,7 @@ paths: description: Response content: application/json: - schema: *429 + schema: *432 examples: default: value: @@ -63466,9 +64150,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *292 - - *293 - - *430 + - *295 + - *296 + - *433 requestBody: required: true content: @@ -63513,7 +64197,7 @@ paths: description: Response content: application/json: - schema: *429 + schema: *432 examples: default: value: @@ -63619,7 +64303,7 @@ paths: '400': *15 '403': *29 '404': *7 - '409': *126 + '409': *129 '422': *8 x-github: githubCloudOnly: false @@ -63642,8 +64326,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -63661,7 +64345,7 @@ paths: type: integer secrets: type: array - items: &433 + items: &436 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -63714,16 +64398,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: *431 + schema: *434 examples: - default: *432 + default: *435 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63743,15 +64427,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 responses: '200': description: Response content: application/json: - schema: *433 + schema: *436 examples: default: value: @@ -63777,9 +64461,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 requestBody: required: true content: @@ -63807,7 +64491,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -63831,9 +64515,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 responses: '204': description: Response @@ -63855,8 +64539,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: - - *292 - - *293 + - *295 + - *296 - 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 @@ -64016,8 +64700,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -64220,8 +64904,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -64296,7 +64980,7 @@ paths: - version - url additionalProperties: false - metadata: &434 + metadata: &437 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -64329,7 +65013,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *434 + metadata: *437 resolved: type: object description: A collection of resolved package dependencies. @@ -64342,7 +65026,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *434 + metadata: *437 relationship: type: string description: A notation of whether a dependency is requested @@ -64471,8 +65155,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *292 - - *293 + - *295 + - *296 - name: sha description: The SHA recorded at creation time. in: query @@ -64512,9 +65196,9 @@ paths: application/json: schema: type: array - items: *435 + items: *438 examples: - default: *436 + default: *439 headers: Link: *39 x-github: @@ -64580,8 +65264,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -64662,7 +65346,7 @@ paths: description: Response content: application/json: - schema: *435 + schema: *438 examples: simple-example: summary: Simple example @@ -64735,9 +65419,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *292 - - *293 - - &437 + - *295 + - *296 + - &440 name: deployment_id description: deployment_id parameter in: path @@ -64749,7 +65433,7 @@ paths: description: Response content: application/json: - schema: *435 + schema: *438 examples: default: value: @@ -64814,9 +65498,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *292 - - *293 - - *437 + - *295 + - *296 + - *440 responses: '204': description: Response @@ -64838,9 +65522,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *292 - - *293 - - *437 + - *295 + - *296 + - *440 - *18 - *20 responses: @@ -64850,7 +65534,7 @@ paths: application/json: schema: type: array - items: &438 + items: &441 title: Deployment Status description: The status of a deployment. type: object @@ -64941,8 +65625,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 required: - id - node_id @@ -65011,9 +65695,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *292 - - *293 - - *437 + - *295 + - *296 + - *440 requestBody: required: true content: @@ -65088,9 +65772,9 @@ paths: description: Response content: application/json: - schema: *438 + schema: *441 examples: - default: &439 + default: &442 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -65146,9 +65830,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *292 - - *293 - - *437 + - *295 + - *296 + - *440 - name: status_id in: path required: true @@ -65159,9 +65843,9 @@ paths: description: Response content: application/json: - schema: *438 + schema: *441 examples: - default: *439 + default: *442 '404': *7 x-github: githubCloudOnly: false @@ -65186,8 +65870,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -65244,8 +65928,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -65262,7 +65946,7 @@ paths: type: integer environments: type: array - items: &441 + items: &444 title: Environment description: Details of a deployment environment type: object @@ -65314,7 +65998,7 @@ paths: type: type: string example: wait_timer - wait_timer: &443 + wait_timer: &446 type: integer example: 30 description: The amount of time to delay a job after @@ -65351,11 +66035,11 @@ paths: items: type: object properties: - type: *440 + type: *443 reviewer: anyOf: - *19 - - *207 + - *210 required: - id - node_id @@ -65375,7 +66059,7 @@ paths: - id - node_id - type - deployment_branch_policy: &444 + deployment_branch_policy: &447 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -65491,9 +66175,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *292 - - *293 - - &442 + - *295 + - *296 + - &445 name: environment_name in: path required: true @@ -65506,9 +66190,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *444 examples: - default: &445 + default: &448 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -65592,9 +66276,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *292 - - *293 - - *442 + - *295 + - *296 + - *445 requestBody: required: false content: @@ -65603,7 +66287,7 @@ paths: type: object nullable: true properties: - wait_timer: *443 + wait_timer: *446 prevent_self_review: type: boolean example: false @@ -65620,13 +66304,13 @@ paths: items: type: object properties: - type: *440 + type: *443 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *444 + deployment_branch_policy: *447 additionalProperties: false examples: default: @@ -65646,9 +66330,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *444 examples: - default: *445 + default: *448 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -65672,9 +66356,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *292 - - *293 - - *442 + - *295 + - *296 + - *445 responses: '204': description: Default response @@ -65699,9 +66383,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *292 - - *293 - - *442 + - *295 + - *296 + - *445 - *18 - *20 responses: @@ -65719,7 +66403,7 @@ paths: example: 2 branch_policies: type: array - items: &446 + items: &449 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -65776,9 +66460,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *292 - - *293 - - *442 + - *295 + - *296 + - *445 requestBody: required: true content: @@ -65824,9 +66508,9 @@ paths: description: Response content: application/json: - schema: *446 + schema: *449 examples: - example-wildcard: &447 + example-wildcard: &450 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -65868,10 +66552,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *292 - - *293 - - *442 - - &448 + - *295 + - *296 + - *445 + - &451 name: branch_policy_id in: path required: true @@ -65883,9 +66567,9 @@ paths: description: Response content: application/json: - schema: *446 + schema: *449 examples: - default: *447 + default: *450 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65904,10 +66588,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *292 - - *293 - - *442 - - *448 + - *295 + - *296 + - *445 + - *451 requestBody: required: true content: @@ -65935,9 +66619,9 @@ paths: description: Response content: application/json: - schema: *446 + schema: *449 examples: - default: *447 + default: *450 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65956,10 +66640,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *292 - - *293 - - *442 - - *448 + - *295 + - *296 + - *445 + - *451 responses: '204': description: Response @@ -65984,9 +66668,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: - - *442 - - *293 - - *292 + - *445 + - *296 + - *295 responses: '200': description: List of deployment protection rules @@ -66002,7 +66686,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &449 + items: &452 title: Deployment protection rule description: Deployment protection rule type: object @@ -66021,7 +66705,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &450 + app: &453 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -66120,9 +66804,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: - - *442 - - *293 - - *292 + - *445 + - *296 + - *295 requestBody: content: application/json: @@ -66143,9 +66827,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *449 + schema: *452 examples: - default: &451 + default: &454 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -66180,9 +66864,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: - - *442 - - *293 - - *292 + - *445 + - *296 + - *295 - *20 - *18 responses: @@ -66201,7 +66885,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *450 + items: *453 examples: default: value: @@ -66236,10 +66920,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: - - *292 - - *293 - - *442 - - &452 + - *295 + - *296 + - *445 + - &455 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -66251,9 +66935,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: *451 + default: *454 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66274,10 +66958,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: - - *442 - - *293 - - *292 - - *452 + - *445 + - *296 + - *295 + - *455 responses: '204': description: Response @@ -66303,9 +66987,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *292 - - *293 - - *442 + - *295 + - *296 + - *445 - *18 - *20 responses: @@ -66323,9 +67007,9 @@ paths: type: integer secrets: type: array - items: *329 + items: *332 examples: - default: *330 + default: *333 headers: Link: *39 x-github: @@ -66350,17 +67034,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *292 - - *293 - - *442 + - *295 + - *296 + - *445 responses: '200': description: Response content: application/json: - schema: *331 + schema: *334 examples: - default: *332 + default: *335 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66382,18 +67066,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *292 - - *293 - - *442 - - *149 + - *295 + - *296 + - *445 + - *152 responses: '200': description: Response content: application/json: - schema: *329 + schema: *332 examples: - default: *453 + default: *456 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66415,10 +67099,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *292 - - *293 - - *442 - - *149 + - *295 + - *296 + - *445 + - *152 requestBody: required: true content: @@ -66449,7 +67133,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -66475,10 +67159,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *292 - - *293 - - *442 - - *149 + - *295 + - *296 + - *445 + - *152 responses: '204': description: Default response @@ -66503,10 +67187,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *292 - - *293 - - *442 - - *316 + - *295 + - *296 + - *445 + - *319 - *20 responses: '200': @@ -66523,9 +67207,9 @@ paths: type: integer variables: type: array - items: *333 + items: *336 examples: - default: *334 + default: *337 headers: Link: *39 x-github: @@ -66548,9 +67232,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *292 - - *293 - - *442 + - *295 + - *296 + - *445 requestBody: required: true content: @@ -66577,7 +67261,7 @@ paths: description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -66602,18 +67286,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *292 - - *293 - - *442 - - *152 + - *295 + - *296 + - *445 + - *155 responses: '200': description: Response content: application/json: - schema: *333 + schema: *336 examples: - default: *454 + default: *457 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66634,10 +67318,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *292 - - *293 - - *152 - - *442 + - *295 + - *296 + - *155 + - *445 requestBody: required: true content: @@ -66679,10 +67363,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *292 - - *293 - - *152 - - *442 + - *295 + - *296 + - *155 + - *445 responses: '204': description: Response @@ -66704,8 +67388,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -66715,7 +67399,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: 200-response: value: @@ -66782,8 +67466,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *292 - - *293 + - *295 + - *296 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -66805,7 +67489,7 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: default: value: @@ -66942,8 +67626,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: false content: @@ -66975,9 +67659,9 @@ paths: description: Response content: application/json: - schema: *305 + schema: *308 examples: - default: *307 + default: *310 '400': *15 '422': *16 '403': *29 @@ -66998,8 +67682,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -67050,7 +67734,7 @@ paths: schema: type: string '404': *7 - '409': *126 + '409': *129 '403': *29 '422': description: Validation failed @@ -67058,8 +67742,8 @@ paths: application/json: schema: oneOf: - - *124 - - *455 + - *127 + - *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67084,8 +67768,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *292 - - *293 + - *295 + - *296 - name: file_sha in: path required: true @@ -67136,7 +67820,7 @@ paths: '404': *7 '422': *16 '403': *29 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67183,8 +67867,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -67293,7 +67977,7 @@ paths: description: Response content: application/json: - schema: &456 + schema: &459 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -67452,7 +68136,7 @@ paths: type: string '422': *16 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67501,15 +68185,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *292 - - *293 - - *409 + - *295 + - *296 + - *412 responses: '200': description: Response content: application/json: - schema: *456 + schema: *459 examples: default: value: @@ -67539,7 +68223,7 @@ paths: signature: payload: '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67564,9 +68248,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *292 - - *293 - - &457 + - *295 + - *296 + - &460 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. @@ -67583,7 +68267,7 @@ paths: application/json: schema: type: array - items: &458 + items: &461 title: Git Reference description: Git references within a repository type: object @@ -67637,7 +68321,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *39 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67658,17 +68342,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *292 - - *293 - - *457 + - *295 + - *296 + - *460 responses: '200': description: Response content: application/json: - schema: *458 + schema: *461 examples: - default: &459 + default: &462 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -67678,7 +68362,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67697,8 +68381,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -67727,16 +68411,16 @@ paths: description: Response content: application/json: - schema: *458 + schema: *461 examples: - default: *459 + default: *462 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *16 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67755,9 +68439,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *292 - - *293 - - *457 + - *295 + - *296 + - *460 requestBody: required: true content: @@ -67786,11 +68470,11 @@ paths: description: Response content: application/json: - schema: *458 + schema: *461 examples: - default: *459 + default: *462 '422': *16 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67806,14 +68490,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *292 - - *293 - - *457 + - *295 + - *296 + - *460 responses: '204': description: Response '422': *16 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67860,8 +68544,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -67928,7 +68612,7 @@ paths: description: Response content: application/json: - schema: &461 + schema: &464 title: Git Tag description: Metadata for a Git tag type: object @@ -67979,7 +68663,7 @@ paths: - sha - type - url - verification: *460 + verification: *463 required: - sha - url @@ -67989,7 +68673,7 @@ paths: - tag - message examples: - default: &462 + default: &465 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -68015,7 +68699,7 @@ paths: schema: type: string '422': *16 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68060,8 +68744,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *292 - - *293 + - *295 + - *296 - name: tag_sha in: path required: true @@ -68072,11 +68756,11 @@ paths: description: Response content: application/json: - schema: *461 + schema: *464 examples: - default: *462 + default: *465 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68098,8 +68782,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -68172,7 +68856,7 @@ paths: description: Response content: application/json: - schema: &463 + schema: &466 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -68261,7 +68945,7 @@ paths: '422': *16 '404': *7 '403': *29 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68284,8 +68968,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *292 - - *293 + - *295 + - *296 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -68308,7 +68992,7 @@ paths: description: Response content: application/json: - schema: *463 + schema: *466 examples: default-response: summary: Default response @@ -68349,7 +69033,7 @@ paths: truncated: false '422': *16 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68367,8 +69051,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -68378,7 +69062,7 @@ paths: application/json: schema: type: array - items: &464 + items: &467 title: Webhook description: Webhooks for repositories. type: object @@ -68432,7 +69116,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &708 + last_response: &711 title: Hook Response type: object properties: @@ -68506,8 +69190,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: false content: @@ -68559,9 +69243,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *467 examples: - default: &465 + default: &468 value: type: Repository id: 12345678 @@ -68609,17 +69293,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 responses: '200': description: Response content: application/json: - schema: *464 + schema: *467 examples: - default: *465 + default: *468 '404': *7 x-github: githubCloudOnly: false @@ -68639,9 +69323,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 requestBody: required: true content: @@ -68686,9 +69370,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *467 examples: - default: *465 + default: *468 '422': *16 '404': *7 x-github: @@ -68706,9 +69390,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 responses: '204': description: Response @@ -68732,9 +69416,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: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 responses: '200': description: Response @@ -68761,9 +69445,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: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 requestBody: required: false content: @@ -68807,11 +69491,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 - *18 - - *196 + - *199 - name: redelivery in: query required: false @@ -68824,9 +69508,9 @@ paths: application/json: schema: type: array - items: *197 + items: *200 examples: - default: *198 + default: *201 '400': *15 '422': *16 x-github: @@ -68845,18 +69529,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: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 - *17 responses: '200': description: Response content: application/json: - schema: *199 + schema: *202 examples: - default: *200 + default: *203 '400': *15 '422': *16 x-github: @@ -68875,12 +69559,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: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 - *17 responses: - '202': *127 + '202': *130 '400': *15 '422': *16 x-github: @@ -68900,9 +69584,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 responses: '204': description: Response @@ -68927,9 +69611,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 responses: '204': description: Response @@ -68987,14 +69671,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: &466 + schema: &469 title: Import description: A repository import from an external source. type: object @@ -69093,7 +69777,7 @@ paths: - html_url - authors_url examples: - default: &469 + default: &472 value: vcs: subversion use_lfs: true @@ -69109,7 +69793,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *7 - '503': &467 + '503': &470 description: Unavailable due to service under maintenance. content: application/json: @@ -69138,8 +69822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -69187,7 +69871,7 @@ paths: description: Response content: application/json: - schema: *466 + schema: *469 examples: default: value: @@ -69212,7 +69896,7 @@ paths: type: string '422': *16 '404': *7 - '503': *467 + '503': *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69240,8 +69924,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: false content: @@ -69290,7 +69974,7 @@ paths: description: Response content: application/json: - schema: *466 + schema: *469 examples: example-1: summary: Example 1 @@ -69338,7 +70022,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': *467 + '503': *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69361,12 +70045,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response - '503': *467 + '503': *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69392,9 +70076,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *292 - - *293 - - &654 + - *295 + - *296 + - &657 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -69408,7 +70092,7 @@ paths: application/json: schema: type: array - items: &468 + items: &471 title: Porter Author description: Porter Author type: object @@ -69462,7 +70146,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *7 - '503': *467 + '503': *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69487,8 +70171,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *292 - - *293 + - *295 + - *296 - name: author_id in: path required: true @@ -69518,7 +70202,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *471 examples: default: value: @@ -69531,7 +70215,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *16 '404': *7 - '503': *467 + '503': *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69555,8 +70239,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -69597,7 +70281,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *467 + '503': *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69625,8 +70309,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -69653,11 +70337,11 @@ paths: description: Response content: application/json: - schema: *466 + schema: *469 examples: - default: *469 + default: *472 '422': *16 - '503': *467 + '503': *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69680,8 +70364,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -69689,8 +70373,8 @@ paths: application/json: schema: *22 examples: - default: *470 - '301': *306 + default: *473 + '301': *309 '404': *7 x-github: githubCloudOnly: false @@ -69710,8 +70394,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -69719,12 +70403,12 @@ paths: application/json: schema: anyOf: - - *202 + - *205 - type: object properties: {} additionalProperties: false examples: - default: &472 + default: &475 value: limit: collaborators_only origin: repository @@ -69749,13 +70433,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: application/json: - schema: *471 + schema: *474 examples: default: summary: Example request body @@ -69767,9 +70451,9 @@ paths: description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *472 + default: *475 '409': description: Response x-github: @@ -69791,8 +70475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -69815,8 +70499,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -69826,9 +70510,9 @@ paths: application/json: schema: type: array - items: *473 + items: *476 examples: - default: &647 + default: &650 value: - id: 1 repository: @@ -69959,9 +70643,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *292 - - *293 - - *206 + - *295 + - *296 + - *209 requestBody: required: false content: @@ -69990,7 +70674,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *476 examples: default: value: @@ -70121,9 +70805,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *292 - - *293 - - *206 + - *295 + - *296 + - *209 responses: '204': description: Response @@ -70154,8 +70838,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *292 - - *293 + - *295 + - *296 - 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 @@ -70195,7 +70879,7 @@ paths: required: false schema: type: string - - *208 + - *211 - name: sort description: What to sort results by. in: query @@ -70208,7 +70892,7 @@ paths: - comments default: created - *67 - - *94 + - *97 - *18 - *20 responses: @@ -70218,7 +70902,7 @@ paths: application/json: schema: type: array - items: *104 + items: *107 examples: default: value: @@ -70368,7 +71052,7 @@ paths: state_reason: completed headers: Link: *39 - '301': *306 + '301': *309 '422': *16 '404': *7 x-github: @@ -70397,8 +71081,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -70473,9 +71157,9 @@ paths: description: Response content: application/json: - schema: *104 + schema: *107 examples: - default: &479 + default: &482 value: id: 1 node_id: MDU6SXNzdWUx @@ -70631,7 +71315,7 @@ paths: '422': *16 '503': *85 '404': *7 - '410': *303 + '410': *306 x-github: triggersNotification: true githubCloudOnly: false @@ -70659,9 +71343,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *292 - - *293 - - *114 + - *295 + - *296 + - *117 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -70671,7 +71355,7 @@ paths: enum: - asc - desc - - *94 + - *97 - *18 - *20 responses: @@ -70681,9 +71365,9 @@ paths: application/json: schema: type: array - items: *474 + items: *477 examples: - default: &481 + default: &484 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -70741,17 +71425,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 responses: '200': description: Response content: application/json: - schema: *474 + schema: *477 examples: - default: &475 + default: &478 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -70805,9 +71489,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 requestBody: required: true content: @@ -70829,9 +71513,9 @@ paths: description: Response content: application/json: - schema: *474 + schema: *477 examples: - default: *475 + default: *478 '422': *16 x-github: githubCloudOnly: false @@ -70849,9 +71533,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 responses: '204': description: Response @@ -70871,9 +71555,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 - 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. @@ -70899,9 +71583,9 @@ paths: application/json: schema: type: array - items: *281 + items: *284 examples: - default: *283 + default: *286 headers: Link: *39 '404': *7 @@ -70922,9 +71606,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 requestBody: required: true content: @@ -70956,16 +71640,16 @@ paths: description: Reaction exists content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '201': description: Reaction created content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '422': *16 x-github: githubCloudOnly: false @@ -70987,10 +71671,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *292 - - *293 - - *103 - - *284 + - *295 + - *296 + - *106 + - *287 responses: '204': description: Response @@ -71010,8 +71694,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -71021,7 +71705,7 @@ paths: application/json: schema: type: array - items: &478 + items: &481 title: Issue Event description: Issue Event type: object @@ -71064,8 +71748,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *476 - required: *477 + properties: *479 + required: *480 nullable: true label: title: Issue Event Label @@ -71109,7 +71793,7 @@ paths: properties: *4 required: *5 nullable: true - requested_team: *207 + requested_team: *210 dismissed_review: title: Issue Event Dismissed Review type: object @@ -71174,7 +71858,7 @@ paths: required: - from - to - author_association: *91 + author_association: *94 lock_reason: type: string nullable: true @@ -71187,8 +71871,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 required: - id - node_id @@ -71372,8 +72056,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *292 - - *293 + - *295 + - *296 - name: event_id in: path required: true @@ -71384,7 +72068,7 @@ paths: description: Response content: application/json: - schema: *478 + schema: *481 examples: default: value: @@ -71577,7 +72261,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *7 - '410': *303 + '410': *306 '403': *29 x-github: githubCloudOnly: false @@ -71611,9 +72295,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *292 - - *293 - - &480 + - *295 + - *296 + - &483 name: issue_number description: The number that identifies the issue. in: path @@ -71625,12 +72309,12 @@ paths: description: Response content: application/json: - schema: *104 + schema: *107 examples: - default: *479 - '301': *306 + default: *482 + '301': *309 '404': *7 - '410': *303 + '410': *306 '304': *37 x-github: githubCloudOnly: false @@ -71655,9 +72339,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 requestBody: required: false content: @@ -71752,15 +72436,15 @@ paths: description: Response content: application/json: - schema: *104 + schema: *107 examples: - default: *479 + default: *482 '422': *16 '503': *85 '403': *29 - '301': *306 + '301': *309 '404': *7 - '410': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71778,9 +72462,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 requestBody: required: false content: @@ -71806,9 +72490,9 @@ paths: description: Response content: application/json: - schema: *104 + schema: *107 examples: - default: *479 + default: *482 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71824,9 +72508,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 requestBody: content: application/json: @@ -71851,9 +72535,9 @@ paths: description: Response content: application/json: - schema: *104 + schema: *107 examples: - default: *479 + default: *482 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71875,9 +72559,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: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 - name: assignee in: path required: true @@ -71917,10 +72601,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *292 - - *293 - - *480 - - *94 + - *295 + - *296 + - *483 + - *97 - *18 - *20 responses: @@ -71930,13 +72614,13 @@ paths: application/json: schema: type: array - items: *474 + items: *477 examples: - default: *481 + default: *484 headers: Link: *39 '404': *7 - '410': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71965,9 +72649,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 requestBody: required: true content: @@ -71989,16 +72673,16 @@ paths: description: Response content: application/json: - schema: *474 + schema: *477 examples: - default: *475 + default: *478 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *303 + '410': *306 '422': *16 '404': *7 x-github: @@ -72018,9 +72702,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 - *18 - *20 responses: @@ -72034,7 +72718,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &484 + - &487 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -72065,8 +72749,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 label: type: object properties: @@ -72088,7 +72772,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &485 + - &488 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -72119,8 +72803,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 label: type: object properties: @@ -72208,8 +72892,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 assignee: *19 assigner: *19 required: @@ -72224,7 +72908,7 @@ paths: - performed_via_github_app - assignee - assigner - - &486 + - &489 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -72255,8 +72939,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 milestone: type: object properties: @@ -72275,7 +72959,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &487 + - &490 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -72306,8 +72990,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 milestone: type: object properties: @@ -72326,7 +73010,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &488 + - &491 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -72357,8 +73041,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 rename: type: object properties: @@ -72380,7 +73064,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &489 + - &492 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -72411,10 +73095,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 review_requester: *19 - requested_team: *207 + requested_team: *210 requested_reviewer: *19 required: - review_requester @@ -72427,7 +73111,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &490 + - &493 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -72458,10 +73142,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 review_requester: *19 - requested_team: *207 + requested_team: *210 requested_reviewer: *19 required: - review_requester @@ -72474,7 +73158,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &491 + - &494 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -72505,8 +73189,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 dismissed_review: type: object properties: @@ -72534,7 +73218,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &492 + - &495 title: Locked Issue Event description: Locked Issue Event type: object @@ -72565,8 +73249,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 lock_reason: type: string example: '"off-topic"' @@ -72582,7 +73266,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &493 + - &496 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -72613,8 +73297,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 project_card: type: object properties: @@ -72648,7 +73332,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &494 + - &497 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -72679,8 +73363,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 project_card: type: object properties: @@ -72714,7 +73398,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &495 + - &498 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -72745,8 +73429,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 project_card: type: object properties: @@ -72780,7 +73464,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &496 + - &499 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -72871,7 +73555,7 @@ paths: color: red headers: Link: *39 - '410': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72888,9 +73572,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 - *18 - *20 responses: @@ -72900,7 +73584,7 @@ paths: application/json: schema: type: array - items: &482 + items: &485 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -72947,7 +73631,7 @@ paths: - color - default examples: - default: &483 + default: &486 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -72965,9 +73649,9 @@ paths: default: false headers: Link: *39 - '301': *306 + '301': *309 '404': *7 - '410': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72984,9 +73668,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 requestBody: required: false content: @@ -73045,12 +73729,12 @@ paths: application/json: schema: type: array - items: *482 + items: *485 examples: - default: *483 - '301': *306 + default: *486 + '301': *309 '404': *7 - '410': *303 + '410': *306 '422': *16 x-github: githubCloudOnly: false @@ -73067,9 +73751,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 requestBody: required: false content: @@ -73129,12 +73813,12 @@ paths: application/json: schema: type: array - items: *482 + items: *485 examples: - default: *483 - '301': *306 + default: *486 + '301': *309 '404': *7 - '410': *303 + '410': *306 '422': *16 x-github: githubCloudOnly: false @@ -73151,15 +73835,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 responses: '204': description: Response - '301': *306 + '301': *309 '404': *7 - '410': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73178,9 +73862,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 - name: name in: path required: true @@ -73193,7 +73877,7 @@ paths: application/json: schema: type: array - items: *482 + items: *485 examples: default: value: @@ -73204,9 +73888,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *306 + '301': *309 '404': *7 - '410': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73226,9 +73910,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 requestBody: required: false content: @@ -73256,7 +73940,7 @@ paths: '204': description: Response '403': *29 - '410': *303 + '410': *306 '404': *7 '422': *16 x-github: @@ -73274,9 +73958,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 responses: '204': description: Response @@ -73298,9 +73982,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 - 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. @@ -73326,13 +74010,13 @@ paths: application/json: schema: type: array - items: *281 + items: *284 examples: - default: *283 + default: *286 headers: Link: *39 '404': *7 - '410': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73350,9 +74034,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 requestBody: required: true content: @@ -73384,16 +74068,16 @@ paths: description: Response content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '201': description: Response content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '422': *16 x-github: githubCloudOnly: false @@ -73415,10 +74099,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *292 - - *293 - - *480 - - *284 + - *295 + - *296 + - *483 + - *287 responses: '204': description: Response @@ -73438,9 +74122,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 - *18 - *20 responses: @@ -73455,9 +74139,6 @@ paths: description: Timeline Event type: object anyOf: - - *484 - - *485 - - *486 - *487 - *488 - *489 @@ -73468,6 +74149,9 @@ paths: - *494 - *495 - *496 + - *497 + - *498 + - *499 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -73510,7 +74194,7 @@ paths: issue_url: type: string format: uri - author_association: *91 + author_association: *94 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -73520,9 +74204,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 - reactions: *92 + properties: *92 + required: *93 + reactions: *95 required: - event - actor @@ -73553,7 +74237,7 @@ paths: properties: type: type: string - issue: *104 + issue: *107 required: - event - created_at @@ -73745,7 +74429,7 @@ paths: type: string body_text: type: string - author_association: *91 + author_association: *94 required: - event - id @@ -73768,7 +74452,7 @@ paths: type: string comments: type: array - items: &518 + items: &521 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -73857,7 +74541,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *91 + author_association: *94 _links: type: object properties: @@ -73941,7 +74625,7 @@ paths: enum: - line - file - reactions: *92 + reactions: *95 body_html: type: string example: '"

comment body

"' @@ -73977,7 +74661,7 @@ paths: type: string comments: type: array - items: *407 + items: *410 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -74008,8 +74692,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 assignee: *19 required: - id @@ -74052,8 +74736,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 assignee: *19 required: - id @@ -74096,8 +74780,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 state_reason: type: string nullable: true @@ -74266,7 +74950,7 @@ paths: headers: Link: *39 '404': *7 - '410': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74283,8 +74967,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -74294,7 +74978,7 @@ paths: application/json: schema: type: array - items: &497 + items: &500 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -74356,8 +75040,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -74393,9 +75077,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *500 examples: - default: &498 + default: &501 value: id: 1 key: ssh-rsa AAA... @@ -74428,9 +75112,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *292 - - *293 - - &499 + - *295 + - *296 + - &502 name: key_id description: The unique identifier of the key. in: path @@ -74442,9 +75126,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *500 examples: - default: *498 + default: *501 '404': *7 x-github: githubCloudOnly: false @@ -74462,9 +75146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *292 - - *293 - - *499 + - *295 + - *296 + - *502 responses: '204': description: Response @@ -74484,8 +75168,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -74495,9 +75179,9 @@ paths: application/json: schema: type: array - items: *482 + items: *485 examples: - default: *483 + default: *486 headers: Link: *39 '404': *7 @@ -74518,8 +75202,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -74555,9 +75239,9 @@ paths: description: Response content: application/json: - schema: *482 + schema: *485 examples: - default: &500 + default: &503 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -74589,8 +75273,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *292 - - *293 + - *295 + - *296 - name: name in: path required: true @@ -74601,9 +75285,9 @@ paths: description: Response content: application/json: - schema: *482 + schema: *485 examples: - default: *500 + default: *503 '404': *7 x-github: githubCloudOnly: false @@ -74620,8 +75304,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *292 - - *293 + - *295 + - *296 - name: name in: path required: true @@ -74660,7 +75344,7 @@ paths: description: Response content: application/json: - schema: *482 + schema: *485 examples: default: value: @@ -74686,8 +75370,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *292 - - *293 + - *295 + - *296 - name: name in: path required: true @@ -74713,8 +75397,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -74750,10 +75434,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 responses: - '202': *127 + '202': *130 '403': description: |- We will return a 403 with one of the following messages: @@ -74779,8 +75463,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -74806,9 +75490,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *292 - - *293 - - *382 + - *295 + - *296 + - *385 responses: '200': description: Response @@ -74870,8 +75554,8 @@ paths: title: License Simple description: License Simple type: object - properties: *105 - required: *106 + properties: *108 + required: *109 nullable: true required: - _links @@ -74953,8 +75637,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -75019,8 +75703,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -75054,9 +75738,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *408 + schema: *411 examples: - default: *501 + default: *504 '204': description: Response when already merged '404': @@ -75081,8 +75765,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *292 - - *293 + - *295 + - *296 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -75123,12 +75807,12 @@ paths: application/json: schema: type: array - items: &502 + items: &505 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *412 - required: *413 + properties: *415 + required: *416 examples: default: value: @@ -75184,8 +75868,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -75225,9 +75909,9 @@ paths: description: Response content: application/json: - schema: *502 + schema: *505 examples: - default: &503 + default: &506 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -75286,9 +75970,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *292 - - *293 - - &504 + - *295 + - *296 + - &507 name: milestone_number description: The number that identifies the milestone. in: path @@ -75300,9 +75984,9 @@ paths: description: Response content: application/json: - schema: *502 + schema: *505 examples: - default: *503 + default: *506 '404': *7 x-github: githubCloudOnly: false @@ -75319,9 +76003,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *292 - - *293 - - *504 + - *295 + - *296 + - *507 requestBody: required: false content: @@ -75359,9 +76043,9 @@ paths: description: Response content: application/json: - schema: *502 + schema: *505 examples: - default: *503 + default: *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75377,9 +76061,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *292 - - *293 - - *504 + - *295 + - *296 + - *507 responses: '204': description: Response @@ -75400,9 +76084,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: - - *292 - - *293 - - *504 + - *295 + - *296 + - *507 - *18 - *20 responses: @@ -75412,9 +76096,9 @@ paths: application/json: schema: type: array - items: *482 + items: *485 examples: - default: *483 + default: *486 headers: Link: *39 x-github: @@ -75433,12 +76117,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: - - *292 - - *293 - - *505 - - *506 - - *94 - - *507 + - *295 + - *296 + - *508 + - *509 + - *97 + - *510 - *18 - *20 responses: @@ -75448,9 +76132,9 @@ paths: application/json: schema: type: array - items: *117 + items: *120 examples: - default: *508 + default: *511 headers: Link: *39 x-github: @@ -75474,8 +76158,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: false content: @@ -75533,14 +76217,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: &509 + schema: &512 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -75665,7 +76349,7 @@ paths: - custom_404 - public examples: - default: &510 + default: &513 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -75706,8 +76390,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -75761,11 +76445,11 @@ paths: description: Response content: application/json: - schema: *509 + schema: *512 examples: - default: *510 + default: *513 '422': *16 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75786,8 +76470,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -75873,7 +76557,7 @@ paths: description: Response '422': *16 '400': *15 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75894,14 +76578,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response '422': *16 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75921,8 +76605,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -75932,7 +76616,7 @@ paths: application/json: schema: type: array - items: &511 + items: &514 title: Page Build description: Page Build type: object @@ -76026,8 +76710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *292 - - *293 + - *295 + - *296 responses: '201': description: Response @@ -76072,16 +76756,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: *511 + schema: *514 examples: - default: &512 + default: &515 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -76129,8 +76813,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *292 - - *293 + - *295 + - *296 - name: build_id in: path required: true @@ -76141,9 +76825,9 @@ paths: description: Response content: application/json: - schema: *511 + schema: *514 examples: - default: *512 + default: *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76163,8 +76847,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -76270,9 +76954,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: - - *292 - - *293 - - &513 + - *295 + - *296 + - &516 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -76330,11 +77014,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *292 - - *293 - - *513 + - *295 + - *296 + - *516 responses: - '204': *170 + '204': *173 '404': *7 x-github: githubCloudOnly: false @@ -76359,8 +77043,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -76591,7 +77275,7 @@ paths: description: Empty response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -76618,8 +77302,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Private vulnerability reporting status @@ -76656,10 +77340,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: - - *292 - - *293 + - *295 + - *296 responses: - '204': *170 + '204': *173 '422': *15 x-github: githubCloudOnly: false @@ -76678,10 +77362,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: - - *292 - - *293 + - *295 + - *296 responses: - '204': *170 + '204': *173 '422': *15 x-github: githubCloudOnly: false @@ -76702,8 +77386,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-repository-projects parameters: - - *292 - - *293 + - *295 + - *296 - name: state description: Indicates the state of the projects to return. in: query @@ -76724,7 +77408,7 @@ paths: application/json: schema: type: array - items: *236 + items: *239 examples: default: value: @@ -76764,7 +77448,7 @@ paths: '401': *25 '403': *29 '404': *7 - '410': *303 + '410': *306 '422': *8 x-github: githubCloudOnly: false @@ -76784,8 +77468,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-a-repository-project parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -76811,13 +77495,13 @@ paths: description: Response content: application/json: - schema: *236 + schema: *239 examples: - default: *302 + default: *305 '401': *25 '403': *29 '404': *7 - '410': *303 + '410': *306 '422': *8 x-github: githubCloudOnly: false @@ -76837,8 +77521,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -76846,7 +77530,7 @@ paths: application/json: schema: type: array - items: *241 + items: *244 examples: default: value: @@ -76877,8 +77561,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -76890,7 +77574,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *241 + items: *244 required: - properties examples: @@ -76940,8 +77624,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *292 - - *293 + - *295 + - *296 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -77001,9 +77685,9 @@ paths: application/json: schema: type: array - items: *514 + items: *517 examples: - default: *515 + default: *518 headers: Link: *39 '304': *37 @@ -77035,8 +77719,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -77101,7 +77785,7 @@ paths: description: Response content: application/json: - schema: &520 + schema: &523 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -77212,8 +77896,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *412 - required: *413 + properties: *415 + required: *416 nullable: true active_lock_reason: type: string @@ -77258,7 +77942,7 @@ paths: nullable: true requested_teams: type: array - items: *516 + items: *519 nullable: true head: type: object @@ -77297,14 +77981,14 @@ paths: _links: type: object properties: - comments: *414 - commits: *414 - statuses: *414 - html: *414 - issue: *414 - review_comments: *414 - review_comment: *414 - self: *414 + comments: *417 + commits: *417 + statuses: *417 + html: *417 + issue: *417 + review_comments: *417 + review_comment: *417 + self: *417 required: - comments - commits @@ -77314,8 +77998,8 @@ paths: - review_comments - review_comment - self - author_association: *91 - auto_merge: *517 + author_association: *94 + auto_merge: *520 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -77407,7 +78091,7 @@ paths: - merged_by - review_comments examples: - default: &521 + default: &524 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -77934,8 +78618,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *292 - - *293 + - *295 + - *296 - name: sort in: query required: false @@ -77954,7 +78638,7 @@ paths: enum: - asc - desc - - *94 + - *97 - *18 - *20 responses: @@ -77964,9 +78648,9 @@ paths: application/json: schema: type: array - items: *518 + items: *521 examples: - default: &523 + default: &526 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -78043,17 +78727,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: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 responses: '200': description: Response content: application/json: - schema: *518 + schema: *521 examples: - default: &519 + default: &522 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -78128,9 +78812,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: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 requestBody: required: true content: @@ -78152,9 +78836,9 @@ paths: description: Response content: application/json: - schema: *518 + schema: *521 examples: - default: *519 + default: *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78170,9 +78854,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: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 responses: '204': description: Response @@ -78193,9 +78877,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: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 - 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. @@ -78221,9 +78905,9 @@ paths: application/json: schema: type: array - items: *281 + items: *284 examples: - default: *283 + default: *286 headers: Link: *39 '404': *7 @@ -78244,9 +78928,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: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 requestBody: required: true content: @@ -78278,16 +78962,16 @@ paths: description: Reaction exists content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '201': description: Reaction created content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '422': *16 x-github: githubCloudOnly: false @@ -78309,10 +78993,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *292 - - *293 - - *103 - - *284 + - *295 + - *296 + - *106 + - *287 responses: '204': description: Response @@ -78355,9 +79039,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *292 - - *293 - - &522 + - *295 + - *296 + - &525 name: pull_number description: The number that identifies the pull request. in: path @@ -78370,9 +79054,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *520 + schema: *523 examples: - default: *521 + default: *524 '304': *37 '404': *7 '406': @@ -78407,9 +79091,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 requestBody: required: false content: @@ -78451,9 +79135,9 @@ paths: description: Response content: application/json: - schema: *520 + schema: *523 examples: - default: *521 + default: *524 '422': *16 '403': *29 x-github: @@ -78475,9 +79159,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: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 requestBody: required: true content: @@ -78537,17 +79221,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '401': *25 '403': *29 '404': *7 @@ -78577,10 +79261,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: - - *292 - - *293 - - *522 - - *114 + - *295 + - *296 + - *525 + - *117 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -78590,7 +79274,7 @@ paths: enum: - asc - desc - - *94 + - *97 - *18 - *20 responses: @@ -78600,9 +79284,9 @@ paths: application/json: schema: type: array - items: *518 + items: *521 examples: - default: *523 + default: *526 headers: Link: *39 x-github: @@ -78635,9 +79319,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: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 requestBody: required: true content: @@ -78742,7 +79426,7 @@ paths: description: Response content: application/json: - schema: *518 + schema: *521 examples: example-for-a-multi-line-comment: value: @@ -78830,10 +79514,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: - - *292 - - *293 - - *522 - - *103 + - *295 + - *296 + - *525 + - *106 requestBody: required: true content: @@ -78855,7 +79539,7 @@ paths: description: Response content: application/json: - schema: *518 + schema: *521 examples: default: value: @@ -78941,9 +79625,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 - *18 - *20 responses: @@ -78953,9 +79637,9 @@ paths: application/json: schema: type: array - items: *408 + items: *411 examples: - default: *524 + default: *527 headers: Link: *39 x-github: @@ -78985,9 +79669,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 - *18 - *20 responses: @@ -78997,7 +79681,7 @@ paths: application/json: schema: type: array - items: *423 + items: *426 examples: default: value: @@ -79035,9 +79719,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: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 responses: '204': description: Response if pull request has been merged @@ -79060,9 +79744,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 requestBody: required: false content: @@ -79173,9 +79857,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: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 responses: '200': description: Response @@ -79191,7 +79875,7 @@ paths: items: *19 teams: type: array - items: *207 + items: *210 required: - users - teams @@ -79250,9 +79934,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: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 requestBody: required: false content: @@ -79289,7 +79973,7 @@ paths: description: Response content: application/json: - schema: *514 + schema: *517 examples: default: value: @@ -79825,9 +80509,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: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 requestBody: required: true content: @@ -79861,7 +80545,7 @@ paths: description: Response content: application/json: - schema: *514 + schema: *517 examples: default: value: @@ -80366,9 +81050,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 - *18 - *20 responses: @@ -80378,7 +81062,7 @@ paths: application/json: schema: type: array - items: &525 + items: &528 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -80447,7 +81131,7 @@ paths: type: string body_text: type: string - author_association: *91 + author_association: *94 required: - id - node_id @@ -80529,9 +81213,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: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 requestBody: required: false content: @@ -80617,9 +81301,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *528 examples: - default: &527 + default: &530 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -80682,10 +81366,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: - - *292 - - *293 - - *522 - - &526 + - *295 + - *296 + - *525 + - &529 name: review_id description: The unique identifier of the review. in: path @@ -80697,9 +81381,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *528 examples: - default: &528 + default: &531 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -80758,10 +81442,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: - - *292 - - *293 - - *522 - - *526 + - *295 + - *296 + - *525 + - *529 requestBody: required: true content: @@ -80784,7 +81468,7 @@ paths: description: Response content: application/json: - schema: *525 + schema: *528 examples: default: value: @@ -80846,18 +81530,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: - - *292 - - *293 - - *522 - - *526 + - *295 + - *296 + - *525 + - *529 responses: '200': description: Response content: application/json: - schema: *525 + schema: *528 examples: - default: *527 + default: *530 '422': *8 '404': *7 x-github: @@ -80884,10 +81568,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: - - *292 - - *293 - - *522 - - *526 + - *295 + - *296 + - *525 + - *529 - *18 - *20 responses: @@ -80966,13 +81650,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *91 + author_association: *94 _links: type: object properties: - self: *414 - html: *414 - pull_request: *414 + self: *417 + html: *417 + pull_request: *417 required: - self - html @@ -80981,7 +81665,7 @@ paths: type: string body_html: type: string - reactions: *92 + reactions: *95 side: description: The side of the first line of the range for a multi-line comment. @@ -81115,10 +81799,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: - - *292 - - *293 - - *522 - - *526 + - *295 + - *296 + - *525 + - *529 requestBody: required: true content: @@ -81146,7 +81830,7 @@ paths: description: Response content: application/json: - schema: *525 + schema: *528 examples: default: value: @@ -81209,10 +81893,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: - - *292 - - *293 - - *522 - - *526 + - *295 + - *296 + - *525 + - *529 requestBody: required: true content: @@ -81247,9 +81931,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *528 examples: - default: *528 + default: *531 '404': *7 '422': *8 '403': *29 @@ -81271,9 +81955,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 requestBody: required: false content: @@ -81336,8 +82020,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *292 - - *293 + - *295 + - *296 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -81350,9 +82034,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *532 examples: - default: &530 + default: &533 value: type: file encoding: base64 @@ -81394,8 +82078,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: - - *292 - - *293 + - *295 + - *296 - name: dir description: The alternate path to look for a README file in: path @@ -81415,9 +82099,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *532 examples: - default: *530 + default: *533 '404': *7 '422': *16 x-github: @@ -81439,8 +82123,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -81450,7 +82134,7 @@ paths: application/json: schema: type: array - items: &531 + items: &534 title: Release description: A release. type: object @@ -81513,7 +82197,7 @@ paths: author: *19 assets: type: array - items: &532 + items: &535 title: Release Asset description: Data related to a release. type: object @@ -81584,7 +82268,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *92 + reactions: *95 required: - assets_url - upload_url @@ -81694,8 +82378,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -81771,9 +82455,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *534 examples: - default: &535 + default: &538 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -81874,9 +82558,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *292 - - *293 - - &533 + - *295 + - *296 + - &536 name: asset_id description: The unique identifier of the asset. in: path @@ -81888,9 +82572,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *535 examples: - default: &534 + default: &537 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 @@ -81924,7 +82608,7 @@ paths: type: User site_admin: false '404': *7 - '302': *425 + '302': *428 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81940,9 +82624,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *292 - - *293 - - *533 + - *295 + - *296 + - *536 requestBody: required: false content: @@ -81970,9 +82654,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *535 examples: - default: *534 + default: *537 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81988,9 +82672,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *292 - - *293 - - *533 + - *295 + - *296 + - *536 responses: '204': description: Response @@ -82014,8 +82698,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -82100,16 +82784,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: *531 + schema: *534 examples: - default: *535 + default: *538 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82126,8 +82810,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *292 - - *293 + - *295 + - *296 - name: tag description: tag parameter in: path @@ -82140,9 +82824,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *534 examples: - default: *535 + default: *538 '404': *7 x-github: githubCloudOnly: false @@ -82164,9 +82848,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *292 - - *293 - - &536 + - *295 + - *296 + - &539 name: release_id description: The unique identifier of the release. in: path @@ -82180,9 +82864,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: *531 + schema: *534 examples: - default: *535 + default: *538 '401': description: Unauthorized x-github: @@ -82200,9 +82884,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *292 - - *293 - - *536 + - *295 + - *296 + - *539 requestBody: required: false content: @@ -82266,9 +82950,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *534 examples: - default: *535 + default: *538 '404': description: Not Found if the discussion category name is invalid content: @@ -82289,9 +82973,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *292 - - *293 - - *536 + - *295 + - *296 + - *539 responses: '204': description: Response @@ -82311,9 +82995,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *292 - - *293 - - *536 + - *295 + - *296 + - *539 - *18 - *20 responses: @@ -82323,7 +83007,7 @@ paths: application/json: schema: type: array - items: *532 + items: *535 examples: default: value: @@ -82404,9 +83088,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: - - *292 - - *293 - - *536 + - *295 + - *296 + - *539 - name: name in: query required: true @@ -82432,7 +83116,7 @@ paths: description: Response for successful upload content: application/json: - schema: *532 + schema: *535 examples: response-for-successful-upload: value: @@ -82486,9 +83170,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *292 - - *293 - - *536 + - *295 + - *296 + - *539 - 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. @@ -82512,9 +83196,9 @@ paths: application/json: schema: type: array - items: *281 + items: *284 examples: - default: *283 + default: *286 headers: Link: *39 '404': *7 @@ -82535,9 +83219,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *292 - - *293 - - *536 + - *295 + - *296 + - *539 requestBody: required: true content: @@ -82567,16 +83251,16 @@ paths: description: Reaction exists content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '201': description: Reaction created content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '422': *16 x-github: githubCloudOnly: false @@ -82598,10 +83282,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *292 - - *293 - - *536 - - *284 + - *295 + - *296 + - *539 + - *287 responses: '204': description: Response @@ -82625,9 +83309,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 - *18 - *20 responses: @@ -82643,8 +83327,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *537 - - &539 + - *540 + - &542 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -82663,54 +83347,54 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *538 - - *539 - - allOf: - - *540 - - *539 - allOf: - *541 - - *539 - - allOf: - *542 - - *539 - allOf: - *543 - - *539 + - *542 - allOf: - *544 - - *539 + - *542 - allOf: - *545 - - *539 + - *542 - allOf: - *546 - - *539 + - *542 - allOf: - *547 - - *539 + - *542 - allOf: - *548 - - *539 + - *542 - allOf: - *549 - - *539 + - *542 - allOf: - *550 - - *539 + - *542 - allOf: - *551 - - *539 + - *542 - allOf: - *552 - - *539 + - *542 - allOf: - *553 - - *539 + - *542 - allOf: - *554 - - *539 + - *542 + - allOf: + - *555 + - *542 + - allOf: + - *556 + - *542 + - allOf: + - *557 + - *542 examples: default: value: @@ -82749,8 +83433,8 @@ paths: category: repos subcategory: rules parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 - name: includes_parents @@ -82761,7 +83445,7 @@ paths: schema: type: boolean default: true - - *555 + - *558 responses: '200': description: Response @@ -82769,7 +83453,7 @@ paths: application/json: schema: type: array - items: *253 + items: *256 examples: default: value: @@ -82816,8 +83500,8 @@ paths: category: repos subcategory: rules parameters: - - *292 - - *293 + - *295 + - *296 requestBody: description: Request body required: true @@ -82837,16 +83521,16 @@ paths: - tag - push default: branch - enforcement: *249 + enforcement: *252 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *250 - conditions: *247 + items: *253 + conditions: *250 rules: type: array description: An array of rules within the ruleset. - items: *252 + items: *255 required: - name - enforcement @@ -82877,9 +83561,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: &565 + default: &568 value: id: 42 name: super cool ruleset @@ -82926,12 +83610,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *292 - - *293 - - *556 - - *557 - - *558 + - *295 + - *296 - *559 + - *560 + - *561 + - *562 - *18 - *20 responses: @@ -82939,9 +83623,9 @@ paths: description: Response content: application/json: - schema: *560 + schema: *563 examples: - default: *561 + default: *564 '404': *7 '500': *73 x-github: @@ -82962,17 +83646,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *292 - - *293 - - *562 + - *295 + - *296 + - *565 responses: '200': description: Response content: application/json: - schema: *563 + schema: *566 examples: - default: *564 + default: *567 '404': *7 '500': *73 x-github: @@ -83000,8 +83684,8 @@ paths: category: repos subcategory: rules parameters: - - *292 - - *293 + - *295 + - *296 - name: ruleset_id description: The ID of the ruleset. in: path @@ -83021,9 +83705,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: *565 + default: *568 '404': *7 '500': *73 put: @@ -83041,8 +83725,8 @@ paths: category: repos subcategory: rules parameters: - - *292 - - *293 + - *295 + - *296 - name: ruleset_id description: The ID of the ruleset. in: path @@ -83067,16 +83751,16 @@ paths: - branch - tag - push - enforcement: *249 + enforcement: *252 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *250 - conditions: *247 + items: *253 + conditions: *250 rules: description: An array of rules within the ruleset. type: array - items: *252 + items: *255 examples: default: value: @@ -83104,9 +83788,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: *565 + default: *568 '404': *7 '500': *73 delete: @@ -83124,8 +83808,8 @@ paths: category: repos subcategory: rules parameters: - - *292 - - *293 + - *295 + - *296 - name: ruleset_id description: The ID of the ruleset. in: path @@ -83153,20 +83837,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: - - *292 - - *293 - - *255 - - *256 - - *257 + - *295 + - *296 - *258 - - *67 - - *20 - - *18 - - *566 - - *567 - *259 - *260 - *261 + - *67 + - *20 + - *18 + - *569 + - *570 + - *262 + - *263 + - *264 responses: '200': description: Response @@ -83174,7 +83858,7 @@ paths: application/json: schema: type: array - items: &570 + items: &573 type: object properties: number: *74 @@ -83193,8 +83877,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *568 - resolution: *569 + state: *571 + resolution: *572 resolved_at: type: string format: date-time @@ -83359,15 +84043,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: - - *292 - - *293 - - *380 + - *295 + - *296 + - *383 responses: '200': description: Response content: application/json: - schema: *570 + schema: *573 examples: default: value: @@ -83415,9 +84099,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: - - *292 - - *293 - - *380 + - *295 + - *296 + - *383 requestBody: required: true content: @@ -83425,8 +84109,8 @@ paths: schema: type: object properties: - state: *568 - resolution: *569 + state: *571 + resolution: *572 resolution_comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -83444,7 +84128,7 @@ paths: description: Response content: application/json: - schema: *570 + schema: *573 examples: default: value: @@ -83515,9 +84199,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: - - *292 - - *293 - - *380 + - *295 + - *296 + - *383 - *20 - *18 responses: @@ -83528,7 +84212,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &729 + items: &732 type: object properties: type: @@ -83887,8 +84571,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -83896,14 +84580,14 @@ paths: schema: type: object properties: - reason: &572 + reason: &575 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *571 + placeholder_id: *574 required: - reason - placeholder_id @@ -83920,7 +84604,7 @@ paths: schema: type: object properties: - reason: *572 + reason: *575 expire_at: type: string format: date-time @@ -83965,8 +84649,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *292 - - *293 + - *295 + - *296 - *67 - name: sort description: The property to sort the results by. @@ -84010,9 +84694,9 @@ paths: application/json: schema: type: array - items: *573 + items: *576 examples: - default: *574 + default: *577 '400': *15 '404': *7 x-github: @@ -84035,8 +84719,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -84109,7 +84793,7 @@ paths: login: type: string description: The username of the user credited. - type: *264 + type: *267 required: - login - type @@ -84196,9 +84880,9 @@ paths: description: Response content: application/json: - schema: *573 + schema: *576 examples: - default: &576 + default: &579 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -84431,8 +85115,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -84536,7 +85220,7 @@ paths: description: Response content: application/json: - schema: *573 + schema: *576 examples: default: value: @@ -84683,17 +85367,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: - - *292 - - *293 - - *575 + - *295 + - *296 + - *578 responses: '200': description: Response content: application/json: - schema: *573 + schema: *576 examples: - default: *576 + default: *579 '403': *29 '404': *7 x-github: @@ -84717,9 +85401,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: - - *292 - - *293 - - *575 + - *295 + - *296 + - *578 requestBody: required: true content: @@ -84792,7 +85476,7 @@ paths: login: type: string description: The username of the user credited. - type: *264 + type: *267 required: - login - type @@ -84878,17 +85562,17 @@ paths: description: Response content: application/json: - schema: *573 + schema: *576 examples: - default: *576 - add_credit: *576 + default: *579 + add_credit: *579 '403': *29 '404': *7 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *124 + schema: *127 examples: invalid_state_transition: value: @@ -84919,11 +85603,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: - - *292 - - *293 - - *575 + - *295 + - *296 + - *578 responses: - '202': *127 + '202': *130 '400': *15 '403': *29 '404': *7 @@ -84948,17 +85632,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: - - *292 - - *293 - - *575 + - *295 + - *296 + - *578 responses: '202': description: Response content: application/json: - schema: *305 + schema: *308 examples: - default: *307 + default: *310 '400': *15 '422': *16 '403': *29 @@ -84984,8 +85668,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -85084,8 +85768,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -85094,7 +85778,7 @@ paths: application/json: schema: type: array - items: &577 + items: &580 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -85106,8 +85790,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *127 - '204': *170 + '202': *130 + '204': *173 '422': description: Repository contains more than 10,000 commits x-github: @@ -85127,8 +85811,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -85176,8 +85860,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *127 - '204': *170 + '202': *130 + '204': *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85204,8 +85888,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -85278,8 +85962,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *127 - '204': *170 + '202': *130 + '204': *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85301,8 +85985,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -85456,8 +86140,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -85467,7 +86151,7 @@ paths: application/json: schema: type: array - items: *577 + items: *580 examples: default: value: @@ -85480,7 +86164,7 @@ paths: - - 0 - 2 - 21 - '204': *170 + '204': *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85500,8 +86184,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *292 - - *293 + - *295 + - *296 - name: sha in: path required: true @@ -85555,7 +86239,7 @@ paths: description: Response content: application/json: - schema: *578 + schema: *581 examples: default: value: @@ -85609,8 +86293,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -85622,7 +86306,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 x-github: @@ -85642,14 +86326,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &579 + schema: &582 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -85717,8 +86401,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: false content: @@ -85744,7 +86428,7 @@ paths: description: Response content: application/json: - schema: *579 + schema: *582 examples: default: value: @@ -85771,8 +86455,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -85792,8 +86476,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -85872,8 +86556,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -85881,7 +86565,7 @@ paths: application/json: schema: type: array - items: &580 + items: &583 title: Tag protection description: Tag protection type: object @@ -85933,8 +86617,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -85957,7 +86641,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *583 examples: default: value: @@ -85988,8 +86672,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: - - *292 - - *293 + - *295 + - *296 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -86026,8 +86710,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *292 - - *293 + - *295 + - *296 - name: ref in: path required: true @@ -86063,8 +86747,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -86074,9 +86758,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - default: *222 + default: *225 headers: Link: *39 '404': *7 @@ -86096,8 +86780,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *292 - - *293 + - *295 + - *296 - *20 - *18 responses: @@ -86105,7 +86789,7 @@ paths: description: Response content: application/json: - schema: &581 + schema: &584 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -86117,7 +86801,7 @@ paths: required: - names examples: - default: &582 + default: &585 value: names: - octocat @@ -86140,8 +86824,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -86172,9 +86856,9 @@ paths: description: Response content: application/json: - schema: *581 + schema: *584 examples: - default: *582 + default: *585 '404': *7 '422': *8 x-github: @@ -86195,9 +86879,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *292 - - *293 - - &583 + - *295 + - *296 + - &586 name: per description: The time frame to display results for. in: query @@ -86226,7 +86910,7 @@ paths: example: 128 clones: type: array - items: &584 + items: &587 title: Traffic type: object properties: @@ -86313,8 +86997,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -86404,8 +87088,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -86465,9 +87149,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *292 - - *293 - - *583 + - *295 + - *296 + - *586 responses: '200': description: Response @@ -86486,7 +87170,7 @@ paths: example: 3782 views: type: array - items: *584 + items: *587 required: - uniques - count @@ -86563,8 +87247,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -86600,7 +87284,7 @@ paths: description: Response content: application/json: - schema: *139 + schema: *142 examples: default: value: @@ -86838,8 +87522,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: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -86862,8 +87546,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -86885,8 +87569,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -86912,8 +87596,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *292 - - *293 + - *295 + - *296 - name: ref in: path required: true @@ -87005,9 +87689,9 @@ paths: description: Response content: application/json: - schema: *305 + schema: *308 examples: - default: *307 + default: *310 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -87048,7 +87732,7 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: default: value: @@ -87161,7 +87845,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &592 + - &595 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -87170,7 +87854,7 @@ paths: schema: type: string example: members - - &597 + - &600 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -87181,7 +87865,7 @@ paths: default: 1 format: int32 example: 1 - - &598 + - &601 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -87223,7 +87907,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &586 + items: &589 allOf: - type: object required: @@ -87298,7 +87982,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: &599 + meta: &602 type: object description: The metadata associated with the creation/updates to the user. @@ -87358,31 +88042,31 @@ paths: location: https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e startIndex: 1 itemsPerPage: 20 - '400': &587 + '400': &590 description: Bad request content: application/json: - schema: *585 + schema: *588 application/scim+json: - schema: *585 - '401': &588 + schema: *588 + '401': &591 description: Authorization failure - '403': &589 + '403': &592 description: Permission denied - '429': &590 + '429': &593 description: Too many requests content: application/json: - schema: *585 + schema: *588 application/scim+json: - schema: *585 - '500': &591 + schema: *588 + '500': &594 description: Internal server error content: application/json: - schema: *585 + schema: *588 application/scim+json: - schema: *585 + schema: *588 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -87409,7 +88093,7 @@ paths: required: true content: application/json: - schema: &595 + schema: &598 type: object required: - schemas @@ -87465,9 +88149,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *586 + schema: *589 examples: - group: &593 + group: &596 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -87486,13 +88170,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': *587 - '401': *588 - '403': *589 - '409': &596 + '400': *590 + '401': *591 + '403': *592 + '409': &599 description: Duplicate record detected - '429': *590 - '500': *591 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -87513,7 +88197,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: - - &594 + - &597 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -87521,22 +88205,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *592 + - *595 - *40 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *586 + schema: *589 examples: - default: *593 - '400': *587 - '401': *588 - '403': *589 + default: *596 + '400': *590 + '401': *591 + '403': *592 '404': *7 - '429': *590 - '500': *591 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -87558,13 +88242,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: - - *594 + - *597 - *40 requestBody: required: true content: application/json: - schema: *595 + schema: *598 examples: group: summary: Group @@ -87590,17 +88274,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *586 + schema: *589 examples: - group: *593 - groupWithMembers: *593 - '400': *587 - '401': *588 - '403': *589 + group: *596 + groupWithMembers: *596 + '400': *590 + '401': *591 + '403': *592 '404': *7 - '409': *596 - '429': *590 - '500': *591 + '409': *599 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -87627,13 +88311,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: - - *594 + - *597 - *40 requestBody: required: true content: application/json: - schema: &606 + schema: &609 type: object required: - Operations @@ -87693,17 +88377,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *586 + schema: *589 examples: - updateGroup: *593 - addMembers: *593 - '400': *587 - '401': *588 - '403': *589 + updateGroup: *596 + addMembers: *596 + '400': *590 + '401': *591 + '403': *592 '404': *7 - '409': *596 - '429': *590 - '500': *591 + '409': *599 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -87723,17 +88407,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: - - *594 + - *597 - *40 responses: '204': description: Group was deleted, no content - '400': *587 - '401': *588 - '403': *589 + '400': *590 + '401': *591 + '403': *592 '404': *7 - '429': *590 - '500': *591 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -87770,8 +88454,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *597 - - *598 + - *600 + - *601 - *40 responses: '200': @@ -87804,7 +88488,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &601 + items: &604 allOf: - type: object required: @@ -87883,7 +88567,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &600 + roles: &603 type: array description: The roles assigned to the user. items: @@ -87939,7 +88623,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *599 + meta: *602 startIndex: type: integer description: A starting index for the returned page @@ -87976,11 +88660,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *587 - '401': *588 - '403': *589 - '429': *590 - '500': *591 + '400': *590 + '401': *591 + '403': *592 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -88007,7 +88691,7 @@ paths: required: true content: application/json: - schema: &604 + schema: &607 type: object required: - schemas @@ -88089,9 +88773,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *600 + roles: *603 examples: - user: &605 + user: &608 summary: User value: schemas: @@ -88138,9 +88822,9 @@ paths: description: User has been created content: application/scim+json: - schema: *601 + schema: *604 examples: - user: &602 + user: &605 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -88166,13 +88850,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: *602 - '400': *587 - '401': *588 - '403': *589 - '409': *596 - '429': *590 - '500': *591 + enterpriseOwner: *605 + '400': *590 + '401': *591 + '403': *592 + '409': *599 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -88193,7 +88877,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: - - &603 + - &606 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -88206,15 +88890,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *601 + schema: *604 examples: - default: *602 - '400': *587 - '401': *588 - '403': *589 + default: *605 + '400': *590 + '401': *591 + '403': *592 '404': *7 - '429': *590 - '500': *591 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -88239,30 +88923,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: - - *603 + - *606 - *40 requestBody: required: true content: application/json: - schema: *604 + schema: *607 examples: - user: *605 + user: *608 responses: '200': description: User was updated content: application/scim+json: - schema: *601 + schema: *604 examples: - user: *602 - '400': *587 - '401': *588 - '403': *589 + user: *605 + '400': *590 + '401': *591 + '403': *592 '404': *7 - '409': *596 - '429': *590 - '500': *591 + '409': *599 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -88300,13 +88984,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: - - *603 + - *606 - *40 requestBody: required: true content: application/json: - schema: *606 + schema: *609 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -88346,18 +89030,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *601 - examples: - userMultiValuedProperties: *602 - userSingleValuedProperties: *602 - disableUser: *602 - '400': *587 - '401': *588 - '403': *589 + schema: *604 + examples: + userMultiValuedProperties: *605 + userSingleValuedProperties: *605 + disableUser: *605 + '400': *590 + '401': *591 + '403': *592 '404': *7 - '409': *596 - '429': *590 - '500': *591 + '409': *599 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -88377,17 +89061,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: - - *603 + - *606 - *40 responses: '204': description: User was deleted, no content - '400': *587 - '401': *588 - '403': *589 + '400': *590 + '401': *591 + '403': *592 '404': *7 - '429': *590 - '500': *591 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -88420,7 +89104,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *121 + - *124 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -88474,7 +89158,7 @@ paths: example: 1 Resources: type: array - items: &607 + items: &610 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -88705,22 +89389,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *37 - '404': &608 + '404': &611 description: Resource not found content: application/json: - schema: *585 + schema: *588 application/scim+json: - schema: *585 - '403': &609 + schema: *588 + '403': &612 description: Forbidden content: application/json: - schema: *585 + schema: *588 application/scim+json: - schema: *585 - '400': *587 - '429': *590 + schema: *588 + '400': *590 + '429': *593 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -88740,15 +89424,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *121 + - *124 responses: '201': description: Response content: application/scim+json: - schema: *607 + schema: *610 examples: - default: &610 + default: &613 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -88771,17 +89455,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *37 - '404': *608 - '403': *609 - '500': *591 + '404': *611 + '403': *612 + '500': *594 '409': description: Conflict content: application/json: - schema: *585 + schema: *588 application/scim+json: - schema: *585 - '400': *587 + schema: *588 + '400': *590 requestBody: required: true content: @@ -88873,18 +89557,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: - - *121 - - *603 + - *124 + - *606 responses: '200': description: Response content: application/scim+json: - schema: *607 + schema: *610 examples: - default: *610 - '404': *608 - '403': *609 + default: *613 + '404': *611 + '403': *612 '304': *37 x-github: githubCloudOnly: true @@ -88907,19 +89591,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *121 - - *603 + - *124 + - *606 responses: '200': description: Response content: application/scim+json: - schema: *607 + schema: *610 examples: - default: *610 + default: *613 '304': *37 - '404': *608 - '403': *609 + '404': *611 + '403': *612 requestBody: required: true content: @@ -89027,20 +89711,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: - - *121 - - *603 + - *124 + - *606 responses: '200': description: Response content: application/scim+json: - schema: *607 + schema: *610 examples: - default: *610 + default: *613 '304': *37 - '404': *608 - '403': *609 - '400': *587 + '404': *611 + '403': *612 + '400': *590 '429': description: Response content: @@ -89130,13 +89814,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: - - *121 - - *603 + - *124 + - *606 responses: '204': description: Response - '404': *608 - '403': *609 + '404': *611 + '403': *612 '304': *37 x-github: githubCloudOnly: true @@ -89251,7 +89935,7 @@ paths: html_url: type: string format: uri - repository: *139 + repository: *142 score: type: number file_size: @@ -89269,7 +89953,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &611 + text_matches: &614 title: Search Result Text Matches type: array items: @@ -89432,7 +90116,7 @@ paths: enum: - author-date - committer-date - - &612 + - &615 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 @@ -89503,7 +90187,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *349 + properties: *352 nullable: true comment_count: type: integer @@ -89523,7 +90207,7 @@ paths: url: type: string format: uri - verification: *460 + verification: *463 required: - author - committer @@ -89542,7 +90226,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *349 + properties: *352 nullable: true parents: type: array @@ -89555,12 +90239,12 @@ paths: type: string sha: type: string - repository: *139 + repository: *142 score: type: number node_id: type: string - text_matches: *611 + text_matches: *614 required: - sha - node_id @@ -89753,7 +90437,7 @@ paths: - interactions - created - updated - - *612 + - *615 - *18 - *20 responses: @@ -89858,8 +90542,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *412 - required: *413 + properties: *415 + required: *416 nullable: true comments: type: integer @@ -89873,7 +90557,7 @@ paths: type: string format: date-time nullable: true - text_matches: *611 + text_matches: *614 pull_request: type: object properties: @@ -89906,7 +90590,7 @@ paths: type: string score: type: number - author_association: *91 + author_association: *94 draft: type: boolean repository: *57 @@ -89926,9 +90610,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 - reactions: *92 + properties: *92 + required: *93 + reactions: *95 required: - assignee - closed_at @@ -90097,7 +90781,7 @@ paths: enum: - created - updated - - *612 + - *615 - *18 - *20 responses: @@ -90141,7 +90825,7 @@ paths: nullable: true score: type: number - text_matches: *611 + text_matches: *614 required: - id - node_id @@ -90227,7 +90911,7 @@ paths: - forks - help-wanted-issues - updated - - *612 + - *615 - *18 - *20 responses: @@ -90446,8 +91130,8 @@ paths: title: License Simple description: License Simple type: object - properties: *105 - required: *106 + properties: *108 + required: *109 nullable: true permissions: type: object @@ -90466,7 +91150,7 @@ paths: - admin - pull - push - text_matches: *611 + text_matches: *614 temp_clone_token: type: string allow_merge_commit: @@ -90767,7 +91451,7 @@ paths: type: string format: uri nullable: true - text_matches: *611 + text_matches: *614 related: type: array nullable: true @@ -90960,7 +91644,7 @@ paths: - followers - repositories - joined - - *612 + - *615 - *18 - *20 responses: @@ -91064,7 +91748,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *611 + text_matches: *614 blog: type: string nullable: true @@ -91143,7 +91827,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &613 + - &616 name: team_id description: The unique identifier of the team. in: path @@ -91155,9 +91839,9 @@ paths: description: Response content: application/json: - schema: *273 + schema: *276 examples: - default: *274 + default: *277 '404': *7 x-github: githubCloudOnly: false @@ -91184,7 +91868,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *613 + - *616 requestBody: required: true content: @@ -91247,16 +91931,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *273 + schema: *276 examples: - default: *274 + default: *277 '201': description: Response content: application/json: - schema: *273 + schema: *276 examples: - default: *274 + default: *277 '404': *7 '422': *16 '403': *29 @@ -91284,7 +91968,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *613 + - *616 responses: '204': description: Response @@ -91315,7 +91999,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *613 + - *616 - *67 - *18 - *20 @@ -91326,9 +92010,9 @@ paths: application/json: schema: type: array - items: *275 + items: *278 examples: - default: *614 + default: *617 headers: Link: *39 x-github: @@ -91357,7 +92041,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *613 + - *616 requestBody: required: true content: @@ -91391,9 +92075,9 @@ paths: description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: *276 + default: *279 x-github: triggersNotification: true githubCloudOnly: false @@ -91420,16 +92104,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *613 - - *277 + - *616 + - *280 responses: '200': description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: *276 + default: *279 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91454,8 +92138,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *613 - - *277 + - *616 + - *280 requestBody: required: false content: @@ -91478,9 +92162,9 @@ paths: description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: *615 + default: *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91505,8 +92189,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *613 - - *277 + - *616 + - *280 responses: '204': description: Response @@ -91535,8 +92219,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *613 - - *277 + - *616 + - *280 - *67 - *18 - *20 @@ -91547,9 +92231,9 @@ paths: application/json: schema: type: array - items: *278 + items: *281 examples: - default: *616 + default: *619 headers: Link: *39 x-github: @@ -91578,8 +92262,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *613 - - *277 + - *616 + - *280 requestBody: required: true content: @@ -91601,9 +92285,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *281 examples: - default: *279 + default: *282 x-github: triggersNotification: true githubCloudOnly: false @@ -91630,17 +92314,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *613 - - *277 + - *616 - *280 + - *283 responses: '200': description: Response content: application/json: - schema: *278 + schema: *281 examples: - default: *279 + default: *282 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91665,9 +92349,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *613 - - *277 + - *616 - *280 + - *283 requestBody: required: true content: @@ -91689,9 +92373,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *281 examples: - default: *617 + default: *620 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91716,9 +92400,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *613 - - *277 + - *616 - *280 + - *283 responses: '204': description: Response @@ -91747,9 +92431,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: - - *613 - - *277 + - *616 - *280 + - *283 - 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. @@ -91775,9 +92459,9 @@ paths: application/json: schema: type: array - items: *281 + items: *284 examples: - default: *283 + default: *286 headers: Link: *39 x-github: @@ -91806,9 +92490,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: - - *613 - - *277 + - *616 - *280 + - *283 requestBody: required: true content: @@ -91840,9 +92524,9 @@ paths: description: Response content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91868,8 +92552,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: - - *613 - - *277 + - *616 + - *280 - 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. @@ -91895,9 +92579,9 @@ paths: application/json: schema: type: array - items: *281 + items: *284 examples: - default: *283 + default: *286 headers: Link: *39 x-github: @@ -91926,8 +92610,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: - - *613 - - *277 + - *616 + - *280 requestBody: required: true content: @@ -91959,9 +92643,9 @@ paths: description: Response content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -91985,7 +92669,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *613 + - *616 - *18 - *20 responses: @@ -91995,9 +92679,9 @@ paths: application/json: schema: type: array - items: *204 + items: *207 examples: - default: *205 + default: *208 headers: Link: *39 x-github: @@ -92023,7 +92707,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *613 + - *616 - name: role description: Filters members returned by their role in the team. in: query @@ -92046,7 +92730,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 '404': *7 @@ -92074,8 +92758,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *613 - - *161 + - *616 + - *164 responses: '204': description: if user is a member @@ -92111,8 +92795,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *613 - - *161 + - *616 + - *164 responses: '204': description: Response @@ -92151,8 +92835,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *613 - - *161 + - *616 + - *164 responses: '204': description: Response @@ -92188,16 +92872,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: - - *613 - - *161 + - *616 + - *164 responses: '200': description: Response content: application/json: - schema: *289 + schema: *292 examples: - response-if-user-is-a-team-maintainer: *618 + response-if-user-is-a-team-maintainer: *621 '404': *7 x-github: githubCloudOnly: false @@ -92230,8 +92914,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: - - *613 - - *161 + - *616 + - *164 requestBody: required: false content: @@ -92256,9 +92940,9 @@ paths: description: Response content: application/json: - schema: *289 + schema: *292 examples: - response-if-users-membership-with-team-is-now-pending: *619 + response-if-users-membership-with-team-is-now-pending: *622 '403': description: Forbidden if team synchronization is set up '422': @@ -92292,8 +92976,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: - - *613 - - *161 + - *616 + - *164 responses: '204': description: Response @@ -92322,7 +93006,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *613 + - *616 - *18 - *20 responses: @@ -92332,9 +93016,9 @@ paths: application/json: schema: type: array - items: *290 + items: *293 examples: - default: *620 + default: *623 headers: Link: *39 '404': *7 @@ -92361,16 +93045,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: - - *613 - - *291 + - *616 + - *294 responses: '200': description: Response content: application/json: - schema: *290 + schema: *293 examples: - default: *621 + default: *624 '404': description: Not Found if project is not managed by this team x-github: @@ -92395,8 +93079,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: - - *613 - - *291 + - *616 + - *294 requestBody: required: false content: @@ -92464,8 +93148,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: - - *613 - - *291 + - *616 + - *294 responses: '204': description: Response @@ -92492,7 +93176,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *613 + - *616 - *18 - *20 responses: @@ -92502,9 +93186,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 '404': *7 @@ -92534,15 +93218,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: - - *613 - - *292 - - *293 + - *616 + - *295 + - *296 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *622 + schema: *625 examples: alternative-response-with-extra-repository-information: value: @@ -92693,9 +93377,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: - - *613 - - *292 - - *293 + - *616 + - *295 + - *296 requestBody: required: false content: @@ -92745,9 +93429,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: - - *613 - - *292 - - *293 + - *616 + - *295 + - *296 responses: '204': description: Response @@ -92776,15 +93460,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: - - *613 + - *616 responses: '200': description: Response content: application/json: - schema: *294 + schema: *297 examples: - default: *295 + default: *298 '403': *29 '404': *7 x-github: @@ -92811,7 +93495,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: - - *613 + - *616 requestBody: required: true content: @@ -92868,7 +93552,7 @@ paths: description: Response content: application/json: - schema: *294 + schema: *297 examples: default: value: @@ -92899,7 +93583,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *613 + - *616 - *18 - *20 responses: @@ -92909,9 +93593,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - response-if-child-teams-exist: *623 + response-if-child-teams-exist: *626 headers: Link: *39 '404': *7 @@ -92944,7 +93628,7 @@ paths: application/json: schema: oneOf: - - &625 + - &628 title: Private User description: Private User type: object @@ -93147,7 +93831,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *624 + - *627 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -93300,7 +93984,7 @@ paths: description: Response content: application/json: - schema: *625 + schema: *628 examples: default: value: @@ -93379,7 +94063,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 '304': *37 '404': *7 '403': *29 @@ -93402,7 +94086,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: - - *161 + - *164 responses: '204': description: If the user is blocked @@ -93430,7 +94114,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *161 + - *164 responses: '204': description: Response @@ -93454,7 +94138,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *161 + - *164 responses: '204': description: Response @@ -93503,9 +94187,9 @@ paths: type: integer codespaces: type: array - items: *211 + items: *214 examples: - default: *212 + default: *215 '304': *37 '500': *73 '401': *25 @@ -93644,17 +94328,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '401': *25 '403': *29 '404': *7 @@ -93698,7 +94382,7 @@ paths: type: integer secrets: type: array - items: &626 + items: &629 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -93738,7 +94422,7 @@ paths: - visibility - selected_repositories_url examples: - default: *400 + default: *403 headers: Link: *39 x-github: @@ -93808,13 +94492,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: - - *149 + - *152 responses: '200': description: Response content: application/json: - schema: *626 + schema: *629 examples: default: value: @@ -93844,7 +94528,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: - - *149 + - *152 requestBody: required: true content: @@ -93889,7 +94573,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -93917,7 +94601,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: - - *149 + - *152 responses: '204': description: Response @@ -93942,7 +94626,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: - - *149 + - *152 responses: '200': description: Response @@ -93958,9 +94642,9 @@ paths: type: integer repositories: type: array - items: *139 + items: *142 examples: - default: *627 + default: *630 '401': *25 '403': *29 '404': *7 @@ -93985,7 +94669,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: - - *149 + - *152 requestBody: required: true content: @@ -94039,7 +94723,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: - - *149 + - *152 - name: repository_id in: path required: true @@ -94072,7 +94756,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: - - *149 + - *152 - name: repository_id in: path required: true @@ -94104,15 +94788,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: - - *213 + - *216 responses: '200': description: Response content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '304': *37 '500': *73 '401': *25 @@ -94138,7 +94822,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: - - *213 + - *216 requestBody: required: false content: @@ -94168,9 +94852,9 @@ paths: description: Response content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '401': *25 '403': *29 '404': *7 @@ -94192,9 +94876,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: - - *213 + - *216 responses: - '202': *127 + '202': *130 '304': *37 '500': *73 '401': *25 @@ -94221,13 +94905,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: - - *213 + - *216 responses: '202': description: Response content: application/json: - schema: &628 + schema: &631 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -94268,7 +94952,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &629 + default: &632 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -94300,7 +94984,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *213 + - *216 - name: export_id in: path required: true @@ -94313,9 +94997,9 @@ paths: description: Response content: application/json: - schema: *628 + schema: *631 examples: - default: *629 + default: *632 '404': *7 x-github: githubCloudOnly: false @@ -94336,7 +95020,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *213 + - *216 responses: '200': description: Response @@ -94352,9 +95036,9 @@ paths: type: integer machines: type: array - items: *630 + items: *633 examples: - default: *631 + default: *634 '304': *37 '500': *73 '401': *25 @@ -94383,7 +95067,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: - - *213 + - *216 requestBody: required: true content: @@ -94433,13 +95117,13 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *305 + repository: *308 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *398 - required: *399 + properties: *401 + required: *402 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -95213,15 +95897,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: - - *213 + - *216 responses: '200': description: Response content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '304': *37 '500': *73 '400': *15 @@ -95233,7 +95917,7 @@ paths: schema: *3 '403': *29 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95253,15 +95937,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: - - *213 + - *216 responses: '200': description: Response content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '500': *73 '401': *25 '403': *29 @@ -95291,9 +95975,9 @@ paths: application/json: schema: type: array - items: *223 + items: *226 examples: - default: &644 + default: &647 value: - id: 197 name: hello_docker @@ -95394,7 +96078,7 @@ paths: application/json: schema: type: array - items: &632 + items: &635 title: Email description: Email type: object @@ -95459,9 +96143,9 @@ paths: application/json: schema: type: array - items: *632 + items: *635 examples: - default: &646 + default: &649 value: - email: octocat@github.com verified: true @@ -95536,7 +96220,7 @@ paths: application/json: schema: type: array - items: *632 + items: *635 examples: default: value: @@ -95646,7 +96330,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 '304': *37 @@ -95679,7 +96363,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 '304': *37 @@ -95701,7 +96385,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: - - *161 + - *164 responses: '204': description: if the person is followed by the authenticated user @@ -95731,7 +96415,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *161 + - *164 responses: '204': description: Response @@ -95755,7 +96439,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *161 + - *164 responses: '204': description: Response @@ -95791,7 +96475,7 @@ paths: application/json: schema: type: array - items: &633 + items: &636 title: GPG Key description: A unique encryption key type: object @@ -95922,7 +96606,7 @@ paths: - subkeys - revoked examples: - default: &657 + default: &660 value: - id: 3 name: Octocat's GPG Key @@ -96007,9 +96691,9 @@ paths: description: Response content: application/json: - schema: *633 + schema: *636 examples: - default: &634 + default: &637 value: id: 3 name: Octocat's GPG Key @@ -96066,7 +96750,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: - - &635 + - &638 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -96078,9 +96762,9 @@ paths: description: Response content: application/json: - schema: *633 + schema: *636 examples: - default: *634 + default: *637 '404': *7 '304': *37 '403': *29 @@ -96103,7 +96787,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: - - *635 + - *638 responses: '204': description: Response @@ -96294,7 +96978,7 @@ paths: type: array items: *57 examples: - default: *636 + default: *639 headers: Link: *39 '404': *7 @@ -96319,7 +97003,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *134 + - *137 responses: '204': description: Response @@ -96345,7 +97029,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *134 + - *137 responses: '204': description: Response @@ -96379,12 +97063,12 @@ paths: application/json: schema: anyOf: - - *202 + - *205 - type: object properties: {} additionalProperties: false examples: - default: *203 + default: *206 '204': description: Response when there are no restrictions x-github: @@ -96408,7 +97092,7 @@ paths: required: true content: application/json: - schema: *471 + schema: *474 examples: default: value: @@ -96419,7 +97103,7 @@ paths: description: Response content: application/json: - schema: *202 + schema: *205 examples: default: value: @@ -96500,7 +97184,7 @@ paths: - closed - all default: open - - *208 + - *211 - name: sort description: What to sort results by. in: query @@ -96513,7 +97197,7 @@ paths: - comments default: created - *67 - - *94 + - *97 - *18 - *20 responses: @@ -96523,9 +97207,9 @@ paths: application/json: schema: type: array - items: *104 + items: *107 examples: - default: *209 + default: *212 headers: Link: *39 '404': *7 @@ -96558,7 +97242,7 @@ paths: application/json: schema: type: array - items: &637 + items: &640 title: Key description: Key type: object @@ -96655,9 +97339,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *640 examples: - default: &638 + default: &641 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -96690,15 +97374,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: - - *499 + - *502 responses: '200': description: Response content: application/json: - schema: *637 + schema: *640 examples: - default: *638 + default: *641 '404': *7 '304': *37 '403': *29 @@ -96721,7 +97405,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: - - *499 + - *502 responses: '204': description: Response @@ -96754,7 +97438,7 @@ paths: application/json: schema: type: array - items: &639 + items: &642 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -96811,7 +97495,7 @@ paths: - id - type - login - plan: *108 + plan: *111 required: - billing_cycle - next_billing_date @@ -96822,7 +97506,7 @@ paths: - account - plan examples: - default: &640 + default: &643 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -96884,9 +97568,9 @@ paths: application/json: schema: type: array - items: *639 + items: *642 examples: - default: *640 + default: *643 headers: Link: *39 '304': *37 @@ -96926,7 +97610,7 @@ paths: application/json: schema: type: array - items: *214 + items: *217 examples: default: value: @@ -97028,13 +97712,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: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: *214 + schema: *217 examples: default: value: @@ -97092,7 +97776,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: - - *121 + - *124 requestBody: required: true content: @@ -97117,7 +97801,7 @@ paths: description: Response content: application/json: - schema: *214 + schema: *217 examples: default: value: @@ -97185,7 +97869,7 @@ paths: application/json: schema: type: array - items: *216 + items: *219 examples: default: value: @@ -97438,7 +98122,7 @@ paths: description: Response content: application/json: - schema: *216 + schema: *219 examples: default: value: @@ -97618,7 +98302,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *217 + - *220 - name: exclude in: query required: false @@ -97631,7 +98315,7 @@ paths: description: Response content: application/json: - schema: *216 + schema: *219 examples: default: value: @@ -97825,7 +98509,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *217 + - *220 responses: '302': description: Response @@ -97851,7 +98535,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *217 + - *220 responses: '204': description: Response @@ -97880,8 +98564,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *217 - - *641 + - *220 + - *644 responses: '204': description: Response @@ -97905,7 +98589,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *217 + - *220 - *18 - *20 responses: @@ -97915,9 +98599,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 '404': *7 @@ -97954,7 +98638,7 @@ paths: type: array items: *52 examples: - default: *642 + default: *645 headers: Link: *39 '304': *37 @@ -97996,7 +98680,7 @@ paths: - docker - nuget - container - - *643 + - *646 - *20 - *18 responses: @@ -98006,10 +98690,10 @@ paths: application/json: schema: type: array - items: *223 + items: *226 examples: - default: *644 - '400': *645 + default: *647 + '400': *648 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98029,16 +98713,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: - - *225 - - *226 + - *228 + - *229 responses: '200': description: Response content: application/json: - schema: *223 + schema: *226 examples: - default: &658 + default: &661 value: id: 40201 name: octo-name @@ -98151,8 +98835,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: - - *225 - - *226 + - *228 + - *229 responses: '204': description: Response @@ -98182,8 +98866,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: - - *225 - - *226 + - *228 + - *229 - name: token description: package token schema: @@ -98215,8 +98899,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: - - *225 - - *226 + - *228 + - *229 - *20 - *18 - name: state @@ -98236,7 +98920,7 @@ paths: application/json: schema: type: array - items: *227 + items: *230 examples: default: value: @@ -98285,15 +98969,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: - - *225 - - *226 - *228 + - *229 + - *231 responses: '200': description: Response content: application/json: - schema: *227 + schema: *230 examples: default: value: @@ -98329,9 +99013,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: - - *225 - - *226 - *228 + - *229 + - *231 responses: '204': description: Response @@ -98361,9 +99045,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: - - *225 - - *226 - *228 + - *229 + - *231 responses: '204': description: Response @@ -98419,7 +99103,7 @@ paths: description: Response content: application/json: - schema: *236 + schema: *239 examples: default: value: @@ -98488,9 +99172,9 @@ paths: application/json: schema: type: array - items: *632 + items: *635 examples: - default: *646 + default: *649 headers: Link: *39 '304': *37 @@ -98603,7 +99287,7 @@ paths: type: array items: *57 examples: - default: &653 + default: &656 summary: Default response value: - id: 1296269 @@ -98905,9 +99589,9 @@ paths: description: Response content: application/json: - schema: *305 + schema: *308 examples: - default: *307 + default: *310 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -98945,9 +99629,9 @@ paths: application/json: schema: type: array - items: *473 + items: *476 examples: - default: *647 + default: *650 headers: Link: *39 '304': *37 @@ -98970,12 +99654,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *206 + - *209 responses: '204': description: Response '403': *29 - '409': *126 + '409': *129 '404': *7 '304': *37 x-github: @@ -98993,11 +99677,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *206 + - *209 responses: '204': description: Response - '409': *126 + '409': *129 '304': *37 '404': *7 '403': *29 @@ -99026,7 +99710,7 @@ paths: application/json: schema: type: array - items: &648 + items: &651 title: Social account description: Social media account type: object @@ -99041,7 +99725,7 @@ paths: - provider - url examples: - default: &649 + default: &652 value: - provider: twitter url: https://twitter.com/github @@ -99103,9 +99787,9 @@ paths: application/json: schema: type: array - items: *648 + items: *651 examples: - default: *649 + default: *652 '422': *16 '304': *37 '404': *7 @@ -99192,7 +99876,7 @@ paths: application/json: schema: type: array - items: &650 + items: &653 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -99212,7 +99896,7 @@ paths: - title - created_at examples: - default: &659 + default: &662 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -99278,9 +99962,9 @@ paths: description: Response content: application/json: - schema: *650 + schema: *653 examples: - default: &651 + default: &654 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -99311,7 +99995,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: - - &652 + - &655 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -99323,9 +100007,9 @@ paths: description: Response content: application/json: - schema: *650 + schema: *653 examples: - default: *651 + default: *654 '404': *7 '304': *37 '403': *29 @@ -99348,7 +100032,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: - - *652 + - *655 responses: '204': description: Response @@ -99377,7 +100061,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: - - &660 + - &663 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 @@ -99402,11 +100086,11 @@ paths: type: array items: *57 examples: - default-response: *653 + default-response: *656 application/vnd.github.v3.star+json: schema: type: array - items: &661 + items: &664 title: Starred Repository description: Starred Repository type: object @@ -99562,8 +100246,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: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response if this repository is starred by you @@ -99591,8 +100275,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: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -99616,8 +100300,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: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -99650,9 +100334,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 '304': *37 @@ -99689,7 +100373,7 @@ paths: application/json: schema: type: array - items: *273 + items: *276 examples: default: value: @@ -99765,7 +100449,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *110 + - *113 responses: '200': description: Response @@ -99773,10 +100457,10 @@ paths: application/json: schema: oneOf: - - *625 - - *624 + - *628 + - *627 examples: - default-response: &655 + default-response: &658 summary: Default response value: login: octocat @@ -99811,7 +100495,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &656 + response-with-git-hub-plan-information: &659 summary: Response with GitHub plan information value: login: octocat @@ -99871,7 +100555,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *654 + - *657 - *18 responses: '200': @@ -99882,7 +100566,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: example: ; rel="next" @@ -99910,7 +100594,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *161 + - *164 responses: '200': description: Response @@ -99918,11 +100602,11 @@ paths: application/json: schema: oneOf: - - *625 - - *624 + - *628 + - *627 examples: - default-response: *655 - response-with-git-hub-plan-information: *656 + default-response: *658 + response-with-git-hub-plan-information: *659 '404': *7 x-github: githubCloudOnly: false @@ -99948,7 +100632,7 @@ paths: - *18 - *65 - *66 - - *161 + - *164 - name: subject_digest description: Subject Digest in: path @@ -100048,7 +100732,7 @@ paths: description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -100074,7 +100758,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: - - *161 + - *164 responses: '200': description: Response @@ -100082,9 +100766,9 @@ paths: application/json: schema: type: array - items: *223 + items: *226 examples: - default: *644 + default: *647 '403': *29 '401': *25 x-github: @@ -100107,7 +100791,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *161 + - *164 - *18 - *20 responses: @@ -100117,7 +100801,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: default: value: @@ -100188,8 +100872,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: - - *161 - - *121 + - *164 + - *124 - *18 - *20 responses: @@ -100199,7 +100883,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: default: value: @@ -100278,7 +100962,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *161 + - *164 - *18 - *20 responses: @@ -100288,7 +100972,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: default: value: @@ -100355,7 +101039,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *161 + - *164 - *18 - *20 responses: @@ -100367,7 +101051,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 x-github: @@ -100386,7 +101070,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *161 + - *164 - *18 - *20 responses: @@ -100398,7 +101082,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 x-github: @@ -100417,7 +101101,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: - - *161 + - *164 - name: target_user in: path required: true @@ -100444,8 +101128,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *161 - - *94 + - *164 + - *97 - *18 - *20 responses: @@ -100455,9 +101139,9 @@ paths: application/json: schema: type: array - items: *95 + items: *98 examples: - default: *96 + default: *99 headers: Link: *39 '422': *16 @@ -100478,7 +101162,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: - - *161 + - *164 - *18 - *20 responses: @@ -100488,9 +101172,9 @@ paths: application/json: schema: type: array - items: *633 + items: *636 examples: - default: *657 + default: *660 headers: Link: *39 x-github: @@ -100514,7 +101198,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *161 + - *164 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -100586,7 +101270,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: - - *161 + - *164 responses: '200': description: Response @@ -100594,7 +101278,7 @@ paths: application/json: schema: *22 examples: - default: *470 + default: *473 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100612,7 +101296,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *161 + - *164 - *18 - *20 responses: @@ -100660,7 +101344,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *161 + - *164 - *18 - *20 responses: @@ -100672,7 +101356,7 @@ paths: type: array items: *52 examples: - default: *642 + default: *645 headers: Link: *39 x-github: @@ -100711,8 +101395,8 @@ paths: - docker - nuget - container - - *643 - - *161 + - *646 + - *164 - *20 - *18 responses: @@ -100722,12 +101406,12 @@ paths: application/json: schema: type: array - items: *223 + items: *226 examples: - default: *644 + default: *647 '403': *29 '401': *25 - '400': *645 + '400': *648 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100747,17 +101431,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *225 - - *226 - - *161 + - *228 + - *229 + - *164 responses: '200': description: Response content: application/json: - schema: *223 + schema: *226 examples: - default: *658 + default: *661 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100778,9 +101462,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *225 - - *226 - - *161 + - *228 + - *229 + - *164 responses: '204': description: Response @@ -100812,9 +101496,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *225 - - *226 - - *161 + - *228 + - *229 + - *164 - name: token description: package token schema: @@ -100846,9 +101530,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: - - *225 - - *226 - - *161 + - *228 + - *229 + - *164 responses: '200': description: Response @@ -100856,7 +101540,7 @@ paths: application/json: schema: type: array - items: *227 + items: *230 examples: default: value: @@ -100914,16 +101598,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: - - *225 - - *226 - *228 - - *161 + - *229 + - *231 + - *164 responses: '200': description: Response content: application/json: - schema: *227 + schema: *230 examples: default: value: @@ -100958,10 +101642,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *225 - - *226 - - *161 - *228 + - *229 + - *164 + - *231 responses: '204': description: Response @@ -100993,10 +101677,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *225 - - *226 - - *161 - *228 + - *229 + - *164 + - *231 responses: '204': description: Response @@ -101019,7 +101703,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-user-projects parameters: - - *161 + - *164 - name: state description: Indicates the state of the projects to return. in: query @@ -101040,7 +101724,7 @@ paths: application/json: schema: type: array - items: *236 + items: *239 examples: default: value: @@ -101099,7 +101783,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: - - *161 + - *164 - *18 - *20 responses: @@ -101109,7 +101793,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: default: value: @@ -101188,7 +101872,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: - - *161 + - *164 - *18 - *20 responses: @@ -101198,7 +101882,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: default: value: @@ -101275,7 +101959,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *161 + - *164 - name: type description: Limit results to repositories of the specified type. in: query @@ -101318,9 +102002,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 x-github: @@ -101344,15 +102028,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: - - *161 + - *164 responses: '200': description: Response content: application/json: - schema: *265 + schema: *268 examples: - default: *266 + default: *269 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -101374,15 +102058,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: - - *161 + - *164 responses: '200': description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -101404,15 +102088,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: - - *161 + - *164 responses: '200': description: Response content: application/json: - schema: *271 + schema: *274 examples: - default: *272 + default: *275 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -101430,7 +102114,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: - - *161 + - *164 - *18 - *20 responses: @@ -101440,9 +102124,9 @@ paths: application/json: schema: type: array - items: *648 + items: *651 examples: - default: *649 + default: *652 headers: Link: *39 x-github: @@ -101462,7 +102146,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: - - *161 + - *164 - *18 - *20 responses: @@ -101472,9 +102156,9 @@ paths: application/json: schema: type: array - items: *650 + items: *653 examples: - default: *659 + default: *662 headers: Link: *39 x-github: @@ -101498,8 +102182,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *161 - - *660 + - *164 + - *663 - *67 - *18 - *20 @@ -101511,11 +102195,11 @@ paths: schema: anyOf: - type: array - items: *661 + items: *664 - type: array items: *57 examples: - default-response: *653 + default-response: *656 headers: Link: *39 x-github: @@ -101534,7 +102218,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *161 + - *164 - *18 - *20 responses: @@ -101544,9 +102228,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 x-github: @@ -101674,7 +102358,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &662 + enterprise: &665 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -101732,7 +102416,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &663 + installation: &666 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -101751,7 +102435,7 @@ x-webhooks: required: - id - node_id - organization: &664 + organization: &667 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -101811,13 +102495,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &665 + repository: &668 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &702 + properties: &705 id: description: Unique identifier of the repository example: 42 @@ -101837,8 +102521,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *105 - required: *106 + properties: *108 + required: *109 nullable: true organization: title: Simple User @@ -102500,7 +103184,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &703 + required: &706 - archive_url - assignees_url - blobs_url @@ -102651,10 +103335,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -102730,11 +103414,11 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - rule: &666 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + rule: &669 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) @@ -102957,11 +103641,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - rule: *666 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + rule: *669 sender: *19 required: - action @@ -103144,11 +103828,11 @@ x-webhooks: - everyone required: - from - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - rule: *666 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + rule: *669 sender: *19 required: - action @@ -103221,7 +103905,7 @@ x-webhooks: required: true content: application/json: - schema: &669 + schema: &672 title: Exemption request cancellation event type: object properties: @@ -103229,11 +103913,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - exemption_request: &667 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + exemption_request: &670 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -103369,7 +104053,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &668 + items: &671 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -103474,7 +104158,7 @@ x-webhooks: required: true content: application/json: - schema: &670 + schema: &673 title: Exemption request completed event type: object properties: @@ -103482,11 +104166,11 @@ x-webhooks: type: string enum: - completed - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - exemption_request: *667 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + exemption_request: *670 sender: *19 required: - action @@ -103558,7 +104242,7 @@ x-webhooks: required: true content: application/json: - schema: &671 + schema: &674 title: Exemption request created event type: object properties: @@ -103566,11 +104250,11 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - exemption_request: *667 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + exemption_request: *670 sender: *19 required: - action @@ -103642,7 +104326,7 @@ x-webhooks: required: true content: application/json: - schema: &672 + schema: &675 title: Exemption response dismissed event type: object properties: @@ -103650,12 +104334,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - exemption_request: *667 - exemption_response: *668 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + exemption_request: *670 + exemption_response: *671 sender: *19 required: - action @@ -103729,7 +104413,7 @@ x-webhooks: required: true content: application/json: - schema: &673 + schema: &676 title: Exemption response submitted event type: object properties: @@ -103737,12 +104421,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - exemption_request: *667 - exemption_response: *668 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + exemption_request: *670 + exemption_response: *671 sender: *19 required: - action @@ -103815,7 +104499,7 @@ x-webhooks: required: true content: application/json: - schema: *669 + schema: *672 responses: '200': description: Return a 200 status to indicate that the data was received @@ -103882,7 +104566,7 @@ x-webhooks: required: true content: application/json: - schema: *670 + schema: *673 responses: '200': description: Return a 200 status to indicate that the data was received @@ -103949,7 +104633,7 @@ x-webhooks: required: true content: application/json: - schema: *671 + schema: *674 responses: '200': description: Return a 200 status to indicate that the data was received @@ -104016,7 +104700,7 @@ x-webhooks: required: true content: application/json: - schema: *672 + schema: *675 responses: '200': description: Return a 200 status to indicate that the data was received @@ -104084,7 +104768,7 @@ x-webhooks: required: true content: application/json: - schema: *673 + schema: *676 responses: '200': description: Return a 200 status to indicate that the data was received @@ -104162,7 +104846,7 @@ x-webhooks: type: string enum: - completed - check_run: &675 + check_run: &678 title: CheckRun description: A check performed on the code of a given code change type: object @@ -104176,8 +104860,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 check_suite: description: A suite of checks performed on the code of a given code change @@ -104225,8 +104909,8 @@ x-webhooks: type: string pull_requests: type: array - items: *362 - repository: *139 + items: *365 + repository: *142 status: example: completed type: string @@ -104263,7 +104947,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *674 + deployment: *677 details_url: example: https://example.com type: string @@ -104313,7 +104997,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *362 + items: *365 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -104348,9 +105032,9 @@ x-webhooks: - output - app - pull_requests - installation: *663 - organization: *664 - repository: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - check_run @@ -104743,10 +105427,10 @@ x-webhooks: type: string enum: - created - check_run: *675 - installation: *663 - organization: *664 - repository: *665 + check_run: *678 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - check_run @@ -105142,10 +105826,10 @@ x-webhooks: type: string enum: - requested_action - check_run: *675 - installation: *663 - organization: *664 - repository: *665 + check_run: *678 + installation: *666 + organization: *667 + repository: *668 requested_action: description: The action requested by the user. type: object @@ -105550,10 +106234,10 @@ x-webhooks: type: string enum: - rerequested - check_run: *675 - installation: *663 - organization: *664 - repository: *665 + check_run: *678 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - check_run @@ -106530,10 +107214,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -107203,10 +107887,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -107870,10 +108554,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -108173,20 +108857,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &676 + commit_oid: &679 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: *662 - installation: *663 - organization: *664 - ref: &677 + enterprise: *665 + installation: *666 + organization: *667 + ref: &680 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: *665 + repository: *668 sender: *19 required: - action @@ -108504,12 +109188,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *676 - enterprise: *662 - installation: *663 - organization: *664 - ref: *677 - repository: *665 + commit_oid: *679 + enterprise: *665 + installation: *666 + organization: *667 + ref: *680 + repository: *668 sender: *19 required: - action @@ -108604,7 +109288,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *375 + dismissed_comment: *378 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -108766,12 +109450,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *676 - enterprise: *662 - installation: *663 - organization: *664 - ref: *677 - repository: *665 + commit_oid: *679 + enterprise: *665 + installation: *666 + organization: *667 + ref: *680 + repository: *668 sender: *19 required: - action @@ -109092,12 +109776,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *676 - enterprise: *662 - installation: *663 - organization: *664 - ref: *677 - repository: *665 + commit_oid: *679 + enterprise: *665 + installation: *666 + organization: *667 + ref: *680 + repository: *668 sender: *19 required: - action @@ -109354,16 +110038,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *665 + repository: *668 sender: *19 required: - action @@ -109589,12 +110273,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *676 - enterprise: *662 - installation: *663 - organization: *664 - ref: *677 - repository: *665 + commit_oid: *679 + enterprise: *665 + installation: *666 + organization: *667 + ref: *680 + repository: *668 sender: *19 required: - action @@ -109851,10 +110535,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -109934,18 +110618,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *664 - pusher_type: &678 + organization: *667 + pusher_type: &681 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &679 + ref: &682 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -109955,7 +110639,7 @@ x-webhooks: enum: - tag - branch - repository: *665 + repository: *668 sender: *19 required: - ref @@ -110037,10 +110721,10 @@ x-webhooks: type: string enum: - created - definition: *237 - enterprise: *662 - installation: *663 - organization: *664 + definition: *240 + enterprise: *665 + installation: *666 + organization: *667 sender: *19 required: - action @@ -110124,9 +110808,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 sender: *19 required: - action @@ -110202,10 +110886,10 @@ x-webhooks: type: string enum: - updated - definition: *237 - enterprise: *662 - installation: *663 - organization: *664 + definition: *240 + enterprise: *665 + installation: *666 + organization: *667 sender: *19 required: - action @@ -110281,19 +110965,19 @@ x-webhooks: type: string enum: - updated - enterprise: *662 - installation: *663 - repository: *665 - organization: *664 + enterprise: *665 + installation: *666 + repository: *668 + organization: *667 sender: *19 new_property_values: type: array description: The new custom property values for the repository. - items: *241 + items: *244 old_property_values: type: array description: The old custom property values for the repository. - items: *241 + items: *244 required: - action - repository @@ -110369,18 +111053,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *662 - installation: *663 - organization: *664 - pusher_type: *678 - ref: *679 + enterprise: *665 + installation: *666 + organization: *667 + pusher_type: *681 + ref: *682 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *665 + repository: *668 sender: *19 required: - ref @@ -110464,11 +111148,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *429 - installation: *663 - organization: *664 - enterprise: *662 - repository: *665 + alert: *432 + installation: *666 + organization: *667 + enterprise: *665 + repository: *668 sender: *19 required: - action @@ -110552,11 +111236,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *429 - installation: *663 - organization: *664 - enterprise: *662 - repository: *665 + alert: *432 + installation: *666 + organization: *667 + enterprise: *665 + repository: *668 sender: *19 required: - action @@ -110640,11 +111324,11 @@ x-webhooks: type: string enum: - created - alert: *429 - installation: *663 - organization: *664 - enterprise: *662 - repository: *665 + alert: *432 + installation: *666 + organization: *667 + enterprise: *665 + repository: *668 sender: *19 required: - action @@ -110726,11 +111410,11 @@ x-webhooks: type: string enum: - dismissed - alert: *429 - installation: *663 - organization: *664 - enterprise: *662 - repository: *665 + alert: *432 + installation: *666 + organization: *667 + enterprise: *665 + repository: *668 sender: *19 required: - action @@ -110812,11 +111496,11 @@ x-webhooks: type: string enum: - fixed - alert: *429 - installation: *663 - organization: *664 - enterprise: *662 - repository: *665 + alert: *432 + installation: *666 + organization: *667 + enterprise: *665 + repository: *668 sender: *19 required: - action @@ -110899,11 +111583,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *429 - installation: *663 - organization: *664 - enterprise: *662 - repository: *665 + alert: *432 + installation: *666 + organization: *667 + enterprise: *665 + repository: *668 sender: *19 required: - action @@ -110985,11 +111669,11 @@ x-webhooks: type: string enum: - reopened - alert: *429 - installation: *663 - organization: *664 - enterprise: *662 - repository: *665 + alert: *432 + installation: *666 + organization: *667 + enterprise: *665 + repository: *668 sender: *19 required: - action @@ -111066,9 +111750,9 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - key: &680 + enterprise: *665 + installation: *666 + key: &683 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -111102,8 +111786,8 @@ x-webhooks: - verified - created_at - read_only - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -111180,11 +111864,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - key: *680 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + key: *683 + organization: *667 + repository: *668 sender: *19 required: - action @@ -111745,12 +112429,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - workflow: &684 + workflow: &687 title: Workflow type: object nullable: true @@ -112476,13 +113160,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *435 + deployment: *438 pull_requests: type: array - items: *520 - repository: *665 - organization: *664 - installation: *663 + items: *523 + repository: *668 + organization: *667 + installation: *666 sender: *19 responses: '200': @@ -112553,7 +113237,7 @@ x-webhooks: type: string enum: - approved - approver: &681 + approver: &684 type: object properties: avatar_url: @@ -112596,11 +113280,11 @@ x-webhooks: type: string comment: type: string - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - reviewers: &682 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + reviewers: &685 type: array items: type: object @@ -112679,7 +113363,7 @@ x-webhooks: sender: *19 since: type: string - workflow_job_run: &683 + workflow_job_run: &686 type: object properties: conclusion: @@ -113410,18 +114094,18 @@ x-webhooks: type: string enum: - rejected - approver: *681 + approver: *684 comment: type: string - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - reviewers: *682 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + reviewers: *685 sender: *19 since: type: string - workflow_job_run: *683 + workflow_job_run: *686 workflow_job_runs: type: array items: @@ -114125,13 +114809,13 @@ x-webhooks: type: string enum: - requested - enterprise: *662 + enterprise: *665 environment: type: string - installation: *663 - organization: *664 - repository: *665 - requestor: &689 + installation: *666 + organization: *667 + repository: *668 + requestor: &692 title: User type: object nullable: true @@ -116030,12 +116714,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - workflow: *684 + workflow: *687 workflow_run: title: Deployment Workflow Run type: object @@ -116715,7 +117399,7 @@ x-webhooks: type: string enum: - answered - answer: &687 + answer: &690 type: object properties: author_association: @@ -116872,7 +117556,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &685 + discussion: &688 title: Discussion description: A Discussion in a repository. type: object @@ -117158,7 +117842,7 @@ x-webhooks: - id labels: type: array - items: *482 + items: *485 required: - repository_url - category @@ -117180,10 +117864,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -117310,11 +117994,11 @@ x-webhooks: - from required: - category - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -117397,11 +118081,11 @@ x-webhooks: type: string enum: - closed - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -117483,7 +118167,7 @@ x-webhooks: type: string enum: - created - comment: &686 + comment: &689 type: object properties: author_association: @@ -117640,11 +118324,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -117727,12 +118411,12 @@ x-webhooks: type: string enum: - deleted - comment: *686 - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + comment: *689 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -117827,12 +118511,12 @@ x-webhooks: - from required: - body - comment: *686 - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + comment: *689 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -117916,11 +118600,11 @@ x-webhooks: type: string enum: - created - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118002,11 +118686,11 @@ x-webhooks: type: string enum: - deleted - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118106,11 +118790,11 @@ x-webhooks: type: string required: - from - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118192,10 +118876,10 @@ x-webhooks: type: string enum: - labeled - discussion: *685 - enterprise: *662 - installation: *663 - label: &688 + discussion: *688 + enterprise: *665 + installation: *666 + label: &691 title: Label type: object properties: @@ -118227,8 +118911,8 @@ x-webhooks: - color - default - description - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118311,11 +118995,11 @@ x-webhooks: type: string enum: - locked - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118397,11 +119081,11 @@ x-webhooks: type: string enum: - pinned - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118483,11 +119167,11 @@ x-webhooks: type: string enum: - reopened - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118572,16 +119256,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *685 - new_repository: *665 + new_discussion: *688 + new_repository: *668 required: - new_discussion - new_repository - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118664,10 +119348,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *685 - old_answer: *687 - organization: *664 - repository: *665 + discussion: *688 + old_answer: *690 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118749,12 +119433,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *685 - enterprise: *662 - installation: *663 - label: *688 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + label: *691 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118837,11 +119521,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118923,11 +119607,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -119000,7 +119684,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *662 + enterprise: *665 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -119660,9 +120344,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *663 - organization: *664 - repository: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - forkee @@ -119808,9 +120492,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 pages: description: The pages that were updated. type: array @@ -119847,7 +120531,7 @@ x-webhooks: - action - sha - html_url - repository: *665 + repository: *668 sender: *19 required: - pages @@ -119923,10 +120607,10 @@ x-webhooks: type: string enum: - created - enterprise: *662 + enterprise: *665 installation: *22 - organization: *664 - repositories: &690 + organization: *667 + repositories: &693 description: An array of repository objects that the installation can access. type: array @@ -119952,8 +120636,8 @@ x-webhooks: - name - full_name - private - repository: *665 - requester: *689 + repository: *668 + requester: *692 sender: *19 required: - action @@ -120028,11 +120712,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 + enterprise: *665 installation: *22 - organization: *664 - repositories: *690 - repository: *665 + organization: *667 + repositories: *693 + repository: *668 requester: nullable: true sender: *19 @@ -120108,11 +120792,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *662 + enterprise: *665 installation: *22 - organization: *664 - repositories: *690 - repository: *665 + organization: *667 + repositories: *693 + repository: *668 requester: nullable: true sender: *19 @@ -120188,10 +120872,10 @@ x-webhooks: type: string enum: - added - enterprise: *662 + enterprise: *665 installation: *22 - organization: *664 - repositories_added: &691 + organization: *667 + repositories_added: &694 description: An array of repository objects, which were added to the installation. type: array @@ -120237,15 +120921,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *665 - repository_selection: &692 + repository: *668 + repository_selection: &695 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *689 + requester: *692 sender: *19 required: - action @@ -120324,10 +121008,10 @@ x-webhooks: type: string enum: - removed - enterprise: *662 + enterprise: *665 installation: *22 - organization: *664 - repositories_added: *691 + organization: *667 + repositories_added: *694 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -120354,9 +121038,9 @@ x-webhooks: - name - full_name - private - repository: *665 - repository_selection: *692 - requester: *689 + repository: *668 + repository_selection: *695 + requester: *692 sender: *19 required: - action @@ -120435,11 +121119,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *662 + enterprise: *665 installation: *22 - organization: *664 - repositories: *690 - repository: *665 + organization: *667 + repositories: *693 + repository: *668 requester: nullable: true sender: *19 @@ -120618,10 +121302,10 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 target_type: type: string @@ -120700,11 +121384,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *662 + enterprise: *665 installation: *22 - organization: *664 - repositories: *690 - repository: *665 + organization: *667 + repositories: *693 + repository: *668 requester: nullable: true sender: *19 @@ -120828,8 +121512,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 reactions: title: Reactions type: object @@ -120956,8 +121640,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -122098,8 +122782,8 @@ x-webhooks: - state - locked - assignee - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -122179,7 +122863,7 @@ x-webhooks: type: string enum: - deleted - comment: &693 + comment: &696 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -122344,8 +123028,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -123484,8 +124168,8 @@ x-webhooks: - state - locked - assignee - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -123565,7 +124249,7 @@ x-webhooks: type: string enum: - edited - changes: &721 + changes: &724 description: The changes to the comment. type: object properties: @@ -123577,9 +124261,9 @@ x-webhooks: type: string required: - from - comment: *693 - enterprise: *662 - installation: *663 + comment: *696 + enterprise: *665 + installation: *666 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -124719,8 +125403,8 @@ x-webhooks: - state - locked - assignee - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -124802,10 +125486,10 @@ x-webhooks: type: string enum: - assigned - assignee: *689 - enterprise: *662 - installation: *663 - issue: &696 + assignee: *692 + enterprise: *665 + installation: *666 + issue: &699 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -125709,8 +126393,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -125790,8 +126474,8 @@ x-webhooks: type: string enum: - closed - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -126835,8 +127519,8 @@ x-webhooks: required: - state - closed_at - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -126915,8 +127599,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -127813,8 +128497,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -127893,8 +128577,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -128794,7 +129478,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &694 + milestone: &697 title: Milestone description: A collection of related issues and pull requests. type: object @@ -128932,8 +129616,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -129032,8 +129716,8 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -129937,9 +130621,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *688 - organization: *664 - repository: *665 + label: *691 + organization: *667 + repository: *668 sender: *19 required: - action @@ -130019,8 +130703,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -130923,9 +131607,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *688 - organization: *664 - repository: *665 + label: *691 + organization: *667 + repository: *668 sender: *19 required: - action @@ -131005,8 +131689,8 @@ x-webhooks: type: string enum: - locked - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -131910,8 +132594,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -131990,8 +132674,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -132889,9 +133573,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *694 - organization: *664 - repository: *665 + milestone: *697 + organization: *667 + repository: *668 sender: *19 required: - action @@ -134338,8 +135022,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -135242,8 +135926,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -135323,9 +136007,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *662 - installation: *663 - issue: &695 + enterprise: *665 + installation: *666 + issue: &698 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -136222,8 +136906,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -136302,8 +136986,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -137206,8 +137890,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -138655,11 +139339,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *662 - installation: *663 - issue: *695 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + issue: *698 + organization: *667 + repository: *668 sender: *19 required: - action @@ -138740,7 +139424,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &724 + assignee: &727 title: User type: object nullable: true @@ -138810,11 +139494,11 @@ x-webhooks: required: - login - id - enterprise: *662 - installation: *663 - issue: *696 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + issue: *699 + organization: *667 + repository: *668 sender: *19 required: - action @@ -138893,12 +139577,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *662 - installation: *663 - issue: *696 - label: *688 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + issue: *699 + label: *691 + organization: *667 + repository: *668 sender: *19 required: - action @@ -138978,8 +139662,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -139881,8 +140565,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -139962,11 +140646,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *662 - installation: *663 - issue: *695 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + issue: *698 + organization: *667 + repository: *668 sender: *19 required: - action @@ -140045,11 +140729,11 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - label: *688 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + label: *691 + organization: *667 + repository: *668 sender: *19 required: - action @@ -140127,11 +140811,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - label: *688 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + label: *691 + organization: *667 + repository: *668 sender: *19 required: - action @@ -140241,11 +140925,11 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 - label: *688 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + label: *691 + organization: *667 + repository: *668 sender: *19 required: - action @@ -140327,9 +141011,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *662 - installation: *663 - marketplace_purchase: &697 + enterprise: *665 + installation: *666 + marketplace_purchase: &700 title: Marketplace Purchase type: object required: @@ -140412,8 +141096,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *664 - previous_marketplace_purchase: &698 + organization: *667 + previous_marketplace_purchase: &701 title: Marketplace Purchase type: object properties: @@ -140493,7 +141177,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *665 + repository: *668 sender: *19 required: - action @@ -140573,10 +141257,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *662 - installation: *663 - marketplace_purchase: *697 - organization: *664 + enterprise: *665 + installation: *666 + marketplace_purchase: *700 + organization: *667 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -140659,7 +141343,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *665 + repository: *668 sender: *19 required: - action @@ -140741,10 +141425,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *662 - installation: *663 - marketplace_purchase: *697 - organization: *664 + enterprise: *665 + installation: *666 + marketplace_purchase: *700 + organization: *667 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -140826,7 +141510,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *665 + repository: *668 sender: *19 required: - action @@ -140907,8 +141591,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 marketplace_purchase: title: Marketplace Purchase type: object @@ -140990,9 +141674,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *664 - previous_marketplace_purchase: *698 - repository: *665 + organization: *667 + previous_marketplace_purchase: *701 + repository: *668 sender: *19 required: - action @@ -141072,12 +141756,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *662 - installation: *663 - marketplace_purchase: *697 - organization: *664 - previous_marketplace_purchase: *698 - repository: *665 + enterprise: *665 + installation: *666 + marketplace_purchase: *700 + organization: *667 + previous_marketplace_purchase: *701 + repository: *668 sender: *19 required: - action @@ -141179,11 +141863,11 @@ x-webhooks: type: string required: - to - enterprise: *662 - installation: *663 - member: *689 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + member: *692 + organization: *667 + repository: *668 sender: *19 required: - action @@ -141283,11 +141967,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *662 - installation: *663 - member: *689 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + member: *692 + organization: *667 + repository: *668 sender: *19 required: - action @@ -141366,11 +142050,11 @@ x-webhooks: type: string enum: - removed - enterprise: *662 - installation: *663 - member: *689 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + member: *692 + organization: *667 + repository: *668 sender: *19 required: - action @@ -141448,11 +142132,11 @@ x-webhooks: type: string enum: - added - enterprise: *662 - installation: *663 - member: *689 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + member: *692 + organization: *667 + repository: *668 scope: description: The scope of the membership. Currently, can only be `team`. @@ -141528,7 +142212,7 @@ x-webhooks: required: - login - id - team: &699 + team: &702 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -141718,11 +142402,11 @@ x-webhooks: type: string enum: - removed - enterprise: *662 - installation: *663 - member: *689 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + member: *692 + organization: *667 + repository: *668 scope: description: The scope of the membership. Currently, can only be `team`. @@ -141799,7 +142483,7 @@ x-webhooks: required: - login - id - team: *699 + team: *702 required: - action - scope @@ -141881,8 +142565,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *663 - merge_group: &701 + installation: *666 + merge_group: &704 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -141901,15 +142585,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *700 + head_commit: *703 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -141995,10 +142679,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *663 - merge_group: *701 - organization: *664 - repository: *665 + installation: *666 + merge_group: *704 + organization: *667 + repository: *668 sender: *19 required: - action @@ -142071,7 +142755,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 + enterprise: *665 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -142179,16 +142863,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *663 - organization: *664 + installation: *666 + organization: *667 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *702 - required: *703 + properties: *705 + required: *706 nullable: true sender: *19 required: @@ -142269,11 +142953,11 @@ x-webhooks: type: string enum: - closed - enterprise: *662 - installation: *663 - milestone: *694 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + milestone: *697 + organization: *667 + repository: *668 sender: *19 required: - action @@ -142352,9 +143036,9 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - milestone: &704 + enterprise: *665 + installation: *666 + milestone: &707 title: Milestone description: A collection of related issues and pull requests. type: object @@ -142491,8 +143175,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -142571,11 +143255,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - milestone: *694 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + milestone: *697 + organization: *667 + repository: *668 sender: *19 required: - action @@ -142685,11 +143369,11 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 - milestone: *694 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + milestone: *697 + organization: *667 + repository: *668 sender: *19 required: - action @@ -142769,11 +143453,11 @@ x-webhooks: type: string enum: - opened - enterprise: *662 - installation: *663 - milestone: *704 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + milestone: *707 + organization: *667 + repository: *668 sender: *19 required: - action @@ -142852,11 +143536,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *689 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + blocked_user: *692 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -142935,11 +143619,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *689 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + blocked_user: *692 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -143018,9 +143702,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - membership: &705 + enterprise: *665 + installation: *666 + membership: &708 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -143112,8 +143796,8 @@ x-webhooks: - role - organization_url - user - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -143191,11 +143875,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *662 - installation: *663 - membership: *705 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + membership: *708 + organization: *667 + repository: *668 sender: *19 required: - action @@ -143274,8 +143958,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -143391,10 +144075,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 - user: *689 + user: *692 required: - action - invitation @@ -143472,11 +144156,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *662 - installation: *663 - membership: *705 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + membership: *708 + organization: *667 + repository: *668 sender: *19 required: - action @@ -143563,11 +144247,11 @@ x-webhooks: properties: from: type: string - enterprise: *662 - installation: *663 - membership: *705 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + membership: *708 + organization: *667 + repository: *668 sender: *19 required: - action @@ -143643,9 +144327,9 @@ x-webhooks: type: string enum: - published - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 package: description: Information about the package. type: object @@ -144144,7 +144828,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &706 + items: &709 title: Ruby Gems metadata type: object properties: @@ -144239,7 +144923,7 @@ x-webhooks: - owner - package_version - registry - repository: *665 + repository: *668 sender: *19 required: - action @@ -144315,9 +144999,9 @@ x-webhooks: type: string enum: - updated - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 package: description: Information about the package. type: object @@ -144670,7 +145354,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *706 + items: *709 source_url: type: string format: uri @@ -144740,7 +145424,7 @@ x-webhooks: - owner - package_version - registry - repository: *665 + repository: *668 sender: *19 required: - action @@ -144917,12 +145601,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *662 + enterprise: *665 id: type: integer - installation: *663 - organization: *664 - repository: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - id @@ -145002,7 +145686,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &707 + personal_access_token_request: &710 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -145136,10 +145820,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *662 - organization: *664 + enterprise: *665 + organization: *667 sender: *19 - installation: *663 + installation: *666 required: - action - personal_access_token_request @@ -145218,11 +145902,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *707 - enterprise: *662 - organization: *664 + personal_access_token_request: *710 + enterprise: *665 + organization: *667 sender: *19 - installation: *663 + installation: *666 required: - action - personal_access_token_request @@ -145300,11 +145984,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *707 - enterprise: *662 - organization: *664 + personal_access_token_request: *710 + enterprise: *665 + organization: *667 sender: *19 - installation: *663 + installation: *666 required: - action - personal_access_token_request @@ -145381,11 +146065,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *707 - organization: *664 - enterprise: *662 + personal_access_token_request: *710 + organization: *667 + enterprise: *665 sender: *19 - installation: *663 + installation: *666 required: - action - personal_access_token_request @@ -145489,7 +146173,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *708 + last_response: *711 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -145521,8 +146205,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 zen: description: Random string of GitHub zen. @@ -145767,10 +146451,10 @@ x-webhooks: - from required: - note - enterprise: *662 - installation: *663 - organization: *664 - project_card: &709 + enterprise: *665 + installation: *666 + organization: *667 + project_card: &712 title: Project Card type: object properties: @@ -145889,7 +146573,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *665 + repository: *668 sender: *19 required: - action @@ -145970,11 +146654,11 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - project_card: *709 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + project_card: *712 + repository: *668 sender: *19 required: - action @@ -146054,9 +146738,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 project_card: title: Project Card type: object @@ -146184,8 +146868,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *702 - required: *703 + properties: *705 + required: *706 nullable: true sender: *19 required: @@ -146279,11 +146963,11 @@ x-webhooks: - from required: - note - enterprise: *662 - installation: *663 - organization: *664 - project_card: *709 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + project_card: *712 + repository: *668 sender: *19 required: - action @@ -146377,9 +147061,9 @@ x-webhooks: - from required: - column_id - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 project_card: allOf: - title: Project Card @@ -146569,7 +147253,7 @@ x-webhooks: type: string required: - after_id - repository: *665 + repository: *668 sender: *19 required: - action @@ -146649,10 +147333,10 @@ x-webhooks: type: string enum: - closed - enterprise: *662 - installation: *663 - organization: *664 - project: &711 + enterprise: *665 + installation: *666 + organization: *667 + project: &714 title: Project type: object properties: @@ -146776,7 +147460,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *665 + repository: *668 sender: *19 required: - action @@ -146856,10 +147540,10 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - project_column: &710 + enterprise: *665 + installation: *666 + organization: *667 + project_column: &713 title: Project Column type: object properties: @@ -146898,7 +147582,7 @@ x-webhooks: - name - created_at - updated_at - repository: *665 + repository: *668 sender: *19 required: - action @@ -146977,18 +147661,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 - project_column: *710 + enterprise: *665 + installation: *666 + organization: *667 + project_column: *713 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *702 - required: *703 + properties: *705 + required: *706 nullable: true sender: *19 required: @@ -147078,11 +147762,11 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 - organization: *664 - project_column: *710 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + project_column: *713 + repository: *668 sender: *19 required: - action @@ -147162,11 +147846,11 @@ x-webhooks: type: string enum: - moved - enterprise: *662 - installation: *663 - organization: *664 - project_column: *710 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + project_column: *713 + repository: *668 sender: *19 required: - action @@ -147246,11 +147930,11 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - project: *711 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + project: *714 + repository: *668 sender: *19 required: - action @@ -147330,18 +148014,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 - project: *711 + enterprise: *665 + installation: *666 + organization: *667 + project: *714 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *702 - required: *703 + properties: *705 + required: *706 nullable: true sender: *19 required: @@ -147443,11 +148127,11 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 - organization: *664 - project: *711 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + project: *714 + repository: *668 sender: *19 required: - action @@ -147526,11 +148210,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *662 - installation: *663 - organization: *664 - project: *711 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + project: *714 + repository: *668 sender: *19 required: - action @@ -147611,9 +148295,9 @@ x-webhooks: type: string enum: - closed - installation: *663 - organization: *664 - projects_v2: &712 + installation: *666 + organization: *667 + projects_v2: &715 title: Projects v2 Project description: A projects v2 project type: object @@ -147756,9 +148440,9 @@ x-webhooks: type: string enum: - created - installation: *663 - organization: *664 - projects_v2: *712 + installation: *666 + organization: *667 + projects_v2: *715 sender: *19 required: - action @@ -147839,9 +148523,9 @@ x-webhooks: type: string enum: - deleted - installation: *663 - organization: *664 - projects_v2: *712 + installation: *666 + organization: *667 + projects_v2: *715 sender: *19 required: - action @@ -147958,9 +148642,9 @@ x-webhooks: type: string to: type: string - installation: *663 - organization: *664 - projects_v2: *712 + installation: *666 + organization: *667 + projects_v2: *715 sender: *19 required: - action @@ -148043,7 +148727,7 @@ x-webhooks: type: string enum: - archived - changes: &716 + changes: &719 type: object properties: archived_at: @@ -148057,9 +148741,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *663 - organization: *664 - projects_v2_item: &713 + installation: *666 + organization: *667 + projects_v2_item: &716 title: Projects v2 Item description: An item belonging to a project type: object @@ -148193,9 +148877,9 @@ x-webhooks: nullable: true to: type: string - installation: *663 - organization: *664 - projects_v2_item: *713 + installation: *666 + organization: *667 + projects_v2_item: *716 sender: *19 required: - action @@ -148277,9 +148961,9 @@ x-webhooks: type: string enum: - created - installation: *663 - organization: *664 - projects_v2_item: *713 + installation: *666 + organization: *667 + projects_v2_item: *716 sender: *19 required: - action @@ -148360,9 +149044,9 @@ x-webhooks: type: string enum: - deleted - installation: *663 - organization: *664 - projects_v2_item: *713 + installation: *666 + organization: *667 + projects_v2_item: *716 sender: *19 required: - action @@ -148468,7 +149152,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &714 + - &717 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -148486,7 +149170,7 @@ x-webhooks: required: - id - name - - &715 + - &718 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -148509,8 +149193,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *714 - - *715 + - *717 + - *718 required: - field_value - type: object @@ -148526,9 +149210,9 @@ x-webhooks: nullable: true required: - body - installation: *663 - organization: *664 - projects_v2_item: *713 + installation: *666 + organization: *667 + projects_v2_item: *716 sender: *19 required: - action @@ -148623,9 +149307,9 @@ x-webhooks: to: type: string nullable: true - installation: *663 - organization: *664 - projects_v2_item: *713 + installation: *666 + organization: *667 + projects_v2_item: *716 sender: *19 required: - action @@ -148708,10 +149392,10 @@ x-webhooks: type: string enum: - restored - changes: *716 - installation: *663 - organization: *664 - projects_v2_item: *713 + changes: *719 + installation: *666 + organization: *667 + projects_v2_item: *716 sender: *19 required: - action @@ -148793,9 +149477,9 @@ x-webhooks: type: string enum: - reopened - installation: *663 - organization: *664 - projects_v2: *712 + installation: *666 + organization: *667 + projects_v2: *715 sender: *19 required: - action @@ -148876,9 +149560,9 @@ x-webhooks: type: string enum: - created - installation: *663 - organization: *664 - projects_v2_status_update: &717 + installation: *666 + organization: *667 + projects_v2_status_update: &720 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -149005,9 +149689,9 @@ x-webhooks: type: string enum: - deleted - installation: *663 - organization: *664 - projects_v2_status_update: *717 + installation: *666 + organization: *667 + projects_v2_status_update: *720 sender: *19 required: - action @@ -149143,9 +149827,9 @@ x-webhooks: type: string format: date nullable: true - installation: *663 - organization: *664 - projects_v2_status_update: *717 + installation: *666 + organization: *667 + projects_v2_status_update: *720 sender: *19 required: - action @@ -149216,10 +149900,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - repository @@ -149296,13 +149980,13 @@ x-webhooks: type: string enum: - assigned - assignee: *689 - enterprise: *662 - installation: *663 - number: &718 + assignee: *692 + enterprise: *665 + installation: *666 + number: &721 description: The pull request number. type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -151585,7 +152269,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -151667,11 +152351,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 number: type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -153949,7 +154633,7 @@ x-webhooks: - draft reason: type: string - repository: *665 + repository: *668 sender: *19 required: - action @@ -154031,11 +154715,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 number: type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -156313,7 +156997,7 @@ x-webhooks: - draft reason: type: string - repository: *665 + repository: *668 sender: *19 required: - action @@ -156395,13 +157079,13 @@ x-webhooks: type: string enum: - closed - enterprise: *662 - installation: *663 - number: *718 - organization: *664 - pull_request: &719 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 + pull_request: &722 allOf: - - *520 + - *523 - type: object properties: allow_auto_merge: @@ -156463,7 +157147,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *665 + repository: *668 sender: *19 required: - action @@ -156544,12 +157228,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *662 - installation: *663 - number: *718 - organization: *664 - pull_request: *719 - repository: *665 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 + pull_request: *722 + repository: *668 sender: *19 required: - action @@ -156629,11 +157313,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *662 - milestone: *502 - number: *718 - organization: *664 - pull_request: &720 + enterprise: *665 + milestone: *505 + number: *721 + organization: *667 + pull_request: &723 title: Pull Request type: object properties: @@ -158896,7 +159580,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -158975,11 +159659,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 number: type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -161261,7 +161945,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *665 + repository: *668 sender: *19 required: - action @@ -161385,12 +162069,12 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 - number: *718 - organization: *664 - pull_request: *719 - repository: *665 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 + pull_request: *722 + repository: *668 sender: *19 required: - action @@ -161470,11 +162154,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 number: type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -163741,7 +164425,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -163821,11 +164505,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *662 - installation: *663 - label: *688 - number: *718 - organization: *664 + enterprise: *665 + installation: *666 + label: *691 + number: *721 + organization: *667 pull_request: title: Pull Request type: object @@ -166107,7 +166791,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -166188,10 +166872,10 @@ x-webhooks: type: string enum: - locked - enterprise: *662 - installation: *663 - number: *718 - organization: *664 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 pull_request: title: Pull Request type: object @@ -168471,7 +169155,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -168551,12 +169235,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *662 - milestone: *502 - number: *718 - organization: *664 - pull_request: *720 - repository: *665 + enterprise: *665 + milestone: *505 + number: *721 + organization: *667 + pull_request: *723 + repository: *668 sender: *19 required: - action @@ -168635,12 +169319,12 @@ x-webhooks: type: string enum: - opened - enterprise: *662 - installation: *663 - number: *718 - organization: *664 - pull_request: *719 - repository: *665 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 + pull_request: *722 + repository: *668 sender: *19 required: - action @@ -168721,12 +169405,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *662 - installation: *663 - number: *718 - organization: *664 - pull_request: *719 - repository: *665 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 + pull_request: *722 + repository: *668 sender: *19 required: - action @@ -168806,12 +169490,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *662 - installation: *663 - number: *718 - organization: *664 - pull_request: *719 - repository: *665 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 + pull_request: *722 + repository: *668 sender: *19 required: - action @@ -169177,9 +169861,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 pull_request: type: object properties: @@ -171349,7 +172033,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *665 + repository: *668 sender: *19 required: - action @@ -171429,7 +172113,7 @@ x-webhooks: type: string enum: - deleted - comment: &722 + comment: &725 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. @@ -171714,9 +172398,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 pull_request: type: object properties: @@ -173874,7 +174558,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *665 + repository: *668 sender: *19 required: - action @@ -173954,11 +174638,11 @@ x-webhooks: type: string enum: - edited - changes: *721 - comment: *722 - enterprise: *662 - installation: *663 - organization: *664 + changes: *724 + comment: *725 + enterprise: *665 + installation: *666 + organization: *667 pull_request: type: object properties: @@ -176119,7 +176803,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *665 + repository: *668 sender: *19 required: - action @@ -176200,9 +176884,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 pull_request: title: Simple Pull Request type: object @@ -178375,7 +179059,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *665 + repository: *668 review: description: The review that was affected. type: object @@ -178618,9 +179302,9 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 pull_request: title: Simple Pull Request type: object @@ -180674,8 +181358,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *665 - review: &723 + repository: *668 + review: &726 description: The review that was affected. type: object properties: @@ -180904,12 +181588,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 number: description: The pull request number. type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -183192,7 +183876,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 requested_reviewer: title: User type: object @@ -183276,12 +183960,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 number: description: The pull request number. type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -185571,7 +186255,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 requested_team: title: Team description: Groups of organization members that gives permissions @@ -185763,12 +186447,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 number: description: The pull request number. type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -188053,7 +188737,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 requested_reviewer: title: User type: object @@ -188138,12 +188822,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 number: description: The pull request number. type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -190419,7 +191103,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 requested_team: title: Team description: Groups of organization members that gives permissions @@ -190600,9 +191284,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 pull_request: title: Simple Pull Request type: object @@ -192777,8 +193461,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *665 - review: *723 + repository: *668 + review: *726 sender: *19 required: - action @@ -192858,9 +193542,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 pull_request: title: Simple Pull Request type: object @@ -194930,7 +195614,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *665 + repository: *668 sender: *19 thread: type: object @@ -195313,9 +195997,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 pull_request: title: Simple Pull Request type: object @@ -197371,7 +198055,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *665 + repository: *668 sender: *19 thread: type: object @@ -197757,10 +198441,10 @@ x-webhooks: type: string before: type: string - enterprise: *662 - installation: *663 - number: *718 - organization: *664 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 pull_request: title: Pull Request type: object @@ -200031,7 +200715,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -200113,11 +200797,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *724 - enterprise: *662 - installation: *663 - number: *718 - organization: *664 + assignee: *727 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 pull_request: title: Pull Request type: object @@ -202400,7 +203084,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -202479,11 +203163,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *662 - installation: *663 - label: *688 - number: *718 - organization: *664 + enterprise: *665 + installation: *666 + label: *691 + number: *721 + organization: *667 pull_request: title: Pull Request type: object @@ -204756,7 +205440,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -204837,10 +205521,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *662 - installation: *663 - number: *718 - organization: *664 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 pull_request: title: Pull Request type: object @@ -207105,7 +207789,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -207305,7 +207989,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *662 + enterprise: *665 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -207397,8 +208081,8 @@ x-webhooks: - url - author - committer - installation: *663 - organization: *664 + installation: *666 + organization: *667 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -207973,9 +208657,9 @@ x-webhooks: type: string enum: - published - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 registry_package: type: object properties: @@ -208421,7 +209105,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *706 + items: *709 summary: type: string tag_name: @@ -208475,7 +209159,7 @@ x-webhooks: - owner - package_version - registry - repository: *665 + repository: *668 sender: *19 required: - action @@ -208553,9 +209237,9 @@ x-webhooks: type: string enum: - updated - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 registry_package: type: object properties: @@ -208863,7 +209547,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *706 + items: *709 summary: type: string tag_name: @@ -208912,7 +209596,7 @@ x-webhooks: - owner - package_version - registry - repository: *665 + repository: *668 sender: *19 required: - action @@ -208989,10 +209673,10 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - release: &725 + enterprise: *665 + installation: *666 + organization: *667 + release: &728 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -209297,7 +209981,7 @@ x-webhooks: - tarball_url - zipball_url - body - repository: *665 + repository: *668 sender: *19 required: - action @@ -209374,11 +210058,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 - release: *725 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + release: *728 + repository: *668 sender: *19 required: - action @@ -209486,11 +210170,11 @@ x-webhooks: type: boolean required: - to - enterprise: *662 - installation: *663 - organization: *664 - release: *725 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + release: *728 + repository: *668 sender: *19 required: - action @@ -209568,9 +210252,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -209879,7 +210563,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *665 + repository: *668 sender: *19 required: - action @@ -209955,10 +210639,10 @@ x-webhooks: type: string enum: - published - enterprise: *662 - installation: *663 - organization: *664 - release: &726 + enterprise: *665 + installation: *666 + organization: *667 + release: &729 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -210264,7 +210948,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *665 + repository: *668 sender: *19 required: - action @@ -210340,11 +211024,11 @@ x-webhooks: type: string enum: - released - enterprise: *662 - installation: *663 - organization: *664 - release: *725 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + release: *728 + repository: *668 sender: *19 required: - action @@ -210420,11 +211104,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *662 - installation: *663 - organization: *664 - release: *726 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + release: *729 + repository: *668 sender: *19 required: - action @@ -210500,11 +211184,11 @@ x-webhooks: type: string enum: - published - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - repository_advisory: *573 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + repository_advisory: *576 sender: *19 required: - action @@ -210580,11 +211264,11 @@ x-webhooks: type: string enum: - reported - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - repository_advisory: *573 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + repository_advisory: *576 sender: *19 required: - action @@ -210660,10 +211344,10 @@ x-webhooks: type: string enum: - archived - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -210740,10 +211424,10 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -210821,10 +211505,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -210908,10 +211592,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -211023,10 +211707,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -211098,10 +211782,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 status: type: string @@ -211182,10 +211866,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -211262,10 +211946,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -211359,10 +212043,10 @@ x-webhooks: - name required: - repository - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -211442,11 +212126,11 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - repository_ruleset: *253 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + repository_ruleset: *256 sender: *19 required: - action @@ -211524,11 +212208,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - repository_ruleset: *253 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + repository_ruleset: *256 sender: *19 required: - action @@ -211606,11 +212290,11 @@ x-webhooks: type: string enum: - edited - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - repository_ruleset: *253 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + repository_ruleset: *256 changes: type: object properties: @@ -211629,16 +212313,16 @@ x-webhooks: properties: added: type: array - items: *247 + items: *250 deleted: type: array - items: *247 + items: *250 updated: type: array items: type: object properties: - condition: *247 + condition: *250 changes: type: object properties: @@ -211671,16 +212355,16 @@ x-webhooks: properties: added: type: array - items: *252 + items: *255 deleted: type: array - items: *252 + items: *255 updated: type: array items: type: object properties: - rule: *252 + rule: *255 changes: type: object properties: @@ -211914,10 +212598,10 @@ x-webhooks: - from required: - owner - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -211995,10 +212679,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -212076,7 +212760,7 @@ x-webhooks: type: string enum: - create - alert: &727 + alert: &730 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -212197,10 +212881,10 @@ x-webhooks: type: string enum: - open - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -212406,10 +213090,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -212487,11 +213171,11 @@ x-webhooks: type: string enum: - reopen - alert: *727 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + alert: *730 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -212690,10 +213374,10 @@ x-webhooks: enum: - fixed - open - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -212771,7 +213455,7 @@ x-webhooks: type: string enum: - created - alert: &728 + alert: &731 type: object properties: number: *74 @@ -212860,10 +213544,10 @@ x-webhooks: description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -212944,11 +213628,11 @@ x-webhooks: type: string enum: - created - alert: *728 - installation: *663 - location: *729 - organization: *664 - repository: *665 + alert: *731 + installation: *666 + location: *732 + organization: *667 + repository: *668 sender: *19 required: - location @@ -213186,11 +213870,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *728 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + alert: *731 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -213268,11 +213952,11 @@ x-webhooks: type: string enum: - reopened - alert: *728 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + alert: *731 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -213350,11 +214034,11 @@ x-webhooks: type: string enum: - resolved - alert: *728 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + alert: *731 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -213432,11 +214116,11 @@ x-webhooks: type: string enum: - validated - alert: *728 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + alert: *731 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -213512,11 +214196,11 @@ x-webhooks: type: string enum: - published - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - security_advisory: &730 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + security_advisory: &733 description: The details of the security advisory, including summary, description, and severity. type: object @@ -213699,11 +214383,11 @@ x-webhooks: type: string enum: - updated - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - security_advisory: *730 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + security_advisory: *733 sender: *19 required: - action @@ -213776,10 +214460,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -213963,11 +214647,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *244 - enterprise: *662 - installation: *663 - organization: *664 - repository: *305 + security_and_analysis: *247 + enterprise: *665 + installation: *666 + organization: *667 + repository: *308 sender: *19 required: - changes @@ -214045,12 +214729,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - sponsorship: &731 + sponsorship: &734 type: object properties: created_at: @@ -214351,12 +215035,12 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - sponsorship: *731 + sponsorship: *734 required: - action - sponsorship @@ -214444,12 +215128,12 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - sponsorship: *731 + sponsorship: *734 required: - action - changes @@ -214526,17 +215210,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &732 + effective_date: &735 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: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - sponsorship: *731 + sponsorship: *734 required: - action - sponsorship @@ -214610,7 +215294,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &733 + changes: &736 type: object properties: tier: @@ -214654,13 +215338,13 @@ x-webhooks: - from required: - tier - effective_date: *732 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + effective_date: *735 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - sponsorship: *731 + sponsorship: *734 required: - action - changes @@ -214737,13 +215421,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *733 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + changes: *736 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - sponsorship: *731 + sponsorship: *734 required: - action - changes @@ -214817,10 +215501,10 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 starred_at: description: 'The time the star was created. This is a timestamp @@ -214903,10 +215587,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 starred_at: description: 'The time the star was created. This is a timestamp @@ -215322,15 +216006,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *662 + enterprise: *665 id: description: The unique identifier of the status. type: integer - installation: *663 + installation: *666 name: type: string - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 sha: description: The Commit SHA. @@ -215439,15 +216123,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *104 + parent_issue: *107 parent_issue_repo: *57 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *104 - installation: *663 - organization: *664 - repository: *665 + sub_issue: *107 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -215531,15 +216215,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *104 + parent_issue: *107 parent_issue_repo: *57 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *104 - installation: *663 - organization: *664 - repository: *665 + sub_issue: *107 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -215623,15 +216307,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *104 + sub_issue: *107 sub_issue_repo: *57 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *104 - installation: *663 - organization: *664 - repository: *665 + parent_issue: *107 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -215715,15 +216399,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *104 + sub_issue: *107 sub_issue_repo: *57 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *104 - installation: *663 - organization: *664 - repository: *665 + parent_issue: *107 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -215800,12 +216484,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - team: &734 + team: &737 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -215995,9 +216679,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 repository: title: Repository description: A git repository @@ -216455,7 +217139,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *734 + team: *737 required: - action - team @@ -216531,9 +217215,9 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 repository: title: Repository description: A git repository @@ -216991,7 +217675,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *734 + team: *737 required: - action - team @@ -217068,9 +217752,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 repository: title: Repository description: A git repository @@ -217528,7 +218212,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *734 + team: *737 required: - action - team @@ -217672,9 +218356,9 @@ x-webhooks: - from required: - permissions - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 repository: title: Repository description: A git repository @@ -218132,7 +218816,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *734 + team: *737 required: - action - changes @@ -218210,9 +218894,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 repository: title: Repository description: A git repository @@ -218670,7 +219354,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *734 + team: *737 required: - action - team @@ -218746,10 +219430,10 @@ x-webhooks: type: string enum: - started - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -218822,16 +219506,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *662 + enterprise: *665 inputs: type: object nullable: true additionalProperties: true - installation: *663 - organization: *664 + installation: *666 + organization: *667 ref: type: string - repository: *665 + repository: *668 sender: *19 workflow: type: string @@ -218913,10 +219597,10 @@ x-webhooks: type: string enum: - completed - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 workflow_job: allOf: @@ -219153,7 +219837,7 @@ x-webhooks: type: string required: - conclusion - deployment: *435 + deployment: *438 required: - action - repository @@ -219232,10 +219916,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 workflow_job: allOf: @@ -219495,7 +220179,7 @@ x-webhooks: required: - status - steps - deployment: *435 + deployment: *438 required: - action - repository @@ -219574,10 +220258,10 @@ x-webhooks: type: string enum: - queued - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 workflow_job: type: object @@ -219712,7 +220396,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *435 + deployment: *438 required: - action - repository @@ -219791,10 +220475,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 workflow_job: type: object @@ -219930,7 +220614,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *435 + deployment: *438 required: - action - repository @@ -220010,12 +220694,12 @@ x-webhooks: type: string enum: - completed - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - workflow: *684 + workflow: *687 workflow_run: title: Workflow Run type: object @@ -221014,12 +221698,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - workflow: *684 + workflow: *687 workflow_run: title: Workflow Run type: object @@ -222003,12 +222687,12 @@ x-webhooks: type: string enum: - requested - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - workflow: *684 + workflow: *687 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/dereferenced/ghec.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index e4f7d9d680..4a209198b0 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -25167,6 +25167,646 @@ } } }, + "/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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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", @@ -30027,6 +30667,655 @@ } } }, + "/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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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", @@ -81038,6 +82327,646 @@ } } }, + "/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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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", @@ -141186,6 +143115,655 @@ } } }, + "/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", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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/ghec/dereferenced/ghec.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 394f149deb..166e28dd08 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -846,7 +846,7 @@ paths: - subscriptions_url - type - url - type: &264 + type: &267 type: string description: The type of credit the user is receiving. enum: @@ -979,7 +979,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &125 + schema: &128 title: Validation Error Simple description: Validation Error Simple type: object @@ -1012,7 +1012,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: - - &575 + - &578 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1130,7 +1130,7 @@ paths: GitHub. type: object nullable: true - properties: &89 + properties: &92 id: description: Unique identifier of the GitHub app example: 37 @@ -1219,7 +1219,7 @@ paths: type: string example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"' - required: &90 + required: &93 - id - node_id - owner @@ -1524,7 +1524,7 @@ paths: schema: type: integer default: 30 - - &196 + - &199 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 @@ -1545,7 +1545,7 @@ paths: application/json: schema: type: array - items: &197 + items: &200 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1622,7 +1622,7 @@ paths: - installation_id - repository_id examples: - default: &198 + default: &201 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1654,7 +1654,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &585 + schema: &588 title: Scim Error description: Scim Error type: object @@ -1681,7 +1681,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &124 + schema: &127 title: Validation Error description: Validation Error type: object @@ -1750,7 +1750,7 @@ paths: description: Response content: application/json: - schema: &199 + schema: &202 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1864,7 +1864,7 @@ paths: - request - response examples: - default: &200 + default: &203 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1924,7 +1924,7 @@ paths: parameters: - *17 responses: - '202': &127 + '202': &130 description: Accepted content: application/json: @@ -2119,7 +2119,7 @@ paths: parameters: - *18 - *20 - - &94 + - &97 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) @@ -2847,7 +2847,7 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: &242 + properties: &245 id: description: Unique identifier of the repository example: 42 @@ -2867,7 +2867,7 @@ paths: title: License Simple description: License Simple type: object - properties: &105 + properties: &108 key: type: string example: mit @@ -2889,7 +2889,7 @@ paths: html_url: type: string format: uri - required: &106 + required: &109 - key - name - url @@ -3276,7 +3276,7 @@ paths: type: boolean description: Whether anonymous git access is enabled for this repository - required: &243 + required: &246 - archive_url - assignees_url - blobs_url @@ -7289,7 +7289,7 @@ paths: description: Response content: application/json: - schema: &128 + schema: &131 type: object properties: total_active_caches_count: @@ -7304,7 +7304,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &129 + default: &132 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7398,7 +7398,7 @@ paths: - all - local_only - selected - selected_actions_url: &132 + selected_actions_url: &135 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` @@ -7766,7 +7766,7 @@ paths: description: Success response content: application/json: - schema: &135 + schema: &138 type: object properties: default_workflow_permissions: &46 @@ -7814,7 +7814,7 @@ paths: required: true content: application/json: - schema: &136 + schema: &139 type: object properties: default_workflow_permissions: *46 @@ -8635,7 +8635,7 @@ paths: application/json: schema: type: array - items: &140 + items: &143 title: Runner Application description: Runner Application type: object @@ -8660,7 +8660,7 @@ paths: - download_url - filename examples: - default: &141 + default: &144 value: - os: osx architecture: x64 @@ -8744,7 +8744,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &142 + '201': &145 description: Response content: application/json: @@ -8854,7 +8854,7 @@ paths: - token - expires_at examples: - default: &143 + default: &146 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -8894,7 +8894,7 @@ paths: application/json: schema: *58 examples: - default: &144 + default: &147 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -8926,7 +8926,7 @@ paths: application/json: schema: *55 examples: - default: &145 + default: &148 value: id: 23 name: MBP @@ -9140,7 +9140,7 @@ paths: - *40 - *54 responses: - '200': &146 + '200': &149 description: Response content: application/json: @@ -9196,7 +9196,7 @@ paths: parameters: - *40 - *54 - - &147 + - &150 name: name description: The name of a self-hosted runner's custom label. in: path @@ -9287,7 +9287,7 @@ paths: required: true content: application/json: - schema: &154 + schema: &157 title: Enterprise Announcement description: Enterprise global announcement type: object @@ -9358,7 +9358,7 @@ paths: required: false schema: type: string - - &155 + - &158 name: include description: |- The event types to include: @@ -9376,7 +9376,7 @@ paths: - web - git - all - - &156 + - &159 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. @@ -9384,7 +9384,7 @@ paths: required: false schema: type: string - - &157 + - &160 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. @@ -9392,7 +9392,7 @@ paths: required: false schema: type: string - - &158 + - &161 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -9414,7 +9414,7 @@ paths: application/json: schema: type: array - items: &159 + items: &162 type: object properties: "@timestamp": @@ -9536,7 +9536,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &160 + default: &163 value: - "@timestamp": 1606929874512 action: team.add_member @@ -9582,7 +9582,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *40 - - &162 + - &165 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`, @@ -9592,7 +9592,7 @@ paths: schema: &68 type: string description: The name of the tool used to generate the code scanning analysis. - - &163 + - &166 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 @@ -9615,7 +9615,7 @@ paths: be returned. in: query required: false - schema: &164 + schema: &167 type: string description: State of a code scanning alert. enum: @@ -9640,7 +9640,7 @@ paths: application/json: schema: type: array - items: &165 + items: &168 type: object properties: number: &74 @@ -9669,7 +9669,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &373 + instances_url: &376 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -9704,7 +9704,7 @@ paths: format: date-time readOnly: true nullable: true - dismissed_reason: &374 + dismissed_reason: &377 type: string description: "**Required when the state is dismissed.** The reason for dismissing or closing the alert." @@ -9713,13 +9713,13 @@ paths: - false positive - won't fix - used in tests - dismissed_comment: &375 + dismissed_comment: &378 type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 - rule: &376 + rule: &379 type: object properties: id: @@ -9772,7 +9772,7 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: &377 + tool: &380 type: object properties: name: *68 @@ -9782,15 +9782,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *69 - most_recent_instance: &378 + most_recent_instance: &381 type: object properties: - ref: &371 + ref: &374 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &384 + analysis_key: &387 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -9801,7 +9801,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &385 + category: &388 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -10139,7 +10139,7 @@ paths: - most_recent_instance - repository examples: - default: &166 + default: &169 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -10776,7 +10776,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &172 + items: &175 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -10794,7 +10794,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &207 + - &210 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -10853,7 +10853,7 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: &220 + properties: &223 id: description: Unique identifier of the team type: integer @@ -10909,7 +10909,7 @@ paths: maps to within LDAP environment example: uid=example,ou=users,dc=github,dc=com type: string - required: &221 + required: &224 - id - node_id - url @@ -11020,7 +11020,7 @@ paths: - created_at additionalProperties: false examples: - default: &173 + default: &176 value: total_seats: 2 seats: @@ -11102,6 +11102,479 @@ 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: + - *40 + - 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 + - *20 + - 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: &87 + 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 + description: Usage metrics for Copilot editor code completions + in the IDE. + nullable: true + 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 + nullable: true + 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 + description: Usage metrics for Copilot Chat in the IDE. + nullable: true + 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 + nullable: true + 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 + description: Usage metrics for Copilot Chat in github.com + nullable: true + 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 + description: The training date for the custom model + (if applicable). + nullable: true + 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 + description: Usage metrics for Copilot for pull requests. + nullable: true + 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 + nullable: true + 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: &88 + 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': *73 + '403': *29 + '404': *7 + '422': &89 + 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 @@ -11159,7 +11632,7 @@ paths: application/json: schema: type: array - items: &87 + items: &90 title: Copilot Usage Metrics description: Summary of Copilot usage. type: object @@ -11338,7 +11811,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *40 - - &180 + - &183 name: state in: query description: |- @@ -11347,7 +11820,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &181 + - &184 name: severity in: query description: |- @@ -11356,7 +11829,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &182 + - &185 name: ecosystem in: query description: |- @@ -11365,14 +11838,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &183 + - &186 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 - - &184 + - &187 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -11382,7 +11855,7 @@ paths: enum: - development - runtime - - &185 + - &188 name: sort in: query description: |- @@ -11398,7 +11871,7 @@ paths: - *67 - *65 - *66 - - &186 + - &189 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -11411,7 +11884,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &187 + - &190 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -11431,7 +11904,7 @@ paths: application/json: schema: type: array - items: &188 + items: &191 type: object description: A Dependabot alert. properties: @@ -11481,7 +11954,7 @@ paths: enum: - development - runtime - security_advisory: &427 + security_advisory: &430 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -11712,7 +12185,7 @@ paths: nullable: true maxLength: 280 fixed_at: *83 - auto_dismissed_at: &428 + auto_dismissed_at: &431 type: string description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -11738,7 +12211,7 @@ paths: - repository additionalProperties: false examples: - default: &189 + default: &192 value: - number: 2 state: dismissed @@ -12144,7 +12617,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *40 - - &255 + - &258 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -12155,7 +12628,7 @@ paths: enum: - open - resolved - - &256 + - &259 name: secret_type in: query description: |- @@ -12165,7 +12638,7 @@ paths: required: false schema: type: string - - &257 + - &260 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -12174,7 +12647,7 @@ paths: required: false schema: type: string - - &258 + - &261 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. @@ -12190,7 +12663,7 @@ paths: - *18 - *65 - *66 - - &259 + - &262 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -12199,7 +12672,7 @@ paths: required: false schema: type: string - - &260 + - &263 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -12208,7 +12681,7 @@ paths: schema: type: boolean default: false - - &261 + - &264 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -12224,7 +12697,7 @@ paths: application/json: schema: type: array - items: &262 + items: &265 type: object properties: number: *74 @@ -12243,14 +12716,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &568 + state: &571 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: &569 + resolution: &572 type: string description: "**Required when the `state` is `resolved`.** The reason for resolving the alert." @@ -12325,7 +12798,7 @@ paths: repositories in the same organization or enterprise. nullable: true examples: - default: &263 + default: &266 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -12562,7 +13035,7 @@ paths: description: Response content: application/json: - schema: &265 + schema: &268 type: object properties: total_minutes_used: @@ -12632,7 +13105,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &266 + default: &269 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -12670,7 +13143,7 @@ paths: description: Success content: application/json: - schema: &267 + schema: &270 type: object properties: total_advanced_security_committers: @@ -12725,7 +13198,7 @@ paths: required: - repositories examples: - default: &268 + default: &271 value: total_advanced_security_committers: 2 total_count: 2 @@ -12876,7 +13349,7 @@ paths: message: Resources successfully added to the cost center. '400': *15 '403': *29 - '409': &126 + '409': &129 description: Conflict content: application/json: @@ -12968,7 +13441,7 @@ paths: description: Response content: application/json: - schema: &269 + schema: &272 type: object properties: total_gigabytes_bandwidth_used: @@ -12986,7 +13459,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &270 + default: &273 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -13018,7 +13491,7 @@ paths: description: Response content: application/json: - schema: &271 + schema: &274 type: object properties: days_left_in_billing_cycle: @@ -13036,7 +13509,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &272 + default: &275 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -13177,6 +13650,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: + - *40 + - 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 + - *20 + - 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: *87 + examples: + default: *88 + '500': *73 + '403': *29 + '404': *7 + '422': *89 + 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 @@ -13206,7 +13753,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: - *40 - - &219 + - &222 name: team_slug description: The slug of the team name. in: path @@ -13244,9 +13791,9 @@ paths: application/json: schema: type: array - items: *87 + items: *90 examples: - default: &174 + default: &177 value: - day: '2023-10-15' total_suggestions_count: 1000 @@ -13402,7 +13949,7 @@ paths: application/json: schema: type: array - items: &116 + items: &119 title: Event description: Event type: object @@ -13412,7 +13959,7 @@ paths: type: type: string nullable: true - actor: &88 + actor: &91 title: Actor description: Actor type: object @@ -13452,18 +13999,18 @@ paths: - id - name - url - org: *88 + org: *91 payload: type: object properties: action: type: string - issue: &104 + issue: &107 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: &476 + properties: &479 id: type: integer format: int64 @@ -13574,7 +14121,7 @@ paths: description: A collection of related issues and pull requests. type: object - properties: &412 + properties: &415 url: type: string format: uri @@ -13644,7 +14191,7 @@ paths: format: date-time example: '2012-10-09T23:39:01Z' nullable: true - required: &413 + required: &416 - closed_issues - creator - description @@ -13733,9 +14280,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 - author_association: &91 + properties: *92 + required: *93 + author_association: &94 title: author_association type: string example: OWNER @@ -13749,7 +14296,7 @@ paths: - MEMBER - NONE - OWNER - reactions: &92 + reactions: &95 title: Reaction Rollup type: object properties: @@ -13785,7 +14332,7 @@ paths: - hooray - eyes - rocket - required: &477 + required: &480 - assignee - closed_at - comments @@ -13807,7 +14354,7 @@ paths: - author_association - created_at - updated_at - comment: &474 + comment: &477 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -13855,7 +14402,7 @@ paths: issue_url: type: string format: uri - author_association: *91 + author_association: *94 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. @@ -13865,9 +14412,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 - reactions: *92 + properties: *92 + required: *93 + reactions: *95 required: - id - node_id @@ -14043,7 +14590,7 @@ paths: _links: type: object properties: - timeline: &93 + timeline: &96 title: Link With Type description: Hypermedia Link with Type type: object @@ -14055,17 +14602,17 @@ paths: required: - href - type - user: *93 - security_advisories: *93 - current_user: *93 - current_user_public: *93 - current_user_actor: *93 - current_user_organization: *93 + user: *96 + security_advisories: *96 + current_user: *96 + current_user_public: *96 + current_user_actor: *96 + current_user_organization: *96 current_user_organizations: type: array - items: *93 - repository_discussions: *93 - repository_discussions_category: *93 + items: *96 + repository_discussions: *96 + repository_discussions_category: *96 required: - timeline - user @@ -14127,7 +14674,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *94 + - *97 - *18 - *20 responses: @@ -14137,7 +14684,7 @@ paths: application/json: schema: type: array - items: &95 + items: &98 title: Base Gist description: Base Gist type: object @@ -14229,7 +14776,7 @@ paths: - created_at - updated_at examples: - default: &96 + default: &99 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -14350,7 +14897,7 @@ paths: description: Response content: application/json: - schema: &97 + schema: &100 title: Gist Simple description: Gist Simple type: object @@ -14367,7 +14914,7 @@ paths: url: type: string format: uri - user: &624 + user: &627 title: Public User description: Public User type: object @@ -14720,7 +15267,7 @@ paths: truncated: type: boolean examples: - default: &98 + default: &101 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -14822,7 +15369,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *94 + - *97 - *18 - *20 responses: @@ -14832,9 +15379,9 @@ paths: application/json: schema: type: array - items: *95 + items: *98 examples: - default: *96 + default: *99 headers: Link: *39 '422': *16 @@ -14856,7 +15403,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *94 + - *97 - *18 - *20 responses: @@ -14866,9 +15413,9 @@ paths: application/json: schema: type: array - items: *95 + items: *98 examples: - default: *96 + default: *99 headers: Link: *39 '401': *25 @@ -14896,7 +15443,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &99 + - &102 name: gist_id description: The unique identifier of the gist. in: path @@ -14908,10 +15455,10 @@ paths: description: Response content: application/json: - schema: *97 + schema: *100 examples: - default: *98 - '403': &102 + default: *101 + '403': &105 description: Forbidden Gist content: application/json: @@ -14959,7 +15506,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *99 + - *102 requestBody: required: true content: @@ -15019,9 +15566,9 @@ paths: description: Response content: application/json: - schema: *97 + schema: *100 examples: - updateGist: *98 + updateGist: *101 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -15179,7 +15726,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *99 + - *102 responses: '204': description: Response @@ -15208,7 +15755,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *99 + - *102 - *18 - *20 responses: @@ -15218,7 +15765,7 @@ paths: application/json: schema: type: array - items: &100 + items: &103 title: Gist Comment description: A comment made to a gist. type: object @@ -15253,7 +15800,7 @@ paths: type: string format: date-time example: '2011-04-18T23:23:56Z' - author_association: *91 + author_association: *94 required: - url - id @@ -15318,7 +15865,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *99 + - *102 requestBody: required: true content: @@ -15343,9 +15890,9 @@ paths: description: Response content: application/json: - schema: *100 + schema: *103 examples: - default: &101 + default: &104 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -15403,8 +15950,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *99 - - &103 + - *102 + - &106 name: comment_id description: The unique identifier of the comment. in: path @@ -15417,12 +15964,12 @@ paths: description: Response content: application/json: - schema: *100 + schema: *103 examples: - default: *101 + default: *104 '304': *37 '404': *7 - '403': *102 + '403': *105 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -15444,8 +15991,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *99 - - *103 + - *102 + - *106 requestBody: required: true content: @@ -15470,9 +16017,9 @@ paths: description: Response content: application/json: - schema: *100 + schema: *103 examples: - default: *101 + default: *104 '404': *7 x-github: githubCloudOnly: false @@ -15489,8 +16036,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *99 - - *103 + - *102 + - *106 responses: '204': description: Response @@ -15513,7 +16060,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *99 + - *102 - *18 - *20 responses: @@ -15614,7 +16161,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *99 + - *102 - *18 - *20 responses: @@ -15624,7 +16171,7 @@ paths: application/json: schema: type: array - items: *97 + items: *100 examples: default: value: @@ -15689,13 +16236,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *99 + - *102 responses: '201': description: Response content: application/json: - schema: *95 + schema: *98 examples: default: value: @@ -15766,7 +16313,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *99 + - *102 responses: '204': description: Response if gist is starred @@ -15796,7 +16343,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *99 + - *102 responses: '204': description: Response @@ -15818,7 +16365,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *99 + - *102 responses: '204': description: Response @@ -15847,7 +16394,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *99 + - *102 - name: sha in: path required: true @@ -15858,9 +16405,9 @@ paths: description: Response content: application/json: - schema: *97 + schema: *100 examples: - default: *98 + default: *101 '422': *16 '404': *7 '403': *29 @@ -16226,7 +16773,7 @@ paths: - closed - all default: open - - &208 + - &211 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -16245,7 +16792,7 @@ paths: - comments default: created - *67 - - *94 + - *97 - name: collab in: query required: false @@ -16275,9 +16822,9 @@ paths: application/json: schema: type: array - items: *104 + items: *107 examples: - default: &209 + default: &212 value: - id: 1 node_id: MDU6SXNzdWUx @@ -16561,8 +17108,8 @@ paths: title: License Simple description: License Simple type: object - properties: *105 - required: *106 + properties: *108 + required: *109 examples: default: value: @@ -16846,7 +17393,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &107 + X-CommonMarker-Version: &110 example: 0.17.4 schema: type: string @@ -16901,7 +17448,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *107 + X-CommonMarker-Version: *110 content: text/html: schema: @@ -16930,7 +17477,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: - - &110 + - &113 name: account_id description: account_id parameter in: path @@ -16942,7 +17489,7 @@ paths: description: Response content: application/json: - schema: &109 + schema: &112 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -16972,7 +17519,7 @@ paths: nullable: true id: type: integer - plan: &108 + plan: &111 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -17061,7 +17608,7 @@ paths: nullable: true updated_at: type: string - plan: *108 + plan: *111 required: - url - id @@ -17069,7 +17616,7 @@ paths: - login - marketplace_purchase examples: - default: &111 + default: &114 value: url: https://api.github.com/orgs/github type: Organization @@ -17154,9 +17701,9 @@ paths: application/json: schema: type: array - items: *108 + items: *111 examples: - default: &112 + default: &115 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -17196,14 +17743,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &113 + - &116 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &114 + - &117 name: sort description: The property to sort the results by. in: query @@ -17233,9 +17780,9 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: - default: &115 + default: &118 value: - url: https://api.github.com/orgs/github type: Organization @@ -17309,15 +17856,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: - - *110 + - *113 responses: '200': description: Response content: application/json: - schema: *109 + schema: *112 examples: - default: *111 + default: *114 '404': description: Not Found when the account has not purchased the listing '401': *25 @@ -17349,9 +17896,9 @@ paths: application/json: schema: type: array - items: *108 + items: *111 examples: - default: *112 + default: *115 headers: Link: *39 '401': *25 @@ -17374,8 +17921,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *113 - - *114 + - *116 + - *117 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -17395,9 +17942,9 @@ paths: application/json: schema: type: array - items: *109 + items: *112 examples: - default: *115 + default: *118 headers: Link: *39 '401': *25 @@ -17646,14 +18193,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: - - &292 + - &295 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &293 + - &296 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -17670,7 +18217,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: default: value: @@ -17724,7 +18271,7 @@ paths: '404': *7 '403': *29 '304': *37 - '301': &306 + '301': &309 description: Moved permanently content: application/json: @@ -17746,7 +18293,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &505 + - &508 name: all description: If `true`, show notifications marked as read. in: query @@ -17754,7 +18301,7 @@ paths: schema: type: boolean default: false - - &506 + - &509 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -17763,8 +18310,8 @@ paths: schema: type: boolean default: false - - *94 - - &507 + - *97 + - &510 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: @@ -17789,18 +18336,18 @@ paths: application/json: schema: type: array - items: &117 + items: &120 title: Thread description: Thread type: object properties: id: type: string - repository: &139 + repository: &142 title: Minimal Repository description: Minimal Repository type: object - properties: &191 + properties: &194 id: type: integer format: int64 @@ -18076,7 +18623,7 @@ paths: web_commit_signoff_required: type: boolean example: false - security_and_analysis: &244 + security_and_analysis: &247 nullable: true type: object properties: @@ -18140,7 +18687,7 @@ paths: enum: - enabled - disabled - required: &192 + required: &195 - archive_url - assignees_url - blobs_url @@ -18228,7 +18775,7 @@ paths: - url - subscription_url examples: - default: &508 + default: &511 value: - id: '1' repository: @@ -18394,7 +18941,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &118 + - &121 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 @@ -18408,7 +18955,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *120 examples: default: value: @@ -18511,7 +19058,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *118 + - *121 responses: '205': description: Reset Content @@ -18534,7 +19081,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *118 + - *121 responses: '204': description: No content @@ -18557,13 +19104,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: - - *118 + - *121 responses: '200': description: Response content: application/json: - schema: &119 + schema: &122 title: Thread Subscription description: Thread Subscription type: object @@ -18600,7 +19147,7 @@ paths: - url - subscribed examples: - default: &120 + default: &123 value: subscribed: true ignored: false @@ -18631,7 +19178,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *118 + - *121 requestBody: required: false content: @@ -18652,9 +19199,9 @@ paths: description: Response content: application/json: - schema: *119 + schema: *122 examples: - default: *120 + default: *123 '304': *37 '403': *29 '401': *25 @@ -18677,7 +19224,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *118 + - *121 responses: '204': description: Response @@ -18774,7 +19321,7 @@ paths: type: array items: *52 examples: - default: &642 + default: &645 value: - login: github id: 1 @@ -18838,7 +19385,7 @@ paths: type: integer custom_roles: type: array - items: &175 + items: &178 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -18886,7 +19433,7 @@ paths: - created_at - updated_at examples: - default: &176 + default: &179 value: id: 8030 name: Security Engineer @@ -18938,7 +19485,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - &121 + - &124 name: org description: The organization name. The name is not case sensitive. in: path @@ -18950,7 +19497,7 @@ paths: description: Response content: application/json: - schema: &122 + schema: &125 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -19247,7 +19794,7 @@ paths: - updated_at - archived_at examples: - default-response: &123 + default-response: &126 value: login: github id: 1 @@ -19339,7 +19886,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *121 + - *124 requestBody: required: false content: @@ -19558,18 +20105,18 @@ paths: description: Response content: application/json: - schema: *122 + schema: *125 examples: - default: *123 + default: *126 '422': description: Validation failed content: application/json: schema: oneOf: - - *124 - - *125 - '409': *126 + - *127 + - *128 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19592,9 +20139,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *121 + - *124 responses: - '202': *127 + '202': *130 '404': *7 '403': *29 x-github: @@ -19617,15 +20164,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: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: *128 + schema: *131 examples: - default: *129 + default: *132 headers: Link: *39 x-github: @@ -19648,7 +20195,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: - - *121 + - *124 - *18 - *20 responses: @@ -19666,7 +20213,7 @@ paths: type: integer repository_cache_usages: type: array - items: &311 + items: &314 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -19721,13 +20268,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: - - *121 + - *124 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &130 + schema: &133 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -19741,7 +20288,7 @@ paths: required: - include_claim_keys examples: - default: &131 + default: &134 value: include_claim_keys: - repo @@ -19763,20 +20310,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: - - *121 + - *124 requestBody: required: true content: application/json: - schema: *130 + schema: *133 examples: - default: *131 + default: *134 responses: '201': description: Empty response content: application/json: - schema: &150 + schema: &153 title: Empty Object description: An object without any properties. type: object @@ -19806,7 +20353,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: - - *121 + - *124 responses: '200': description: Response @@ -19815,7 +20362,7 @@ paths: schema: type: object properties: - enabled_repositories: &133 + enabled_repositories: &136 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -19829,7 +20376,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *42 - selected_actions_url: *132 + selected_actions_url: *135 required: - enabled_repositories examples: @@ -19858,7 +20405,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: - - *121 + - *124 responses: '204': description: Response @@ -19869,7 +20416,7 @@ paths: schema: type: object properties: - enabled_repositories: *133 + enabled_repositories: *136 allowed_actions: *42 required: - enabled_repositories @@ -19897,7 +20444,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: - - *121 + - *124 - *18 - *20 responses: @@ -19917,7 +20464,7 @@ paths: type: array items: *57 examples: - default: &636 + default: &639 value: total_count: 1 repositories: @@ -20057,7 +20604,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: - - *121 + - *124 responses: '204': description: Response @@ -20101,8 +20648,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: - - *121 - - &134 + - *124 + - &137 name: repository_id description: The unique identifier of the repository. in: path @@ -20130,8 +20677,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: - - *121 - - *134 + - *124 + - *137 responses: '204': description: Response @@ -20154,7 +20701,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: - - *121 + - *124 responses: '200': description: Response @@ -20185,7 +20732,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: - - *121 + - *124 responses: '204': description: Response @@ -20217,13 +20764,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: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: *135 + schema: *138 examples: default: *48 x-github: @@ -20246,7 +20793,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: - - *121 + - *124 responses: '204': description: Success response @@ -20257,7 +20804,7 @@ paths: required: false content: application/json: - schema: *136 + schema: *139 examples: default: *48 x-github: @@ -20279,7 +20826,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: - - *121 + - *124 - *18 - *20 - name: visible_to_repository @@ -20304,7 +20851,7 @@ paths: type: number runner_groups: type: array - items: &137 + items: &140 type: object properties: id: @@ -20416,7 +20963,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: - - *121 + - *124 requestBody: required: true content: @@ -20485,9 +21032,9 @@ paths: description: Response content: application/json: - schema: *137 + schema: *140 examples: - default: &138 + default: &141 value: id: 2 name: octo-runner-group @@ -20522,14 +21069,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: - - *121 + - *124 - *51 responses: '200': description: Response content: application/json: - schema: *137 + schema: *140 examples: default: value: @@ -20565,7 +21112,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: - - *121 + - *124 - *51 requestBody: required: true @@ -20616,9 +21163,9 @@ paths: description: Response content: application/json: - schema: *137 + schema: *140 examples: - default: *138 + default: *141 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -20637,7 +21184,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: - - *121 + - *124 - *51 responses: '204': @@ -20661,7 +21208,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: - - *121 + - *124 - *51 - *20 - *18 @@ -20680,9 +21227,9 @@ paths: type: number repositories: type: array - items: *139 + items: *142 examples: - default: &627 + default: &630 value: total_count: 1 repositories: @@ -20934,7 +21481,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: - - *121 + - *124 - *51 requestBody: required: true @@ -20979,9 +21526,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: - - *121 + - *124 - *51 - - *134 + - *137 responses: '204': description: Response @@ -21003,9 +21550,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: - - *121 + - *124 - *51 - - *134 + - *137 responses: '204': description: Response @@ -21028,7 +21575,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: - - *121 + - *124 - *51 - *18 - *20 @@ -21070,7 +21617,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: - - *121 + - *124 - *51 requestBody: required: true @@ -21115,7 +21662,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: - - *121 + - *124 - *51 - *54 responses: @@ -21139,7 +21686,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: - - *121 + - *124 - *51 - *54 responses: @@ -21171,7 +21718,7 @@ paths: in: query schema: type: string - - *121 + - *124 - *18 - *20 responses: @@ -21215,7 +21762,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: - - *121 + - *124 responses: '200': description: Response @@ -21223,9 +21770,9 @@ paths: application/json: schema: type: array - items: *140 + items: *143 examples: - default: *141 + default: *144 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21247,7 +21794,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: - - *121 + - *124 requestBody: required: true content: @@ -21290,7 +21837,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *142 + '201': *145 '404': *7 '422': *8 x-github: @@ -21320,7 +21867,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: - - *121 + - *124 responses: '201': description: Response @@ -21328,7 +21875,7 @@ paths: application/json: schema: *58 examples: - default: *143 + default: *146 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21356,7 +21903,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: - - *121 + - *124 responses: '201': description: Response @@ -21364,7 +21911,7 @@ paths: application/json: schema: *58 examples: - default: *144 + default: *147 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21386,7 +21933,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: - - *121 + - *124 - *54 responses: '200': @@ -21395,7 +21942,7 @@ paths: application/json: schema: *55 examples: - default: *145 + default: *148 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21416,7 +21963,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: - - *121 + - *124 - *54 responses: '204': @@ -21442,7 +21989,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: - - *121 + - *124 - *54 responses: '200': *60 @@ -21467,7 +22014,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: - - *121 + - *124 - *54 requestBody: required: true @@ -21516,7 +22063,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: - - *121 + - *124 - *54 requestBody: required: true @@ -21566,10 +22113,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: - - *121 + - *124 - *54 responses: - '200': *146 + '200': *149 '404': *7 x-github: githubCloudOnly: false @@ -21596,9 +22143,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: - - *121 + - *124 - *54 - - *147 + - *150 responses: '200': *60 '404': *7 @@ -21625,7 +22172,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *121 + - *124 - *18 - *20 responses: @@ -21643,7 +22190,7 @@ paths: type: integer secrets: type: array - items: &148 + items: &151 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -21716,13 +22263,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: &331 + schema: &334 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -21751,7 +22298,7 @@ paths: - key_id - key examples: - default: &332 + default: &335 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -21776,8 +22323,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *121 - - &149 + - *124 + - &152 name: secret_name description: The name of the secret. in: path @@ -21789,7 +22336,7 @@ paths: description: Response content: application/json: - schema: *148 + schema: *151 examples: default: value: @@ -21819,8 +22366,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *121 - - *149 + - *124 + - *152 requestBody: required: true content: @@ -21875,7 +22422,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -21901,8 +22448,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *121 - - *149 + - *124 + - *152 responses: '204': description: Response @@ -21928,8 +22475,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: - - *121 - - *149 + - *124 + - *152 - *20 - *18 responses: @@ -21947,9 +22494,9 @@ paths: type: integer repositories: type: array - items: *139 + items: *142 examples: - default: &153 + default: &156 value: total_count: 1 repositories: @@ -22041,8 +22588,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: - - *121 - - *149 + - *124 + - *152 requestBody: required: true content: @@ -22094,8 +22641,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: - - *121 - - *149 + - *124 + - *152 - name: repository_id in: path required: true @@ -22128,8 +22675,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: - - *121 - - *149 + - *124 + - *152 - name: repository_id in: path required: true @@ -22161,8 +22708,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *121 - - &316 + - *124 + - &319 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)." @@ -22186,7 +22733,7 @@ paths: type: integer variables: type: array - items: &151 + items: &154 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -22271,7 +22818,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *121 + - *124 requestBody: required: true content: @@ -22319,7 +22866,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -22344,8 +22891,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *121 - - &152 + - *124 + - &155 name: name description: The name of the variable. in: path @@ -22357,7 +22904,7 @@ paths: description: Response content: application/json: - schema: *151 + schema: *154 examples: default: value: @@ -22387,8 +22934,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *121 - - *152 + - *124 + - *155 requestBody: required: true content: @@ -22450,8 +22997,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *121 - - *152 + - *124 + - *155 responses: '204': description: Response @@ -22477,8 +23024,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: - - *121 - - *152 + - *124 + - *155 - *20 - *18 responses: @@ -22496,9 +23043,9 @@ paths: type: integer repositories: type: array - items: *139 + items: *142 examples: - default: *153 + default: *156 '409': description: Response when the visibility of the variable is not set to `selected` @@ -22524,8 +23071,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: - - *121 - - *152 + - *124 + - *155 requestBody: required: true content: @@ -22574,8 +23121,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: - - *121 - - *152 + - *124 + - *155 - name: repository_id in: path required: true @@ -22609,8 +23156,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: - - *121 - - *152 + - *124 + - *155 - name: repository_id in: path required: true @@ -22641,7 +23188,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *121 + - *124 responses: '200': description: Response @@ -22668,11 +23215,11 @@ paths: required: true content: application/json: - schema: *154 + schema: *157 examples: default: *63 parameters: - - *121 + - *124 responses: '200': description: Response @@ -22696,7 +23243,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *121 + - *124 responses: '204': description: Response @@ -22724,7 +23271,7 @@ paths: - *18 - *65 - *66 - - *121 + - *124 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -22765,7 +23312,7 @@ paths: repository_id: type: integer examples: - default: &345 + default: &348 value: attestations: - bundle: @@ -22883,7 +23430,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: - - *121 + - *124 - 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). @@ -22891,10 +23438,10 @@ paths: required: false schema: type: string - - *155 - - *156 - - *157 - *158 + - *159 + - *160 + - *161 - *18 responses: '200': @@ -22903,9 +23450,9 @@ paths: application/json: schema: type: array - items: *159 + items: *162 examples: - default: *160 + default: *163 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -22922,7 +23469,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *121 + - *124 - *18 - *20 responses: @@ -22934,7 +23481,7 @@ paths: type: array items: *19 examples: - default: &210 + default: &213 value: - login: octocat id: 1 @@ -22972,8 +23519,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: - - *121 - - &161 + - *124 + - &164 name: username description: The handle for the GitHub user account. in: path @@ -23004,8 +23551,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response @@ -23025,8 +23572,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response @@ -23051,9 +23598,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: - - *121 - - *162 - - *163 + - *124 + - *165 + - *166 - *65 - *66 - *20 @@ -23064,7 +23611,7 @@ paths: be returned. in: query required: false - schema: *164 + schema: *167 - name: sort description: The property by which to sort the results. in: query @@ -23080,7 +23627,7 @@ paths: be returned. in: query required: false - schema: &372 + schema: &375 type: string description: Severity of a code scanning alert. enum: @@ -23098,9 +23645,9 @@ paths: application/json: schema: type: array - items: *165 + items: *168 examples: - default: *166 + default: *169 headers: Link: *39 '404': *7 @@ -23126,7 +23673,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: - - *121 + - *124 - name: target_type in: query description: The target type of the code security configuration @@ -23154,7 +23701,7 @@ paths: application/json: schema: type: array - items: &167 + items: &170 type: object description: A code security configuration properties: @@ -23393,7 +23940,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *121 + - *124 requestBody: required: true content: @@ -23565,9 +24112,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *167 + schema: *170 examples: - default: &168 + default: &171 value: id: 1325 target_type: organization @@ -23613,7 +24160,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *121 + - *124 responses: '200': description: Response @@ -23633,7 +24180,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *167 + configuration: *170 examples: default: value: @@ -23717,7 +24264,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *121 + - *124 requestBody: required: true content: @@ -23740,12 +24287,12 @@ paths: - 32 - 91 responses: - '204': &170 + '204': &173 description: A header with no content is returned. '400': *15 '403': *29 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23767,8 +24314,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *121 - - &169 + - *124 + - &172 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -23780,9 +24327,9 @@ paths: description: Response content: application/json: - schema: *167 + schema: *170 examples: - default: *168 + default: *171 '304': *37 '403': *29 '404': *7 @@ -23806,8 +24353,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *121 - - *169 + - *124 + - *172 requestBody: required: true content: @@ -23959,7 +24506,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *167 + schema: *170 examples: default: value: @@ -24010,14 +24557,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *121 - - *169 + - *124 + - *172 responses: - '204': *170 + '204': *173 '400': *15 '403': *29 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24041,8 +24588,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *121 - - *169 + - *124 + - *172 requestBody: required: true content: @@ -24081,7 +24628,7 @@ paths: - 32 - 91 responses: - '202': *127 + '202': *130 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24105,8 +24652,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: - - *121 - - *169 + - *124 + - *172 requestBody: required: true content: @@ -24146,12 +24693,12 @@ paths: - none - private_and_internal - public - configuration: *167 + configuration: *170 examples: default: value: default_for_new_repos: all - configuration: *168 + configuration: *171 '403': *29 '404': *7 x-github: @@ -24175,8 +24722,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: - - *121 - - *169 + - *124 + - *172 - 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)." @@ -24319,7 +24866,7 @@ paths: parameters: - *18 - *20 - - *121 + - *124 responses: '200': description: Response @@ -24335,7 +24882,7 @@ paths: type: integer codespaces: type: array - items: &211 + items: &214 type: object title: Codespace description: A codespace. @@ -24360,12 +24907,12 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *139 + repository: *142 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: &398 + properties: &401 name: type: string description: The name of the machine. @@ -24407,7 +24954,7 @@ paths: - ready - in_progress nullable: true - required: &399 + required: &402 - name - display_name - operating_system @@ -24612,7 +25159,7 @@ paths: - pulls_url - recent_folders examples: - default: &212 + default: &215 value: total_count: 3 codespaces: @@ -25044,7 +25591,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *121 + - *124 deprecated: true requestBody: required: true @@ -25111,7 +25658,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: - - *121 + - *124 deprecated: true requestBody: required: true @@ -25166,7 +25713,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *121 + - *124 requestBody: required: true content: @@ -25218,7 +25765,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *121 + - *124 - *18 - *20 responses: @@ -25236,7 +25783,7 @@ paths: type: integer secrets: type: array - items: &171 + items: &174 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -25275,7 +25822,7 @@ paths: - updated_at - visibility examples: - default: &400 + default: &403 value: total_count: 2 secrets: @@ -25307,13 +25854,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: &401 + schema: &404 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -25342,7 +25889,7 @@ paths: - key_id - key examples: - default: &402 + default: &405 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -25365,16 +25912,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *121 - - *149 + - *124 + - *152 responses: '200': description: Response content: application/json: - schema: *171 + schema: *174 examples: - default: &404 + default: &407 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -25401,8 +25948,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: - - *121 - - *149 + - *124 + - *152 requestBody: required: true content: @@ -25457,7 +26004,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -25483,8 +26030,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *121 - - *149 + - *124 + - *152 responses: '204': description: Response @@ -25509,8 +26056,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: - - *121 - - *149 + - *124 + - *152 - *20 - *18 responses: @@ -25528,9 +26075,9 @@ paths: type: integer repositories: type: array - items: *139 + items: *142 examples: - default: *153 + default: *156 '404': *7 x-github: githubCloudOnly: false @@ -25552,8 +26099,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: - - *121 - - *149 + - *124 + - *152 requestBody: required: true content: @@ -25603,8 +26150,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: - - *121 - - *149 + - *124 + - *152 - name: repository_id in: path required: true @@ -25637,8 +26184,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: - - *121 - - *149 + - *124 + - *152 - name: repository_id in: path required: true @@ -25677,7 +26224,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: - - *121 + - *124 responses: '200': description: OK @@ -25817,7 +26364,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: - - *121 + - *124 - *20 - name: per_page description: The number of results per page (max 100). For more information, @@ -25840,9 +26387,9 @@ paths: currently being billed. seats: type: array - items: *172 + items: *175 examples: - default: *173 + default: *176 headers: Link: *39 '500': *73 @@ -25880,7 +26427,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: - - *121 + - *124 requestBody: content: application/json: @@ -25958,7 +26505,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: - - *121 + - *124 requestBody: content: application/json: @@ -26039,7 +26586,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: - - *121 + - *124 requestBody: content: application/json: @@ -26117,7 +26664,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: - - *121 + - *124 requestBody: content: application/json: @@ -26173,6 +26720,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: + - *124 + - 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 + - *20 + - 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: *87 + examples: + default: *88 + '500': *73 + '403': *29 + '404': *7 + '422': *89 + 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 @@ -26198,7 +26813,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: - - *121 + - *124 - 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`). @@ -26230,9 +26845,9 @@ paths: application/json: schema: type: array - items: *87 + items: *90 examples: - default: *174 + default: *177 '500': *73 '401': *25 '403': *29 @@ -26258,7 +26873,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: - - *121 + - *124 - *18 - name: page description: Page token @@ -26402,7 +27017,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: - - *121 + - *124 - name: credential_id in: path required: true @@ -26433,7 +27048,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: - - *121 + - *124 responses: '200': description: Response - list of custom role names @@ -26448,7 +27063,7 @@ paths: type: integer custom_roles: type: array - items: *175 + items: *178 examples: default: value: @@ -26535,12 +27150,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *121 + - *124 requestBody: required: true content: application/json: - schema: &178 + schema: &181 type: object properties: name: @@ -26581,9 +27196,9 @@ paths: description: Response content: application/json: - schema: *175 + schema: *178 examples: - default: *176 + default: *179 '422': *16 '404': *7 x-github: @@ -26607,8 +27222,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *121 - - &177 + - *124 + - &180 name: role_id description: The unique identifier of the role. in: path @@ -26620,9 +27235,9 @@ paths: description: Response content: application/json: - schema: *175 + schema: *178 examples: - default: *176 + default: *179 '404': *7 x-github: githubCloudOnly: true @@ -26644,13 +27259,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *121 - - *177 + - *124 + - *180 requestBody: required: true content: application/json: - schema: &179 + schema: &182 type: object properties: name: @@ -26688,9 +27303,9 @@ paths: description: Response content: application/json: - schema: *175 + schema: *178 examples: - default: *176 + default: *179 '422': *16 '404': *7 x-github: @@ -26714,8 +27329,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *121 - - *177 + - *124 + - *180 responses: '204': description: Response @@ -26743,12 +27358,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: - - *121 + - *124 requestBody: required: true content: application/json: - schema: *178 + schema: *181 examples: default: value: @@ -26762,9 +27377,9 @@ paths: description: Response content: application/json: - schema: *175 + schema: *178 examples: - default: *176 + default: *179 '422': *16 '404': *7 x-github: @@ -26794,16 +27409,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: - - *121 - - *177 + - *124 + - *180 responses: '200': description: Response content: application/json: - schema: *175 + schema: *178 examples: - default: *176 + default: *179 '404': *7 x-github: githubCloudOnly: true @@ -26831,13 +27446,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: - - *121 - - *177 + - *124 + - *180 requestBody: required: true content: application/json: - schema: *179 + schema: *182 examples: default: value: @@ -26852,9 +27467,9 @@ paths: description: Response content: application/json: - schema: *175 + schema: *178 examples: - default: *176 + default: *179 '422': *16 '404': *7 x-github: @@ -26884,8 +27499,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: - - *121 - - *177 + - *124 + - *180 responses: '204': description: Response @@ -26913,18 +27528,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *121 - - *180 - - *181 - - *182 + - *124 - *183 - *184 - *185 + - *186 + - *187 + - *188 - *67 - *65 - *66 - - *186 - - *187 + - *189 + - *190 - *18 responses: '200': @@ -26933,9 +27548,9 @@ paths: application/json: schema: type: array - items: *188 + items: *191 examples: - default: *189 + default: *192 '304': *37 '400': *15 '403': *29 @@ -26961,7 +27576,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *121 + - *124 - *18 - *20 responses: @@ -26979,7 +27594,7 @@ paths: type: integer secrets: type: array - items: &190 + items: &193 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -27050,13 +27665,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: &431 + schema: &434 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -27073,7 +27688,7 @@ paths: - key_id - key examples: - default: &432 + default: &435 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -27096,14 +27711,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *121 - - *149 + - *124 + - *152 responses: '200': description: Response content: application/json: - schema: *190 + schema: *193 examples: default: value: @@ -27131,8 +27746,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *121 - - *149 + - *124 + - *152 requestBody: required: true content: @@ -27187,7 +27802,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -27211,8 +27826,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *121 - - *149 + - *124 + - *152 responses: '204': description: Response @@ -27236,8 +27851,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: - - *121 - - *149 + - *124 + - *152 - *20 - *18 responses: @@ -27255,9 +27870,9 @@ paths: type: integer repositories: type: array - items: *139 + items: *142 examples: - default: *153 + default: *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -27278,8 +27893,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: - - *121 - - *149 + - *124 + - *152 requestBody: required: true content: @@ -27329,8 +27944,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: - - *121 - - *149 + - *124 + - *152 - name: repository_id in: path required: true @@ -27361,8 +27976,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: - - *121 - - *149 + - *124 + - *152 - name: repository_id in: path required: true @@ -27392,7 +28007,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: - - *121 + - *124 responses: '200': description: Response @@ -27400,7 +28015,7 @@ paths: application/json: schema: type: array - items: &223 + items: &226 title: Package description: A software package type: object @@ -27450,8 +28065,8 @@ paths: title: Minimal Repository description: Minimal Repository type: object - properties: *191 - required: *192 + properties: *194 + required: *195 nullable: true created_at: type: string @@ -27470,7 +28085,7 @@ paths: - created_at - updated_at examples: - default: &224 + default: &227 value: - id: 197 name: hello_docker @@ -27548,7 +28163,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *121 + - *124 - *18 - *20 responses: @@ -27558,7 +28173,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: 200-response: value: @@ -27628,7 +28243,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *121 + - *124 - name: group_id description: The unique identifier of the group. in: path @@ -27654,7 +28269,7 @@ paths: description: Response content: application/json: - schema: &287 + schema: &290 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -27735,7 +28350,7 @@ paths: example: mona_lisa@github.com type: string examples: - default: &288 + default: &291 value: group_id: '123' group_name: Octocat admins @@ -27773,7 +28388,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: - - *121 + - *124 - *18 - name: page description: Page token @@ -27790,7 +28405,7 @@ paths: description: Response content: application/json: - schema: &285 + schema: &288 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -27827,7 +28442,7 @@ paths: example: 2019-06-03 22:27:15:000 -700 type: string examples: - default: &286 + default: &289 value: groups: - group_id: '123' @@ -27861,7 +28476,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *121 + - *124 - *18 - *20 responses: @@ -27871,7 +28486,7 @@ paths: application/json: schema: type: array - items: &204 + items: &207 title: Organization Invitation description: Organization Invitation type: object @@ -27918,7 +28533,7 @@ paths: - invitation_teams_url - node_id examples: - default: &205 + default: &208 value: - id: 1 login: monalisa @@ -27977,7 +28592,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: - - *121 + - *124 responses: '200': description: Response @@ -27985,7 +28600,7 @@ paths: application/json: schema: type: array - items: &245 + items: &248 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -27999,7 +28614,7 @@ paths: - name - description examples: - default: &246 + default: &249 value: - name: add_assignee description: Assign or remove a user @@ -28030,7 +28645,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *121 + - *124 - *18 - *20 responses: @@ -28040,7 +28655,7 @@ paths: application/json: schema: type: array - items: &193 + items: &196 title: Org Hook description: Org Hook type: object @@ -28149,7 +28764,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *121 + - *124 requestBody: required: true content: @@ -28209,9 +28824,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *196 examples: - default: &194 + default: &197 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -28255,8 +28870,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *121 - - &195 + - *124 + - &198 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. @@ -28269,9 +28884,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *196 examples: - default: *194 + default: *197 '404': *7 x-github: githubCloudOnly: false @@ -28292,8 +28907,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *121 - - *195 + - *124 + - *198 requestBody: required: false content: @@ -28338,7 +28953,7 @@ paths: description: Response content: application/json: - schema: *193 + schema: *196 examples: default: value: @@ -28377,8 +28992,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *121 - - *195 + - *124 + - *198 responses: '204': description: Response @@ -28403,8 +29018,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: - - *121 - - *195 + - *124 + - *198 responses: '200': description: Response @@ -28432,8 +29047,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: - - *121 - - *195 + - *124 + - *198 requestBody: required: false content: @@ -28481,10 +29096,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *121 - - *195 + - *124 + - *198 - *18 - - *196 + - *199 - name: redelivery in: query required: false @@ -28497,9 +29112,9 @@ paths: application/json: schema: type: array - items: *197 + items: *200 examples: - default: *198 + default: *201 '400': *15 '422': *16 x-github: @@ -28522,17 +29137,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: - - *121 - - *195 + - *124 + - *198 - *17 responses: '200': description: Response content: application/json: - schema: *199 + schema: *202 examples: - default: *200 + default: *203 '400': *15 '422': *16 x-github: @@ -28555,11 +29170,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: - - *121 - - *195 + - *124 + - *198 - *17 responses: - '202': *127 + '202': *130 '400': *15 '422': *16 x-github: @@ -28582,8 +29197,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *121 - - *195 + - *124 + - *198 responses: '204': description: Response @@ -28607,7 +29222,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: - - *121 + - *124 responses: '200': description: Response @@ -28615,7 +29230,7 @@ paths: application/json: schema: *22 examples: - default: &470 + default: &473 value: id: 1 account: @@ -28684,7 +29299,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *121 + - *124 - *18 - *20 responses: @@ -28773,7 +29388,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *121 + - *124 responses: '200': description: Response @@ -28781,12 +29396,12 @@ paths: application/json: schema: anyOf: - - &202 + - &205 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &201 + limit: &204 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -28811,7 +29426,7 @@ paths: properties: {} additionalProperties: false examples: - default: &203 + default: &206 value: limit: collaborators_only origin: organization @@ -28835,18 +29450,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *121 + - *124 requestBody: required: true content: application/json: - schema: &471 + schema: &474 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *201 + limit: *204 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -28870,9 +29485,9 @@ paths: description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *203 + default: *206 '422': *16 x-github: githubCloudOnly: false @@ -28890,7 +29505,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *121 + - *124 responses: '204': description: Response @@ -28916,7 +29531,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *121 + - *124 - *18 - *20 - name: role @@ -28950,9 +29565,9 @@ paths: application/json: schema: type: array - items: *204 + items: *207 examples: - default: *205 + default: *208 headers: Link: *39 '404': *7 @@ -28976,7 +29591,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *121 + - *124 requestBody: required: false content: @@ -29030,7 +29645,7 @@ paths: description: Response content: application/json: - schema: *204 + schema: *207 examples: default: value: @@ -29086,8 +29701,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *121 - - &206 + - *124 + - &209 name: invitation_id description: The unique identifier of the invitation. in: path @@ -29120,8 +29735,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *121 - - *206 + - *124 + - *209 - *18 - *20 responses: @@ -29131,9 +29746,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - default: &222 + default: &225 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -29178,7 +29793,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: - - *121 + - *124 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -29208,7 +29823,7 @@ paths: - closed - all default: open - - *208 + - *211 - name: sort description: What to sort results by. in: query @@ -29221,7 +29836,7 @@ paths: - comments default: created - *67 - - *94 + - *97 - *18 - *20 responses: @@ -29231,9 +29846,9 @@ paths: application/json: schema: type: array - items: *104 + items: *107 examples: - default: *209 + default: *212 headers: Link: *39 '404': *7 @@ -29255,7 +29870,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *121 + - *124 - 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) @@ -29291,7 +29906,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 '422': *16 @@ -29311,8 +29926,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response if requester is an organization member and user is @@ -29343,8 +29958,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response @@ -29370,8 +29985,8 @@ paths: parameters: - *18 - *20 - - *121 - - *161 + - *124 + - *164 responses: '200': description: Response @@ -29387,9 +30002,9 @@ paths: type: integer codespaces: type: array - items: *211 + items: *214 examples: - default: *212 + default: *215 '304': *37 '500': *73 '401': *25 @@ -29414,9 +30029,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *121 - - *161 - - &213 + - *124 + - *164 + - &216 name: codespace_name in: path required: true @@ -29424,7 +30039,7 @@ paths: schema: type: string responses: - '202': *127 + '202': *130 '304': *37 '500': *73 '401': *25 @@ -29449,17 +30064,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: - - *121 - - *161 - - *213 + - *124 + - *164 + - *216 responses: '200': description: Response content: application/json: - schema: *211 + schema: *214 examples: - default: &397 + default: &400 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -29629,14 +30244,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: - - *121 - - *161 + - *124 + - *164 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *172 + schema: *175 examples: default: value: @@ -29704,14 +30319,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *121 - - *161 + - *124 + - *164 responses: '200': description: Response content: application/json: - schema: &214 + schema: &217 title: Org Membership description: Org Membership type: object @@ -29763,7 +30378,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &215 + response-if-user-has-an-active-admin-membership-with-organization: &218 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -29831,8 +30446,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *121 - - *161 + - *124 + - *164 requestBody: required: false content: @@ -29860,9 +30475,9 @@ paths: description: Response content: application/json: - schema: *214 + schema: *217 examples: - response-if-user-already-had-membership-with-organization: *215 + response-if-user-already-had-membership-with-organization: *218 '422': *16 '403': *29 x-github: @@ -29883,8 +30498,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response @@ -29909,7 +30524,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *121 + - *124 - *18 - *20 - name: exclude @@ -29930,7 +30545,7 @@ paths: application/json: schema: type: array - items: &216 + items: &219 title: Migration description: A migration. type: object @@ -30183,7 +30798,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *121 + - *124 requestBody: required: true content: @@ -30259,7 +30874,7 @@ paths: description: Response content: application/json: - schema: *216 + schema: *219 examples: default: value: @@ -30437,8 +31052,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *121 - - &217 + - *124 + - &220 name: migration_id description: The unique identifier of the migration. in: path @@ -30465,7 +31080,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *216 + schema: *219 examples: default: value: @@ -30634,8 +31249,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *121 - - *217 + - *124 + - *220 responses: '302': description: Response @@ -30656,8 +31271,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *121 - - *217 + - *124 + - *220 responses: '204': description: Response @@ -30680,9 +31295,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *121 - - *217 - - &641 + - *124 + - *220 + - &644 name: repo_name description: repo_name parameter in: path @@ -30709,8 +31324,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *121 - - *217 + - *124 + - *220 - *18 - *20 responses: @@ -30720,9 +31335,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: &229 + default: &232 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -30861,7 +31476,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: - - *121 + - *124 responses: '200': description: Response @@ -30915,7 +31530,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: - - *121 + - *124 responses: '200': description: Response - list of organization roles @@ -30931,7 +31546,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &218 + items: &221 title: Organization Role description: Organization roles type: object @@ -31071,7 +31686,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *121 + - *124 requestBody: required: true content: @@ -31118,7 +31733,7 @@ paths: description: Response content: application/json: - schema: *218 + schema: *221 examples: default: value: @@ -31147,7 +31762,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *16 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -31169,8 +31784,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: - - *121 - - *219 + - *124 + - *222 responses: '204': description: Response @@ -31195,9 +31810,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: - - *121 - - *219 - - *177 + - *124 + - *222 + - *180 responses: '204': description: Response @@ -31226,9 +31841,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: - - *121 - - *219 - - *177 + - *124 + - *222 + - *180 responses: '204': description: Response @@ -31253,8 +31868,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: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response @@ -31279,9 +31894,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: - - *121 - - *161 - - *177 + - *124 + - *164 + - *180 responses: '204': description: Response @@ -31311,9 +31926,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: - - *121 - - *161 - - *177 + - *124 + - *164 + - *180 responses: '204': description: Response @@ -31341,14 +31956,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *121 - - *177 + - *124 + - *180 responses: '200': description: Response content: application/json: - schema: *218 + schema: *221 examples: default: value: @@ -31405,8 +32020,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *121 - - *177 + - *124 + - *180 requestBody: required: true content: @@ -31445,7 +32060,7 @@ paths: description: Response content: application/json: - schema: *218 + schema: *221 examples: default: value: @@ -31473,7 +32088,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *16 - '409': *126 + '409': *129 '404': *7 x-github: githubCloudOnly: true @@ -31498,8 +32113,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *121 - - *177 + - *124 + - *180 responses: '204': description: Response @@ -31524,8 +32139,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: - - *121 - - *177 + - *124 + - *180 - *18 - *20 responses: @@ -31594,8 +32209,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *220 - required: *221 + properties: *223 + required: *224 nullable: true required: - id @@ -31610,7 +32225,7 @@ paths: - slug - parent examples: - default: *222 + default: *225 headers: Link: *39 '404': @@ -31639,8 +32254,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: - - *121 - - *177 + - *124 + - *180 - *18 - *20 responses: @@ -31750,7 +32365,7 @@ paths: - type - url examples: - default: *210 + default: *213 headers: Link: *39 '404': @@ -31774,7 +32389,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: - - *121 + - *124 - 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) @@ -31798,7 +32413,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 x-github: @@ -31823,8 +32438,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: - - *121 - - *161 + - *124 + - *164 requestBody: required: false content: @@ -31881,8 +32496,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: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response @@ -31939,8 +32554,8 @@ paths: - docker - nuget - container - - *121 - - &643 + - *124 + - &646 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -31976,12 +32591,12 @@ paths: application/json: schema: type: array - items: *223 + items: *226 examples: - default: *224 + default: *227 '403': *29 '401': *25 - '400': &645 + '400': &648 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -32003,7 +32618,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &225 + - &228 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 @@ -32021,20 +32636,20 @@ paths: - docker - nuget - container - - &226 + - &229 name: package_name description: The name of the package. in: path required: true schema: type: string - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: *223 + schema: *226 examples: default: value: @@ -32086,9 +32701,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *225 - - *226 - - *121 + - *228 + - *229 + - *124 responses: '204': description: Response @@ -32120,9 +32735,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *225 - - *226 - - *121 + - *228 + - *229 + - *124 - name: token description: package token schema: @@ -32154,9 +32769,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: - - *225 - - *226 - - *121 + - *228 + - *229 + - *124 - *20 - *18 - name: state @@ -32176,7 +32791,7 @@ paths: application/json: schema: type: array - items: &227 + items: &230 title: Package Version description: A version of a software package type: object @@ -32301,10 +32916,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: - - *225 - - *226 - - *121 - - &228 + - *228 + - *229 + - *124 + - &231 name: package_version_id description: Unique identifier of the package version. in: path @@ -32316,7 +32931,7 @@ paths: description: Response content: application/json: - schema: *227 + schema: *230 examples: default: value: @@ -32352,10 +32967,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *225 - - *226 - - *121 - *228 + - *229 + - *124 + - *231 responses: '204': description: Response @@ -32387,10 +33002,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *225 - - *226 - - *121 - *228 + - *229 + - *124 + - *231 responses: '204': description: Response @@ -32417,10 +33032,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: - - *121 + - *124 - *18 - *20 - - &230 + - &233 name: sort description: The property by which to sort the results. in: query @@ -32431,7 +33046,7 @@ paths: - created_at default: created_at - *67 - - &231 + - &234 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -32442,7 +33057,7 @@ paths: items: type: string example: owner[]=octocat1,owner[]=octocat2 - - &232 + - &235 name: repository description: The name of the repository to use to filter the results. in: query @@ -32450,7 +33065,7 @@ paths: schema: type: string example: Hello-World - - &233 + - &236 name: permission description: The permission to use to filter the results. in: query @@ -32458,7 +33073,7 @@ paths: schema: type: string example: issues_read - - &234 + - &237 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) @@ -32468,7 +33083,7 @@ paths: schema: type: string format: date-time - - &235 + - &238 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) @@ -32617,7 +33232,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: - - *121 + - *124 requestBody: required: true content: @@ -32662,7 +33277,7 @@ paths: '422': *16 '404': *7 '403': *29 - '202': *127 + '202': *130 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32683,7 +33298,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: - - *121 + - *124 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -32723,7 +33338,7 @@ paths: '422': *16 '404': *7 '403': *29 - '204': *170 + '204': *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -32744,7 +33359,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: - - *121 + - *124 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -32764,9 +33379,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 x-github: @@ -32789,16 +33404,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: - - *121 + - *124 - *18 - *20 - - *230 - - *67 - - *231 - - *232 - *233 + - *67 - *234 - *235 + - *236 + - *237 + - *238 responses: '500': *73 '422': *16 @@ -32933,7 +33548,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: - - *121 + - *124 requestBody: required: true content: @@ -32970,7 +33585,7 @@ paths: responses: '500': *73 '404': *7 - '202': *127 + '202': *130 '403': *29 '422': *16 x-github: @@ -32993,7 +33608,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: - - *121 + - *124 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -33023,7 +33638,7 @@ paths: responses: '500': *73 '404': *7 - '204': *170 + '204': *173 '403': *29 '422': *16 x-github: @@ -33045,7 +33660,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: - - *121 + - *124 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -33064,9 +33679,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 x-github: @@ -33088,7 +33703,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-organization-projects parameters: - - *121 + - *124 - name: state description: Indicates the state of the projects to return. in: query @@ -33109,7 +33724,7 @@ paths: application/json: schema: type: array - items: &236 + items: &239 title: Project description: Projects are a way to organize columns and cards of work. @@ -33253,7 +33868,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-an-organization-project parameters: - - *121 + - *124 requestBody: required: true content: @@ -33279,7 +33894,7 @@ paths: description: Response content: application/json: - schema: *236 + schema: *239 examples: default: value: @@ -33317,7 +33932,7 @@ paths: '401': *25 '403': *29 '404': *7 - '410': &303 + '410': &306 description: Gone content: application/json: @@ -33341,7 +33956,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: - - *121 + - *124 responses: '200': description: Response @@ -33349,7 +33964,7 @@ paths: application/json: schema: type: array - items: &237 + items: &240 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -33408,7 +34023,7 @@ paths: - property_name - value_type examples: - default: &238 + default: &241 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -33449,7 +34064,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: - - *121 + - *124 requestBody: required: true content: @@ -33460,7 +34075,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *237 + items: *240 minItems: 1 maxItems: 100 required: @@ -33490,9 +34105,9 @@ paths: application/json: schema: type: array - items: *237 + items: *240 examples: - default: *238 + default: *241 '403': *29 '404': *7 x-github: @@ -33513,8 +34128,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: - - *121 - - &239 + - *124 + - &242 name: custom_property_name description: The custom property name in: path @@ -33526,9 +34141,9 @@ paths: description: Response content: application/json: - schema: *237 + schema: *240 examples: - default: &240 + default: &243 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -33561,8 +34176,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: - - *121 - - *239 + - *124 + - *242 requestBody: required: true content: @@ -33621,9 +34236,9 @@ paths: description: Response content: application/json: - schema: *237 + schema: *240 examples: - default: *240 + default: *243 '403': *29 '404': *7 x-github: @@ -33646,10 +34261,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: - - *121 - - *239 + - *124 + - *242 responses: - '204': *170 + '204': *173 '403': *29 '404': *7 x-github: @@ -33670,7 +34285,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: - - *121 + - *124 - *18 - *20 - name: repository_query @@ -33708,7 +34323,7 @@ paths: example: octocat/Hello-World properties: type: array - items: &241 + items: &244 title: Custom Property Value description: Custom property name and associated value type: object @@ -33775,7 +34390,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: - - *121 + - *124 requestBody: required: true content: @@ -33795,7 +34410,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *241 + items: *244 required: - repository_names - properties @@ -33836,7 +34451,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *121 + - *124 - *18 - *20 responses: @@ -33848,7 +34463,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 x-github: @@ -33867,8 +34482,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: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response if user is a public member @@ -33892,8 +34507,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: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response @@ -33914,8 +34529,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: - - *121 - - *161 + - *124 + - *164 responses: '204': description: Response @@ -33939,7 +34554,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *121 + - *124 - 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 @@ -33986,9 +34601,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 x-github: @@ -34009,7 +34624,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *121 + - *124 requestBody: required: true content: @@ -34191,7 +34806,7 @@ paths: description: Response content: application/json: - schema: &305 + schema: &308 title: Full Repository description: Full Repository type: object @@ -34468,8 +35083,8 @@ paths: title: Repository description: A repository on GitHub. type: object - properties: *242 - required: *243 + properties: *245 + required: *246 nullable: true temp_clone_token: type: string @@ -34556,8 +35171,8 @@ paths: title: License Simple description: License Simple type: object - properties: *105 - required: *106 + properties: *108 + required: *109 nullable: true organization: title: Simple User @@ -34584,7 +35199,7 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: &419 + properties: &422 url: type: string format: uri @@ -34600,12 +35215,12 @@ paths: nullable: true format: uri example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md - required: &420 + required: &423 - url - key - name - html_url - security_and_analysis: *244 + security_and_analysis: *247 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -34689,7 +35304,7 @@ paths: - network_count - subscribers_count examples: - default: &307 + default: &310 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -35207,7 +35822,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: - - *121 + - *124 responses: '200': description: Response @@ -35215,9 +35830,9 @@ paths: application/json: schema: type: array - items: *245 + items: *248 examples: - default: *246 + default: *249 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -35239,10 +35854,10 @@ paths: category: orgs subcategory: rules parameters: - - *121 + - *124 - *18 - *20 - - &555 + - &558 name: targets description: | A comma-separated list of rule targets to filter by. @@ -35260,7 +35875,7 @@ paths: application/json: schema: type: array - items: &253 + items: &256 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -35293,7 +35908,7 @@ paths: source: type: string description: The name of the source - enforcement: &249 + enforcement: &252 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -35305,7 +35920,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &250 + items: &253 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -35372,7 +35987,7 @@ paths: conditions: nullable: true anyOf: - - &247 + - &250 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -35396,7 +36011,7 @@ paths: match. items: type: string - - &251 + - &254 title: Organization ruleset conditions type: object description: |- @@ -35409,7 +36024,7 @@ paths: description: Conditions to target repositories by name and refs by name allOf: - - *247 + - *250 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -35443,7 +36058,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *247 + - *250 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -35465,7 +36080,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *247 + - *250 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -35478,7 +36093,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &248 + items: &251 title: Repository ruleset property targeting definition type: object @@ -35511,17 +36126,17 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *248 + items: *251 required: - repository_property rules: type: array - items: &252 + items: &255 title: Repository Rule type: object description: A repository rule. oneOf: - - &537 + - &540 title: creation description: Only allow users with bypass permission to create matching refs. @@ -35533,7 +36148,7 @@ paths: type: string enum: - creation - - &538 + - &541 title: update description: Only allow users with bypass permission to update matching refs. @@ -35554,7 +36169,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &540 + - &543 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -35566,7 +36181,7 @@ paths: type: string enum: - deletion - - &541 + - &544 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -35578,7 +36193,7 @@ paths: type: string enum: - required_linear_history - - &542 + - &545 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -35656,7 +36271,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &543 + - &546 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -35680,7 +36295,7 @@ paths: type: string required: - required_deployment_environments - - &544 + - &547 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -35692,7 +36307,7 @@ paths: type: string enum: - required_signatures - - &545 + - &548 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -35738,7 +36353,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &546 + - &549 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -35786,7 +36401,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &547 + - &550 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -35798,7 +36413,7 @@ paths: type: string enum: - non_fast_forward - - &548 + - &551 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -35834,7 +36449,7 @@ paths: required: - operator - pattern - - &549 + - &552 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -35870,7 +36485,7 @@ paths: required: - operator - pattern - - &550 + - &553 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -35906,7 +36521,7 @@ paths: required: - operator - pattern - - &551 + - &554 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -35942,7 +36557,7 @@ paths: required: - operator - pattern - - &552 + - &555 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -36068,7 +36683,7 @@ paths: maximum: 100 required: - max_file_size - - &553 + - &556 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -36118,7 +36733,7 @@ paths: - repository_id required: - workflows - - &554 + - &557 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -36231,7 +36846,7 @@ paths: category: orgs subcategory: rules parameters: - - *121 + - *124 requestBody: description: Request body required: true @@ -36251,16 +36866,16 @@ paths: - tag - push default: branch - enforcement: *249 + enforcement: *252 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *250 - conditions: *251 + items: *253 + conditions: *254 rules: type: array description: An array of rules within the ruleset. - items: *252 + items: *255 required: - name - enforcement @@ -36298,9 +36913,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: &254 + default: &257 value: id: 21 name: super cool ruleset @@ -36354,8 +36969,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *121 - - &556 + - *124 + - &559 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 @@ -36371,7 +36986,7 @@ paths: in: query schema: type: integer - - &557 + - &560 name: time_period description: |- The time period to filter by. @@ -36387,14 +37002,14 @@ paths: - week - month default: day - - &558 + - &561 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 - - &559 + - &562 name: rule_suite_result description: The rule results to filter on. When specified, only suites with this result will be returned. @@ -36414,7 +37029,7 @@ paths: description: Response content: application/json: - schema: &560 + schema: &563 title: Rule Suites description: Response type: array @@ -36469,7 +37084,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &561 + default: &564 value: - id: 21 actor_id: 12 @@ -36512,8 +37127,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *121 - - &562 + - *124 + - &565 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -36529,7 +37144,7 @@ paths: description: Response content: application/json: - schema: &563 + schema: &566 title: Rule Suite description: Response type: object @@ -36628,7 +37243,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &564 + default: &567 value: id: 21 actor_id: 12 @@ -36689,7 +37304,7 @@ paths: category: orgs subcategory: rules parameters: - - *121 + - *124 - name: ruleset_id description: The ID of the ruleset. in: path @@ -36701,9 +37316,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: *254 + default: *257 '404': *7 '500': *73 put: @@ -36721,7 +37336,7 @@ paths: category: orgs subcategory: rules parameters: - - *121 + - *124 - name: ruleset_id description: The ID of the ruleset. in: path @@ -36746,16 +37361,16 @@ paths: - branch - tag - push - enforcement: *249 + enforcement: *252 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *250 - conditions: *251 + items: *253 + conditions: *254 rules: description: An array of rules within the ruleset. type: array - items: *252 + items: *255 examples: default: value: @@ -36790,9 +37405,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: *254 + default: *257 '404': *7 '500': *73 delete: @@ -36810,7 +37425,7 @@ paths: category: orgs subcategory: rules parameters: - - *121 + - *124 - name: ruleset_id description: The ID of the ruleset. in: path @@ -36838,15 +37453,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: - - *121 - - *255 - - *256 - - *257 + - *124 - *258 + - *259 + - *260 + - *261 - *67 - *20 - *18 - - &566 + - &569 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 @@ -36856,7 +37471,7 @@ paths: required: false schema: type: string - - &567 + - &570 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 @@ -36866,9 +37481,9 @@ paths: required: false schema: type: string - - *259 - - *260 - - *261 + - *262 + - *263 + - *264 responses: '200': description: Response @@ -36876,9 +37491,9 @@ paths: application/json: schema: type: array - items: *262 + items: *265 examples: - default: *263 + default: *266 headers: Link: *39 '404': *7 @@ -36904,7 +37519,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: - - *121 + - *124 - *67 - name: sort description: The property to sort the results by. @@ -36948,7 +37563,7 @@ paths: application/json: schema: type: array - items: &573 + items: &576 description: A repository security advisory. type: object properties: @@ -37168,7 +37783,7 @@ paths: login: type: string description: The username of the user credited. - type: *264 + type: *267 credits_detailed: type: array nullable: true @@ -37178,7 +37793,7 @@ paths: type: object properties: user: *19 - type: *264 + type: *267 state: type: string description: The state of the user's acceptance of the @@ -37202,7 +37817,7 @@ paths: type: array description: A list of teams that collaborate on the advisory. nullable: true - items: *207 + items: *210 private_fork: readOnly: true nullable: true @@ -37239,7 +37854,7 @@ paths: - private_fork additionalProperties: false examples: - default: &574 + default: &577 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -37621,7 +38236,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *121 + - *124 responses: '200': description: Response @@ -37629,15 +38244,15 @@ paths: application/json: schema: type: array - items: &516 + items: &519 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *220 - required: *221 + properties: *223 + required: *224 examples: - default: *222 + default: *225 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37660,8 +38275,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *121 - - *219 + - *124 + - *222 responses: '204': description: Response @@ -37686,8 +38301,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *121 - - *219 + - *124 + - *222 responses: '204': description: Response @@ -37713,15 +38328,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: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: *265 + schema: *268 examples: - default: *266 + default: *269 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -37745,7 +38360,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: - - *121 + - *124 - *18 - *20 responses: @@ -37753,9 +38368,9 @@ paths: description: Success content: application/json: - schema: *267 + schema: *270 examples: - default: *268 + default: *271 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -37777,15 +38392,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: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -37807,15 +38422,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: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: *271 + schema: *274 examples: - default: *272 + default: *275 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -37832,7 +38447,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: - - *121 + - *124 - *18 - name: page description: Page token @@ -37851,7 +38466,7 @@ paths: description: Response content: application/json: - schema: &294 + schema: &297 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -37897,7 +38512,7 @@ paths: type: string nullable: true examples: - default: &295 + default: &298 value: groups: - group_id: '123' @@ -37918,36 +38533,32 @@ paths: enabledForGitHubApps: true category: teams subcategory: team-sync - "/orgs/{org}/team/{team_slug}/copilot/usage": + "/orgs/{org}/team/{team_slug}/copilot/metrics": get: - summary: Get a summary of Copilot usage for a team + summary: Get Copilot metrics for a team description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. + Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE - for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. - 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. Usage metrics are processed once per day for the previous 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. - > [!NOTE] - > This endpoint will only return results for a given day if the team had five or more members with active Copilot licenses, as evaluated at the end of that day. - - Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage metrics for a team. + 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/usage-metrics-for-team + operationId: copilot/copilot-metrics-for-team externalDocs: 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 + url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *121 - - *219 + - *124 + - *222 - 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`). @@ -37981,7 +38592,80 @@ paths: type: array items: *87 examples: - default: *174 + default: *88 + '500': *73 + '403': *29 + '404': *7 + '422': *89 + 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 + description: |- + > [!NOTE] + > This endpoint is in public preview and is subject to change. + + You can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE + for users within a team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day. + See the response schema tab for detailed metrics definitions. + + The response contains metrics for up to 28 days prior. Usage 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 team had five or more members with active Copilot licenses, as evaluated at the end of that day. + + Organization owners for the organization that contains this team, and owners and billing managers of the parent enterprise can view Copilot usage 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/usage-metrics-for-team + externalDocs: + 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: + - *124 + - *222 + - 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 + - *20 + - 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: *90 + examples: + default: *177 '500': *73 '401': *25 '403': *29 @@ -38003,7 +38687,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *121 + - *124 - *18 - *20 responses: @@ -38013,9 +38697,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - default: *222 + default: *225 headers: Link: *39 '403': *29 @@ -38037,7 +38721,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *121 + - *124 requestBody: required: true content: @@ -38109,7 +38793,7 @@ paths: description: Response content: application/json: - schema: &273 + schema: &276 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -38172,8 +38856,8 @@ paths: description: Groups of organization members that gives permissions on specified repositories. type: object - properties: *220 - required: *221 + properties: *223 + required: *224 nullable: true members_count: type: integer @@ -38419,7 +39103,7 @@ paths: - repos_count - organization examples: - default: &274 + default: &277 value: id: 1 node_id: MDQ6VGVhbTE= @@ -38489,16 +39173,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *121 - - *219 + - *124 + - *222 responses: '200': description: Response content: application/json: - schema: *273 + schema: *276 examples: - default: *274 + default: *277 '404': *7 x-github: githubCloudOnly: false @@ -38519,8 +39203,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *121 - - *219 + - *124 + - *222 requestBody: required: false content: @@ -38582,16 +39266,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *273 + schema: *276 examples: - default: *274 + default: *277 '201': description: Response content: application/json: - schema: *273 + schema: *276 examples: - default: *274 + default: *277 '404': *7 '422': *16 '403': *29 @@ -38616,8 +39300,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *121 - - *219 + - *124 + - *222 responses: '204': description: Response @@ -38643,8 +39327,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *121 - - *219 + - *124 + - *222 - *67 - *18 - *20 @@ -38661,7 +39345,7 @@ paths: application/json: schema: type: array - items: &275 + items: &278 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -38740,7 +39424,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *92 + reactions: *95 required: - author - body @@ -38760,7 +39444,7 @@ paths: - updated_at - url examples: - default: &614 + default: &617 value: - author: login: octocat @@ -38834,8 +39518,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *121 - - *219 + - *124 + - *222 requestBody: required: true content: @@ -38869,9 +39553,9 @@ paths: description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: &276 + default: &279 value: author: login: octocat @@ -38943,9 +39627,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *121 - - *219 - - &277 + - *124 + - *222 + - &280 name: discussion_number description: The number that identifies the discussion. in: path @@ -38957,9 +39641,9 @@ paths: description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: *276 + default: *279 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38981,9 +39665,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *121 - - *219 - - *277 + - *124 + - *222 + - *280 requestBody: required: false content: @@ -39006,9 +39690,9 @@ paths: description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: &615 + default: &618 value: author: login: octocat @@ -39078,9 +39762,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *121 - - *219 - - *277 + - *124 + - *222 + - *280 responses: '204': description: Response @@ -39106,9 +39790,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *121 - - *219 - - *277 + - *124 + - *222 + - *280 - *67 - *18 - *20 @@ -39119,7 +39803,7 @@ paths: application/json: schema: type: array - items: &278 + items: &281 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -39176,7 +39860,7 @@ paths: type: string format: uri example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *92 + reactions: *95 required: - author - body @@ -39191,7 +39875,7 @@ paths: - updated_at - url examples: - default: &616 + default: &619 value: - author: login: octocat @@ -39259,9 +39943,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *121 - - *219 - - *277 + - *124 + - *222 + - *280 requestBody: required: true content: @@ -39283,9 +39967,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *281 examples: - default: &279 + default: &282 value: author: login: octocat @@ -39351,10 +40035,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *121 - - *219 - - *277 - - &280 + - *124 + - *222 + - *280 + - &283 name: comment_number description: The number that identifies the comment. in: path @@ -39366,9 +40050,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *281 examples: - default: *279 + default: *282 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39390,10 +40074,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *121 - - *219 - - *277 + - *124 + - *222 - *280 + - *283 requestBody: required: true content: @@ -39415,9 +40099,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *281 examples: - default: &617 + default: &620 value: author: login: octocat @@ -39481,10 +40165,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *121 - - *219 - - *277 + - *124 + - *222 - *280 + - *283 responses: '204': description: Response @@ -39510,10 +40194,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: - - *121 - - *219 - - *277 + - *124 + - *222 - *280 + - *283 - 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. @@ -39539,7 +40223,7 @@ paths: application/json: schema: type: array - items: &281 + items: &284 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -39582,7 +40266,7 @@ paths: - content - created_at examples: - default: &283 + default: &286 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -39632,10 +40316,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: - - *121 - - *219 - - *277 + - *124 + - *222 - *280 + - *283 requestBody: required: true content: @@ -39668,9 +40352,9 @@ paths: team discussion comment content: application/json: - schema: *281 + schema: *284 examples: - default: &282 + default: &285 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -39699,9 +40383,9 @@ paths: description: Response content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -39724,11 +40408,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *121 - - *219 - - *277 + - *124 + - *222 - *280 - - &284 + - *283 + - &287 name: reaction_id description: The unique identifier of the reaction. in: path @@ -39760,9 +40444,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *121 - - *219 - - *277 + - *124 + - *222 + - *280 - 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. @@ -39788,9 +40472,9 @@ paths: application/json: schema: type: array - items: *281 + items: *284 examples: - default: *283 + default: *286 headers: Link: *39 x-github: @@ -39816,9 +40500,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *121 - - *219 - - *277 + - *124 + - *222 + - *280 requestBody: required: true content: @@ -39850,16 +40534,16 @@ paths: description: Response content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '201': description: Response content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -39882,10 +40566,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *121 - - *219 - - *277 - - *284 + - *124 + - *222 + - *280 + - *287 responses: '204': description: Response @@ -39908,16 +40592,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: - - *121 - - *219 + - *124 + - *222 responses: '200': description: Response content: application/json: - schema: *285 + schema: *288 examples: - default: *286 + default: *289 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -39936,8 +40620,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: - - *121 - - *219 + - *124 + - *222 requestBody: required: true content: @@ -39960,9 +40644,9 @@ paths: description: Response content: application/json: - schema: *287 + schema: *290 examples: - default: *288 + default: *291 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -39981,8 +40665,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: - - *121 - - *219 + - *124 + - *222 responses: '204': description: Response @@ -40006,8 +40690,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *121 - - *219 + - *124 + - *222 - *18 - *20 responses: @@ -40017,9 +40701,9 @@ paths: application/json: schema: type: array - items: *204 + items: *207 examples: - default: *205 + default: *208 headers: Link: *39 x-github: @@ -40041,8 +40725,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *121 - - *219 + - *124 + - *222 - name: role description: Filters members returned by their role in the team. in: query @@ -40065,7 +40749,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 x-github: @@ -40095,15 +40779,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *121 - - *219 - - *161 + - *124 + - *222 + - *164 responses: '200': description: Response content: application/json: - schema: &289 + schema: &292 title: Team Membership description: Team Membership type: object @@ -40130,7 +40814,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &618 + response-if-user-is-a-team-maintainer: &621 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -40166,9 +40850,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: - - *121 - - *219 - - *161 + - *124 + - *222 + - *164 requestBody: required: false content: @@ -40193,9 +40877,9 @@ paths: description: Response content: application/json: - schema: *289 + schema: *292 examples: - response-if-users-membership-with-team-is-now-pending: &619 + response-if-users-membership-with-team-is-now-pending: &622 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -40230,9 +40914,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *121 - - *219 - - *161 + - *124 + - *222 + - *164 responses: '204': description: Response @@ -40258,8 +40942,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - - *121 - - *219 + - *124 + - *222 - *18 - *20 responses: @@ -40269,7 +40953,7 @@ paths: application/json: schema: type: array - items: &290 + items: &293 title: Team Project description: A team's access to a project. type: object @@ -40337,7 +41021,7 @@ paths: - updated_at - permissions examples: - default: &620 + default: &623 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -40398,9 +41082,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - - *121 - - *219 - - &291 + - *124 + - *222 + - &294 name: project_id description: The unique identifier of the project. in: path @@ -40412,9 +41096,9 @@ paths: description: Response content: application/json: - schema: *290 + schema: *293 examples: - default: &621 + default: &624 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -40474,9 +41158,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - - *121 - - *219 - - *291 + - *124 + - *222 + - *294 requestBody: required: false content: @@ -40540,9 +41224,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - - *121 - - *219 - - *291 + - *124 + - *222 + - *294 responses: '204': description: Response @@ -40566,8 +41250,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *121 - - *219 + - *124 + - *222 - *18 - *20 responses: @@ -40577,9 +41261,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 x-github: @@ -40608,16 +41292,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *121 - - *219 - - *292 - - *293 + - *124 + - *222 + - *295 + - *296 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &622 + schema: &625 title: Team Repository description: A team's access to a repository. type: object @@ -40640,8 +41324,8 @@ paths: title: License Simple description: License Simple type: object - properties: *105 - required: *106 + properties: *108 + required: *109 nullable: true forks: type: integer @@ -41186,10 +41870,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *121 - - *219 - - *292 - - *293 + - *124 + - *222 + - *295 + - *296 requestBody: required: false content: @@ -41234,10 +41918,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *121 - - *219 - - *292 - - *293 + - *124 + - *222 + - *295 + - *296 responses: '204': description: Response @@ -41263,16 +41947,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: - - *121 - - *219 + - *124 + - *222 responses: '200': description: Response content: application/json: - schema: *294 + schema: *297 examples: - default: *295 + default: *298 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -41294,8 +41978,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: - - *121 - - *219 + - *124 + - *222 requestBody: required: true content: @@ -41338,7 +42022,7 @@ paths: description: Response content: application/json: - schema: *294 + schema: *297 examples: default: value: @@ -41370,8 +42054,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *121 - - *219 + - *124 + - *222 - *18 - *20 responses: @@ -41381,9 +42065,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - response-if-child-teams-exist: &623 + response-if-child-teams-exist: &626 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -41436,7 +42120,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: - - *121 + - *124 - name: security_product in: path description: The security feature to enable or disable. @@ -41507,7 +42191,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#get-a-project-card parameters: - - &296 + - &299 name: card_id description: The unique identifier of the card. in: path @@ -41519,7 +42203,7 @@ paths: description: Response content: application/json: - schema: &297 + schema: &300 title: Project Card description: Project cards represent a scope of work. type: object @@ -41586,7 +42270,7 @@ paths: - created_at - updated_at examples: - default: &298 + default: &301 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -41636,7 +42320,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#update-an-existing-project-card parameters: - - *296 + - *299 requestBody: required: false content: @@ -41663,9 +42347,9 @@ paths: description: Response content: application/json: - schema: *297 + schema: *300 examples: - default: *298 + default: *301 '304': *37 '403': *29 '401': *25 @@ -41686,7 +42370,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#delete-a-project-card parameters: - - *296 + - *299 responses: '204': description: Response @@ -41724,7 +42408,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#move-a-project-card parameters: - - *296 + - *299 requestBody: required: true content: @@ -41829,7 +42513,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#get-a-project-column parameters: - - &299 + - &302 name: column_id description: The unique identifier of the column. in: path @@ -41841,7 +42525,7 @@ paths: description: Response content: application/json: - schema: &300 + schema: &303 title: Project Column description: Project columns contain cards of work. type: object @@ -41887,7 +42571,7 @@ paths: - created_at - updated_at examples: - default: &301 + default: &304 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -41916,7 +42600,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#update-an-existing-project-column parameters: - - *299 + - *302 requestBody: required: true content: @@ -41940,9 +42624,9 @@ paths: description: Response content: application/json: - schema: *300 + schema: *303 examples: - default: *301 + default: *304 '304': *37 '403': *29 '401': *25 @@ -41961,7 +42645,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#delete-a-project-column parameters: - - *299 + - *302 responses: '204': description: Response @@ -41984,7 +42668,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#list-project-cards parameters: - - *299 + - *302 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -42005,7 +42689,7 @@ paths: application/json: schema: type: array - items: *297 + items: *300 examples: default: value: @@ -42058,7 +42742,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#create-a-project-card parameters: - - *299 + - *302 requestBody: required: true content: @@ -42098,9 +42782,9 @@ paths: description: Response content: application/json: - schema: *297 + schema: *300 examples: - default: *298 + default: *301 '304': *37 '403': *29 '401': *25 @@ -42110,8 +42794,8 @@ paths: application/json: schema: oneOf: - - *124 - - *125 + - *127 + - *128 '503': description: Response content: @@ -42150,7 +42834,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#move-a-project-column parameters: - - *299 + - *302 requestBody: required: true content: @@ -42206,15 +42890,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-a-project parameters: - - *291 + - *294 responses: '200': description: Response content: application/json: - schema: *236 + schema: *239 examples: - default: &302 + default: &305 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -42267,7 +42951,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#update-a-project parameters: - - *291 + - *294 requestBody: required: false content: @@ -42313,9 +42997,9 @@ paths: description: Response content: application/json: - schema: *236 + schema: *239 examples: - default: *302 + default: *305 '404': description: Not Found if the authenticated user does not have access to the project @@ -42336,7 +43020,7 @@ paths: items: type: string '401': *25 - '410': *303 + '410': *306 '422': *8 x-github: githubCloudOnly: false @@ -42354,7 +43038,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#delete-a-project parameters: - - *291 + - *294 responses: '204': description: Delete Success @@ -42375,7 +43059,7 @@ paths: items: type: string '401': *25 - '410': *303 + '410': *306 '404': *7 x-github: githubCloudOnly: false @@ -42398,7 +43082,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#list-project-collaborators parameters: - - *291 + - *294 - 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 @@ -42425,7 +43109,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 '404': *7 @@ -42450,8 +43134,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#add-project-collaborator parameters: - - *291 - - *161 + - *294 + - *164 requestBody: required: false content: @@ -42498,8 +43182,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#remove-user-as-a-collaborator parameters: - - *291 - - *161 + - *294 + - *164 responses: '204': description: Response @@ -42527,8 +43211,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#get-project-permission-for-a-user parameters: - - *291 - - *161 + - *294 + - *164 responses: '200': description: Response @@ -42595,7 +43279,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#list-project-columns parameters: - - *291 + - *294 - *18 - *20 responses: @@ -42605,7 +43289,7 @@ paths: application/json: schema: type: array - items: *300 + items: *303 examples: default: value: @@ -42637,7 +43321,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#create-a-project-column parameters: - - *291 + - *294 requestBody: required: true content: @@ -42660,7 +43344,7 @@ paths: description: Response content: application/json: - schema: *300 + schema: *303 examples: default: value: @@ -42721,7 +43405,7 @@ paths: resources: type: object properties: - core: &304 + core: &307 title: Rate Limit type: object properties: @@ -42738,19 +43422,19 @@ paths: - remaining - reset - used - graphql: *304 - search: *304 - code_search: *304 - source_import: *304 - integration_manifest: *304 - code_scanning_upload: *304 - actions_runner_registration: *304 - scim: *304 - dependency_snapshots: *304 + graphql: *307 + search: *307 + code_search: *307 + source_import: *307 + integration_manifest: *307 + code_scanning_upload: *307 + actions_runner_registration: *307 + scim: *307 + dependency_snapshots: *307 required: - core - search - rate: *304 + rate: *307 required: - rate - resources @@ -42849,14 +43533,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: *305 + schema: *308 examples: default-response: summary: Default response @@ -43361,7 +44045,7 @@ paths: status: disabled '403': *29 '404': *7 - '301': *306 + '301': *309 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43379,8 +44063,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: false content: @@ -43626,10 +44310,10 @@ paths: description: Response content: application/json: - schema: *305 + schema: *308 examples: - default: *307 - '307': &308 + default: *310 + '307': &311 description: Temporary Redirect content: application/json: @@ -43658,8 +44342,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -43681,7 +44365,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': *308 + '307': *311 '404': *7 x-github: githubCloudOnly: false @@ -43704,11 +44388,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 - - &323 + - &326 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -43731,7 +44415,7 @@ paths: type: integer artifacts: type: array - items: &309 + items: &312 title: Artifact description: An artifact type: object @@ -43802,7 +44486,7 @@ paths: - expires_at - updated_at examples: - default: &324 + default: &327 value: total_count: 2 artifacts: @@ -43861,9 +44545,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *292 - - *293 - - &310 + - *295 + - *296 + - &313 name: artifact_id description: The unique identifier of the artifact. in: path @@ -43875,7 +44559,7 @@ paths: description: Response content: application/json: - schema: *309 + schema: *312 examples: default: value: @@ -43912,9 +44596,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *292 - - *293 - - *310 + - *295 + - *296 + - *313 responses: '204': description: Response @@ -43938,9 +44622,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *292 - - *293 - - *310 + - *295 + - *296 + - *313 - name: archive_format in: path required: true @@ -43954,7 +44638,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': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43977,14 +44661,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: *311 + schema: *314 examples: default: value: @@ -44010,11 +44694,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: - - *292 - - *293 + - *295 + - *296 - *18 - *20 - - &312 + - &315 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 @@ -44048,7 +44732,7 @@ paths: description: Response content: application/json: - schema: &313 + schema: &316 title: Repository actions caches description: Repository actions caches type: object @@ -44090,7 +44774,7 @@ paths: - total_count - actions_caches examples: - default: &314 + default: &317 value: total_count: 1 actions_caches: @@ -44122,23 +44806,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: - - *292 - - *293 + - *295 + - *296 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *312 + - *315 responses: '200': description: Response content: application/json: - schema: *313 + schema: *316 examples: - default: *314 + default: *317 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44158,8 +44842,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: - - *292 - - *293 + - *295 + - *296 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -44190,9 +44874,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: - - *292 - - *293 - - &315 + - *295 + - *296 + - &318 name: job_id description: The unique identifier of the job. in: path @@ -44204,7 +44888,7 @@ paths: description: Response content: application/json: - schema: &327 + schema: &330 title: Job description: Information of a job execution in a workflow run type: object @@ -44511,9 +45195,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: - - *292 - - *293 - - *315 + - *295 + - *296 + - *318 responses: '302': description: Response @@ -44541,9 +45225,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: - - *292 - - *293 - - *315 + - *295 + - *296 + - *318 requestBody: required: false content: @@ -44564,7 +45248,7 @@ paths: description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -44588,8 +45272,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Status response @@ -44639,8 +45323,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -44674,7 +45358,7 @@ paths: description: Empty response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -44703,8 +45387,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -44722,7 +45406,7 @@ paths: type: integer secrets: type: array - items: &329 + items: &332 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -44742,7 +45426,7 @@ paths: - created_at - updated_at examples: - default: &330 + default: &333 value: total_count: 2 secrets: @@ -44775,9 +45459,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *292 - - *293 - - *316 + - *295 + - *296 + - *319 - *20 responses: '200': @@ -44794,7 +45478,7 @@ paths: type: integer variables: type: array - items: &333 + items: &336 title: Actions Variable type: object properties: @@ -44824,7 +45508,7 @@ paths: - created_at - updated_at examples: - default: &334 + default: &337 value: total_count: 2 variables: @@ -44857,8 +45541,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -44867,11 +45551,11 @@ paths: schema: type: object properties: - enabled: &317 + enabled: &320 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *42 - selected_actions_url: *132 + selected_actions_url: *135 required: - enabled examples: @@ -44900,8 +45584,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: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -44912,7 +45596,7 @@ paths: schema: type: object properties: - enabled: *317 + enabled: *320 allowed_actions: *42 required: - enabled @@ -44943,14 +45627,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: &318 + schema: &321 type: object properties: access_level: @@ -44968,7 +45652,7 @@ paths: required: - access_level examples: - default: &319 + default: &322 value: access_level: organization x-github: @@ -44993,15 +45677,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: application/json: - schema: *318 + schema: *321 examples: - default: *319 + default: *322 responses: '204': description: Response @@ -45025,8 +45709,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -45057,8 +45741,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: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -45090,14 +45774,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: *135 + schema: *138 examples: default: *48 x-github: @@ -45120,8 +45804,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: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Success response @@ -45132,7 +45816,7 @@ paths: required: true content: application/json: - schema: *136 + schema: *139 examples: default: *48 x-github: @@ -45161,8 +45845,8 @@ paths: in: query schema: type: string - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -45206,8 +45890,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -45215,9 +45899,9 @@ paths: application/json: schema: type: array - items: *140 + items: *143 examples: - default: *141 + default: *144 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45239,8 +45923,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -45283,7 +45967,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *142 + '201': *145 '404': *7 '422': *8 x-github: @@ -45313,8 +45997,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: - - *292 - - *293 + - *295 + - *296 responses: '201': description: Response @@ -45322,7 +46006,7 @@ paths: application/json: schema: *58 examples: - default: *143 + default: *146 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45350,8 +46034,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: - - *292 - - *293 + - *295 + - *296 responses: '201': description: Response @@ -45359,7 +46043,7 @@ paths: application/json: schema: *58 examples: - default: *144 + default: *147 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45381,8 +46065,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: - - *292 - - *293 + - *295 + - *296 - *54 responses: '200': @@ -45391,7 +46075,7 @@ paths: application/json: schema: *55 examples: - default: *145 + default: *148 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45412,8 +46096,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: - - *292 - - *293 + - *295 + - *296 - *54 responses: '204': @@ -45439,8 +46123,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: - - *292 - - *293 + - *295 + - *296 - *54 responses: '200': *60 @@ -45465,8 +46149,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: - - *292 - - *293 + - *295 + - *296 - *54 requestBody: required: true @@ -45515,8 +46199,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: - - *292 - - *293 + - *295 + - *296 - *54 requestBody: required: true @@ -45566,11 +46250,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: - - *292 - - *293 + - *295 + - *296 - *54 responses: - '200': *146 + '200': *149 '404': *7 x-github: githubCloudOnly: false @@ -45597,10 +46281,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: - - *292 - - *293 + - *295 + - *296 - *54 - - *147 + - *150 responses: '200': *60 '404': *7 @@ -45628,9 +46312,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: - - *292 - - *293 - - &337 + - *295 + - *296 + - &340 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. @@ -45638,7 +46322,7 @@ paths: required: false schema: type: string - - &338 + - &341 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -45646,7 +46330,7 @@ paths: required: false schema: type: string - - &339 + - &342 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -45655,7 +46339,7 @@ paths: required: false schema: type: string - - &340 + - &343 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 @@ -45682,7 +46366,7 @@ paths: - pending - *18 - *20 - - &341 + - &344 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)." @@ -45691,7 +46375,7 @@ paths: schema: type: string format: date-time - - &320 + - &323 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -45700,13 +46384,13 @@ paths: schema: type: boolean default: false - - &342 + - &345 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &343 + - &346 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -45729,7 +46413,7 @@ paths: type: integer workflow_runs: type: array - items: &321 + items: &324 title: Workflow Run description: An invocation of a workflow type: object @@ -45824,7 +46508,7 @@ paths: that triggered the run. type: array nullable: true - items: &362 + items: &365 title: Pull Request Minimal type: object properties: @@ -45943,7 +46627,7 @@ paths: title: Simple Commit description: A commit. type: object - properties: &366 + properties: &369 id: type: string description: SHA for the commit @@ -45994,7 +46678,7 @@ paths: - name - email nullable: true - required: &367 + required: &370 - id - tree_id - message @@ -46002,8 +46686,8 @@ paths: - author - committer nullable: true - repository: *139 - head_repository: *139 + repository: *142 + head_repository: *142 head_repository_id: type: integer example: 5 @@ -46041,7 +46725,7 @@ paths: - workflow_url - pull_requests examples: - default: &344 + default: &347 value: total_count: 1 workflow_runs: @@ -46277,24 +46961,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *292 - - *293 - - &322 + - *295 + - *296 + - &325 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *320 + - *323 responses: '200': description: Response content: application/json: - schema: *321 + schema: *324 examples: - default: &325 + default: &328 value: id: 30433642 name: Build @@ -46535,9 +47219,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '204': description: Response @@ -46560,9 +47244,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: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '200': description: Response @@ -46681,15 +47365,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: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '201': description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -46716,12 +47400,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 - *18 - *20 - - *323 + - *326 responses: '200': description: Response @@ -46737,9 +47421,9 @@ paths: type: integer artifacts: type: array - items: *309 + items: *312 examples: - default: *324 + default: *327 headers: Link: *39 x-github: @@ -46763,25 +47447,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *292 - - *293 - - *322 - - &326 + - *295 + - *296 + - *325 + - &329 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *320 + - *323 responses: '200': description: Response content: application/json: - schema: *321 + schema: *324 examples: - default: *325 + default: *328 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46804,10 +47488,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: - - *292 - - *293 - - *322 - - *326 + - *295 + - *296 + - *325 + - *329 - *18 - *20 responses: @@ -46825,9 +47509,9 @@ paths: type: integer jobs: type: array - items: *327 + items: *330 examples: - default: &328 + default: &331 value: total_count: 1 jobs: @@ -46940,10 +47624,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *292 - - *293 - - *322 - - *326 + - *295 + - *296 + - *325 + - *329 responses: '302': description: Response @@ -46971,19 +47655,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '202': description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47006,9 +47690,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: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 requestBody: required: true content: @@ -47075,19 +47759,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '202': description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47110,9 +47794,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: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 - 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 @@ -47142,9 +47826,9 @@ paths: type: integer jobs: type: array - items: *327 + items: *330 examples: - default: *328 + default: *331 headers: Link: *39 x-github: @@ -47169,9 +47853,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '302': description: Response @@ -47198,9 +47882,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '204': description: Response @@ -47227,9 +47911,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: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '200': description: Response @@ -47289,7 +47973,7 @@ paths: items: type: object properties: - type: &440 + type: &443 type: string description: The type of reviewer. enum: @@ -47299,7 +47983,7 @@ paths: reviewer: anyOf: - *19 - - *207 + - *210 required: - environment - wait_timer @@ -47374,9 +48058,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: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 requestBody: required: true content: @@ -47423,7 +48107,7 @@ paths: application/json: schema: type: array - items: &435 + items: &438 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -47511,8 +48195,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 required: - id - node_id @@ -47529,7 +48213,7 @@ paths: - created_at - updated_at examples: - default: &436 + default: &439 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -47585,9 +48269,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 requestBody: required: false content: @@ -47608,7 +48292,7 @@ paths: description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -47631,9 +48315,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: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 requestBody: required: false content: @@ -47654,7 +48338,7 @@ paths: description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -47679,9 +48363,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *292 - - *293 - - *322 + - *295 + - *296 + - *325 responses: '200': description: Response @@ -47818,8 +48502,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -47837,9 +48521,9 @@ paths: type: integer secrets: type: array - items: *329 + items: *332 examples: - default: *330 + default: *333 headers: Link: *39 x-github: @@ -47864,16 +48548,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: *331 + schema: *334 examples: - default: *332 + default: *335 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47895,17 +48579,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 responses: '200': description: Response content: application/json: - schema: *329 + schema: *332 examples: - default: &453 + default: &456 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -47931,9 +48615,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 requestBody: required: true content: @@ -47961,7 +48645,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -47987,9 +48671,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 responses: '204': description: Response @@ -48014,9 +48698,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *292 - - *293 - - *316 + - *295 + - *296 + - *319 - *20 responses: '200': @@ -48033,9 +48717,9 @@ paths: type: integer variables: type: array - items: *333 + items: *336 examples: - default: *334 + default: *337 headers: Link: *39 x-github: @@ -48058,8 +48742,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -48086,7 +48770,7 @@ paths: description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -48111,17 +48795,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *292 - - *293 - - *152 + - *295 + - *296 + - *155 responses: '200': description: Response content: application/json: - schema: *333 + schema: *336 examples: - default: &454 + default: &457 value: name: USERNAME value: octocat @@ -48147,9 +48831,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *292 - - *293 - - *152 + - *295 + - *296 + - *155 requestBody: required: true content: @@ -48191,9 +48875,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *292 - - *293 - - *152 + - *295 + - *296 + - *155 responses: '204': description: Response @@ -48218,8 +48902,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -48237,7 +48921,7 @@ paths: type: integer workflows: type: array - items: &335 + items: &338 title: Workflow description: A GitHub Actions workflow type: object @@ -48344,9 +49028,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *292 - - *293 - - &336 + - *295 + - *296 + - &339 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -48361,7 +49045,7 @@ paths: description: Response content: application/json: - schema: *335 + schema: *338 examples: default: value: @@ -48394,9 +49078,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *292 - - *293 - - *336 + - *295 + - *296 + - *339 responses: '204': description: Response @@ -48421,9 +49105,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *292 - - *293 - - *336 + - *295 + - *296 + - *339 responses: '204': description: Response @@ -48474,9 +49158,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *292 - - *293 - - *336 + - *295 + - *296 + - *339 responses: '204': description: Response @@ -48501,19 +49185,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: - - *292 - - *293 - - *336 - - *337 - - *338 + - *295 + - *296 - *339 - *340 - - *18 - - *20 - *341 - - *320 - *342 - *343 + - *18 + - *20 + - *344 + - *323 + - *345 + - *346 responses: '200': description: Response @@ -48529,9 +49213,9 @@ paths: type: integer workflow_runs: type: array - items: *321 + items: *324 examples: - default: *344 + default: *347 headers: Link: *39 x-github: @@ -48557,9 +49241,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *292 - - *293 - - *336 + - *295 + - *296 + - *339 responses: '200': description: Response @@ -48620,8 +49304,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *292 - - *293 + - *295 + - *296 - *67 - *18 - *65 @@ -48785,8 +49469,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -48798,7 +49482,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 '404': *7 @@ -48823,8 +49507,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: - - *292 - - *293 + - *295 + - *296 - name: assignee in: path required: true @@ -48860,8 +49544,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -48973,8 +49657,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *65 - *66 @@ -49018,7 +49702,7 @@ paths: repository_id: type: integer examples: - default: *345 + default: *348 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -49038,8 +49722,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -49047,7 +49731,7 @@ paths: application/json: schema: type: array - items: &346 + items: &349 title: Autolink reference description: An autolink reference. type: object @@ -49097,8 +49781,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -49137,9 +49821,9 @@ paths: description: response content: application/json: - schema: *346 + schema: *349 examples: - default: &347 + default: &350 value: id: 1 key_prefix: TICKET- @@ -49170,9 +49854,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: - - *292 - - *293 - - &348 + - *295 + - *296 + - &351 name: autolink_id description: The unique identifier of the autolink. in: path @@ -49184,9 +49868,9 @@ paths: description: Response content: application/json: - schema: *346 + schema: *349 examples: - default: *347 + default: *350 '404': *7 x-github: githubCloudOnly: false @@ -49206,9 +49890,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: - - *292 - - *293 - - *348 + - *295 + - *296 + - *351 responses: '204': description: Response @@ -49232,8 +49916,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response if Dependabot is enabled @@ -49281,8 +49965,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-automated-security-fixes parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -49303,8 +49987,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-automated-security-fixes parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -49324,8 +50008,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *292 - - *293 + - *295 + - *296 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -49363,7 +50047,7 @@ paths: - url protected: type: boolean - protection: &350 + protection: &353 title: Branch Protection description: Branch Protection type: object @@ -49405,7 +50089,7 @@ paths: required: - contexts - checks - enforce_admins: &353 + enforce_admins: &356 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -49420,7 +50104,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &355 + required_pull_request_reviews: &358 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -49441,7 +50125,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *207 + items: *210 apps: description: The list of apps with review dismissal access. @@ -49470,7 +50154,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *207 + items: *210 apps: description: The list of apps allowed to bypass pull request requirements. @@ -49496,7 +50180,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &352 + restrictions: &355 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -49803,9 +50487,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *292 - - *293 - - &351 + - *295 + - *296 + - &354 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). @@ -49819,14 +50503,14 @@ paths: description: Response content: application/json: - schema: &361 + schema: &364 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &408 + commit: &411 title: Commit description: Commit type: object @@ -49860,7 +50544,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: &349 + properties: &352 name: type: string example: '"Chris Wanstrath"' @@ -49875,7 +50559,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *349 + properties: *352 nullable: true message: type: string @@ -49896,7 +50580,7 @@ paths: required: - sha - url - verification: &460 + verification: &463 title: Verification type: object properties: @@ -49926,12 +50610,12 @@ paths: nullable: true oneOf: - *19 - - *150 + - *153 committer: nullable: true oneOf: - *19 - - *150 + - *153 parents: type: array items: @@ -49962,7 +50646,7 @@ paths: type: integer files: type: array - items: &423 + items: &426 title: Diff Entry description: Diff Entry type: object @@ -50045,7 +50729,7 @@ paths: - self protected: type: boolean - protection: *350 + protection: *353 protection_url: type: string format: uri @@ -50151,7 +50835,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *306 + '301': *309 '404': *7 x-github: githubCloudOnly: false @@ -50173,15 +50857,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response content: application/json: - schema: *350 + schema: *353 examples: default: value: @@ -50375,9 +51059,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: true content: @@ -50632,7 +51316,7 @@ paths: url: type: string format: uri - required_status_checks: &358 + required_status_checks: &361 title: Status Check Policy description: Status Check Policy type: object @@ -50708,7 +51392,7 @@ paths: items: *19 teams: type: array - items: *207 + items: *210 apps: type: array items: *6 @@ -50726,7 +51410,7 @@ paths: items: *19 teams: type: array - items: *207 + items: *210 apps: type: array items: *6 @@ -50784,7 +51468,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *352 + restrictions: *355 required_conversation_resolution: type: object properties: @@ -50896,9 +51580,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '204': description: Response @@ -50923,17 +51607,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response content: application/json: - schema: *353 + schema: *356 examples: - default: &354 + default: &357 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -50955,17 +51639,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response content: application/json: - schema: *353 + schema: *356 examples: - default: *354 + default: *357 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50984,9 +51668,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '204': description: Response @@ -51011,17 +51695,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response content: application/json: - schema: *355 + schema: *358 examples: - default: &356 + default: &359 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -51117,9 +51801,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: false content: @@ -51217,9 +51901,9 @@ paths: description: Response content: application/json: - schema: *355 + schema: *358 examples: - default: *356 + default: *359 '422': *16 x-github: githubCloudOnly: false @@ -51240,9 +51924,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '204': description: Response @@ -51269,17 +51953,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response content: application/json: - schema: *353 + schema: *356 examples: - default: &357 + default: &360 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -51302,17 +51986,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response content: application/json: - schema: *353 + schema: *356 examples: - default: *357 + default: *360 '404': *7 x-github: githubCloudOnly: false @@ -51332,9 +52016,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '204': description: Response @@ -51359,17 +52043,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response content: application/json: - schema: *358 + schema: *361 examples: - default: &359 + default: &362 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -51395,9 +52079,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: false content: @@ -51449,9 +52133,9 @@ paths: description: Response content: application/json: - schema: *358 + schema: *361 examples: - default: *359 + default: *362 '404': *7 '422': *16 x-github: @@ -51473,9 +52157,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '204': description: Response @@ -51499,9 +52183,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response @@ -51535,9 +52219,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: false content: @@ -51604,9 +52288,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: false content: @@ -51670,9 +52354,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: content: application/json: @@ -51738,15 +52422,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response content: application/json: - schema: *352 + schema: *355 examples: default: value: @@ -51837,9 +52521,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '204': description: Response @@ -51862,9 +52546,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: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response @@ -51874,7 +52558,7 @@ paths: type: array items: *6 examples: - default: &360 + default: &363 value: - id: 1 slug: octoapp @@ -51931,9 +52615,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: true content: @@ -51967,7 +52651,7 @@ paths: type: array items: *6 examples: - default: *360 + default: *363 '422': *16 x-github: githubCloudOnly: false @@ -51988,9 +52672,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: true content: @@ -52024,7 +52708,7 @@ paths: type: array items: *6 examples: - default: *360 + default: *363 '422': *16 x-github: githubCloudOnly: false @@ -52045,9 +52729,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: true content: @@ -52081,7 +52765,7 @@ paths: type: array items: *6 examples: - default: *360 + default: *363 '422': *16 x-github: githubCloudOnly: false @@ -52103,9 +52787,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: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response @@ -52113,9 +52797,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - default: *222 + default: *225 '404': *7 x-github: githubCloudOnly: false @@ -52135,9 +52819,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: false content: @@ -52173,9 +52857,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - default: *222 + default: *225 '422': *16 x-github: githubCloudOnly: false @@ -52196,9 +52880,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: false content: @@ -52234,9 +52918,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - default: *222 + default: *225 '422': *16 x-github: githubCloudOnly: false @@ -52257,9 +52941,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: content: application/json: @@ -52294,9 +52978,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - default: *222 + default: *225 '422': *16 x-github: githubCloudOnly: false @@ -52318,9 +53002,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: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 responses: '200': description: Response @@ -52330,7 +53014,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 '404': *7 x-github: githubCloudOnly: false @@ -52354,9 +53038,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: true content: @@ -52389,7 +53073,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 '422': *16 x-github: githubCloudOnly: false @@ -52414,9 +53098,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: true content: @@ -52449,7 +53133,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 '422': *16 x-github: githubCloudOnly: false @@ -52474,9 +53158,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: true content: @@ -52509,7 +53193,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 '422': *16 x-github: githubCloudOnly: false @@ -52536,9 +53220,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 requestBody: required: true content: @@ -52560,7 +53244,7 @@ paths: description: Response content: application/json: - schema: *361 + schema: *364 examples: default: value: @@ -52675,8 +53359,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -52955,7 +53639,7 @@ paths: description: Response content: application/json: - schema: &363 + schema: &366 title: CheckRun description: A check performed on the code of a given code change type: object @@ -53066,16 +53750,16 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 pull_requests: description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check. type: array - items: *362 - deployment: &674 + items: *365 + deployment: &677 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -53142,8 +53826,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 required: - id - node_id @@ -53355,9 +54039,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *292 - - *293 - - &364 + - *295 + - *296 + - &367 name: check_run_id description: The unique identifier of the check run. in: path @@ -53369,9 +54053,9 @@ paths: description: Response content: application/json: - schema: *363 + schema: *366 examples: - default: &365 + default: &368 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -53471,9 +54155,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *292 - - *293 - - *364 + - *295 + - *296 + - *367 requestBody: required: true content: @@ -53713,9 +54397,9 @@ paths: description: Response content: application/json: - schema: *363 + schema: *366 examples: - default: *365 + default: *368 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53735,9 +54419,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *292 - - *293 - - *364 + - *295 + - *296 + - *367 - *18 - *20 responses: @@ -53834,15 +54518,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *292 - - *293 - - *364 + - *295 + - *296 + - *367 responses: '201': description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -53880,8 +54564,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -53903,7 +54587,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &368 + schema: &371 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -53966,7 +54650,7 @@ paths: nullable: true pull_requests: type: array - items: *362 + items: *365 nullable: true app: title: GitHub app @@ -53977,9 +54661,9 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 - repository: *139 + properties: *92 + required: *93 + repository: *142 created_at: type: string format: date-time @@ -53988,12 +54672,12 @@ paths: type: string format: date-time nullable: true - head_commit: &700 + head_commit: &703 title: Simple Commit description: A commit. type: object - properties: *366 - required: *367 + properties: *369 + required: *370 latest_check_runs_count: type: integer check_runs_url: @@ -54021,7 +54705,7 @@ paths: - check_runs_url - pull_requests examples: - default: &369 + default: &372 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -54312,9 +54996,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *368 + schema: *371 examples: - default: *369 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54333,8 +55017,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -54395,7 +55079,7 @@ paths: required: - app_id - setting - repository: *139 + repository: *142 examples: default: value: @@ -54643,9 +55327,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *292 - - *293 - - &370 + - *295 + - *296 + - &373 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -54657,9 +55341,9 @@ paths: description: Response content: application/json: - schema: *368 + schema: *371 examples: - default: *369 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54682,17 +55366,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: - - *292 - - *293 - - *370 - - &416 + - *295 + - *296 + - *373 + - &419 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &417 + - &420 name: status description: Returns check runs with the specified `status`. in: query @@ -54731,9 +55415,9 @@ paths: type: integer check_runs: type: array - items: *363 + items: *366 examples: - default: &418 + default: &421 value: total_count: 1 check_runs: @@ -54835,15 +55519,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *292 - - *293 - - *370 + - *295 + - *296 + - *373 responses: '201': description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -54870,21 +55554,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: - - *292 - - *293 - - *162 - - *163 + - *295 + - *296 + - *165 + - *166 - *20 - *18 - - &382 + - &385 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: *371 - - &383 + schema: *374 + - &386 name: pr description: The number of the pull request for the results you want to list. in: query @@ -54909,13 +55593,13 @@ paths: be returned. in: query required: false - schema: *164 + schema: *167 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *372 + schema: *375 responses: '200': description: Response @@ -54931,7 +55615,7 @@ paths: updated_at: *81 url: *78 html_url: *79 - instances_url: *373 + instances_url: *376 state: *70 fixed_at: *83 dismissed_by: @@ -54942,11 +55626,11 @@ paths: required: *5 nullable: true dismissed_at: *82 - dismissed_reason: *374 - dismissed_comment: *375 - rule: *376 - tool: *377 - most_recent_instance: *378 + dismissed_reason: *377 + dismissed_comment: *378 + rule: *379 + tool: *380 + most_recent_instance: *381 required: - number - created_at @@ -55062,7 +55746,7 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *37 - '403': &379 + '403': &382 description: Response if GitHub Advanced Security is not enabled for this repository content: @@ -55089,9 +55773,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: - - *292 - - *293 - - &380 + - *295 + - *296 + - &383 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -55105,7 +55789,7 @@ paths: description: Response content: application/json: - schema: &381 + schema: &384 type: object properties: number: *74 @@ -55113,7 +55797,7 @@ paths: updated_at: *81 url: *78 html_url: *79 - instances_url: *373 + instances_url: *376 state: *70 fixed_at: *83 dismissed_by: @@ -55124,8 +55808,8 @@ paths: required: *5 nullable: true dismissed_at: *82 - dismissed_reason: *374 - dismissed_comment: *375 + dismissed_reason: *377 + dismissed_comment: *378 rule: type: object properties: @@ -55179,8 +55863,8 @@ paths: type: string description: A link to the documentation for the rule used to detect the alert. - tool: *377 - most_recent_instance: *378 + tool: *380 + most_recent_instance: *381 required: - number - created_at @@ -55269,7 +55953,7 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *37 - '403': *379 + '403': *382 '404': *7 '503': *85 x-github: @@ -55289,9 +55973,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: - - *292 - - *293 - - *380 + - *295 + - *296 + - *383 requestBody: required: true content: @@ -55306,8 +55990,8 @@ paths: enum: - open - dismissed - dismissed_reason: *374 - dismissed_comment: *375 + dismissed_reason: *377 + dismissed_comment: *378 required: - state examples: @@ -55322,7 +56006,7 @@ paths: description: Response content: application/json: - schema: *381 + schema: *384 examples: default: value: @@ -55397,7 +56081,7 @@ paths: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '403': &388 + '403': &391 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: @@ -55424,13 +56108,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: - - *292 - - *293 - - *380 + - *295 + - *296 + - *383 - *20 - *18 - - *382 - - *383 + - *385 + - *386 responses: '200': description: Response @@ -55438,7 +56122,7 @@ paths: application/json: schema: type: array - items: *378 + items: *381 examples: default: value: @@ -55477,7 +56161,7 @@ paths: end_column: 50 classifications: - source - '403': *379 + '403': *382 '404': *7 '503': *85 x-github: @@ -55511,25 +56195,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: - - *292 - - *293 - - *162 - - *163 + - *295 + - *296 + - *165 + - *166 - *20 - *18 - - *383 + - *386 - 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: *371 + schema: *374 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &386 + schema: &389 type: string description: An identifier for the upload. example: 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 @@ -55550,23 +56234,23 @@ paths: application/json: schema: type: array - items: &387 + items: &390 type: object properties: - ref: *371 - commit_sha: &396 + ref: *374 + commit_sha: &399 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: *384 + analysis_key: *387 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *385 + category: *388 error: type: string example: error reading field xyz @@ -55590,8 +56274,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *386 - tool: *377 + sarif_id: *389 + tool: *380 deletable: type: boolean warning: @@ -55652,7 +56336,7 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *379 + '403': *382 '404': *7 '503': *85 x-github: @@ -55688,8 +56372,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: - - *292 - - *293 + - *295 + - *296 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -55702,7 +56386,7 @@ paths: description: Response content: application/json: - schema: *387 + schema: *390 examples: response: summary: application/json response @@ -55756,7 +56440,7 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *379 + '403': *382 '404': *7 '503': *85 x-github: @@ -55838,8 +56522,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: - - *292 - - *293 + - *295 + - *296 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -55892,7 +56576,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': *15 - '403': *388 + '403': *391 '404': *7 '503': *85 x-github: @@ -55914,8 +56598,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -55923,7 +56607,7 @@ paths: application/json: schema: type: array - items: &389 + items: &392 title: CodeQL Database description: A CodeQL database. type: object @@ -56034,7 +56718,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': *379 + '403': *382 '404': *7 '503': *85 x-github: @@ -56063,8 +56747,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: - - *292 - - *293 + - *295 + - *296 - name: language in: path description: The language of the CodeQL database. @@ -56076,7 +56760,7 @@ paths: description: Response content: application/json: - schema: *389 + schema: *392 examples: default: value: @@ -56108,9 +56792,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': &425 + '302': &428 description: Found - '403': *379 + '403': *382 '404': *7 '503': *85 x-github: @@ -56138,8 +56822,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -56148,7 +56832,7 @@ paths: type: object additionalProperties: false properties: - language: &390 + language: &393 type: string description: The language targeted by the CodeQL query enum: @@ -56226,7 +56910,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &394 + schema: &397 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -56236,7 +56920,7 @@ paths: description: The ID of the variant analysis. controller_repo: *84 actor: *19 - query_language: *390 + query_language: *393 query_pack_url: type: string description: The download url for the query pack. @@ -56283,7 +56967,7 @@ paths: items: type: object properties: - repository: &391 + repository: &394 title: Repository Identifier description: Repository Identifier type: object @@ -56319,7 +57003,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &395 + analysis_status: &398 type: string description: The new status of the CodeQL variant analysis repository task. @@ -56351,7 +57035,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &392 + access_mismatch_repos: &395 type: object properties: repository_count: @@ -56365,7 +57049,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: *391 + items: *394 required: - repository_count - repositories @@ -56387,8 +57071,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *392 - over_limit_repos: *392 + no_codeql_db_repos: *395 + over_limit_repos: *395 required: - access_mismatch_repos - not_found_repos @@ -56404,7 +57088,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &393 + value: &396 summary: Default response value: id: 1 @@ -56556,10 +57240,10 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *393 + value: *396 repository_lists: summary: Response for a successful variant analysis submission - value: *393 + value: *396 '404': *7 '422': description: Unable to process variant analysis submission @@ -56587,8 +57271,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: - - *292 - - *293 + - *295 + - *296 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -56600,9 +57284,9 @@ paths: description: Response content: application/json: - schema: *394 + schema: *397 examples: - default: *393 + default: *396 '404': *7 '503': *85 x-github: @@ -56625,7 +57309,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: - - *292 + - *295 - name: repo in: path description: The name of the controller repository. @@ -56660,7 +57344,7 @@ paths: type: object properties: repository: *84 - analysis_status: *395 + analysis_status: *398 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -56785,8 +57469,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -56847,7 +57531,7 @@ paths: query_suite: default updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *379 + '403': *382 '404': *7 '503': *85 x-github: @@ -56868,8 +57552,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -56914,7 +57598,7 @@ paths: description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -56939,7 +57623,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *388 + '403': *391 '404': *7 '409': description: Response if there is already a validation run in progress with @@ -57004,8 +57688,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -57013,7 +57697,7 @@ paths: schema: type: object properties: - commit_sha: *396 + commit_sha: *399 ref: type: string description: |- @@ -57071,7 +57755,7 @@ paths: schema: type: object properties: - id: *386 + id: *389 url: type: string description: The REST API URL for checking the status of the upload. @@ -57085,7 +57769,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': *388 + '403': *391 '404': *7 '413': description: Payload Too Large if the sarif field is too large @@ -57108,8 +57792,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: - - *292 - - *293 + - *295 + - *296 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -57155,7 +57839,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': *379 + '403': *382 '404': description: Not Found if the sarif id does not match any upload '503': *85 @@ -57180,8 +57864,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -57205,7 +57889,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *167 + configuration: *170 examples: default: value: @@ -57234,7 +57918,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': *170 + '204': *173 '304': *37 '403': *29 '404': *7 @@ -57259,8 +57943,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *292 - - *293 + - *295 + - *296 - 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 @@ -57380,8 +58064,8 @@ paths: parameters: - *18 - *20 - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -57397,7 +58081,7 @@ paths: type: integer codespaces: type: array - items: *211 + items: *214 examples: default: value: @@ -57695,8 +58379,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -57759,17 +58443,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '400': *15 '401': *25 '403': *29 @@ -57798,8 +58482,8 @@ paths: parameters: - *18 - *20 - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -57863,8 +58547,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: - - *292 - - *293 + - *295 + - *296 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -57899,14 +58583,14 @@ paths: type: integer machines: type: array - items: &630 + items: &633 type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *398 - required: *399 + properties: *401 + required: *402 examples: - default: &631 + default: &634 value: total_count: 2 machines: @@ -57946,8 +58630,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *292 - - *293 + - *295 + - *296 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -58031,8 +58715,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: - - *292 - - *293 + - *295 + - *296 - 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 @@ -58098,8 +58782,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -58117,7 +58801,7 @@ paths: type: integer secrets: type: array - items: &403 + items: &406 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -58137,7 +58821,7 @@ paths: - created_at - updated_at examples: - default: *400 + default: *403 headers: Link: *39 x-github: @@ -58160,16 +58844,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: *401 + schema: *404 examples: - default: *402 + default: *405 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -58189,17 +58873,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 responses: '200': description: Response content: application/json: - schema: *403 + schema: *406 examples: - default: *404 + default: *407 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58219,9 +58903,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: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 requestBody: required: true content: @@ -58249,7 +58933,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -58273,9 +58957,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 responses: '204': description: Response @@ -58303,8 +58987,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *292 - - *293 + - *295 + - *296 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -58346,7 +59030,7 @@ paths: title: Collaborator description: Collaborator type: object - properties: &405 + properties: &408 login: type: string example: octocat @@ -58439,7 +59123,7 @@ paths: user_view_type: type: string example: public - required: &406 + required: &409 - avatar_url - events_url - followers_url @@ -58513,9 +59197,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: - - *292 - - *293 - - *161 + - *295 + - *296 + - *164 responses: '204': description: Response if user is a collaborator @@ -58557,9 +59241,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *292 - - *293 - - *161 + - *295 + - *296 + - *164 requestBody: required: false content: @@ -58585,7 +59269,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &473 + schema: &476 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -58596,7 +59280,7 @@ paths: example: 42 type: integer format: int64 - repository: *139 + repository: *142 invitee: title: Simple User description: A GitHub user. @@ -58807,9 +59491,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *292 - - *293 - - *161 + - *295 + - *296 + - *164 responses: '204': description: No Content when collaborator was removed from the repository. @@ -58838,9 +59522,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *292 - - *293 - - *161 + - *295 + - *296 + - *164 responses: '200': description: if user has admin permissions @@ -58860,8 +59544,8 @@ paths: title: Collaborator description: Collaborator type: object - properties: *405 - required: *406 + properties: *408 + required: *409 nullable: true required: - permission @@ -58916,8 +59600,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -58927,7 +59611,7 @@ paths: application/json: schema: type: array - items: &407 + items: &410 title: Commit Comment description: Commit Comment type: object @@ -58968,8 +59652,8 @@ paths: updated_at: type: string format: date-time - author_association: *91 - reactions: *92 + author_association: *94 + reactions: *95 required: - url - html_url @@ -58985,7 +59669,7 @@ paths: - created_at - updated_at examples: - default: &410 + default: &413 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -59044,17 +59728,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 responses: '200': description: Response content: application/json: - schema: *407 + schema: *410 examples: - default: &411 + default: &414 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -59111,9 +59795,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 requestBody: required: true content: @@ -59135,7 +59819,7 @@ paths: description: Response content: application/json: - schema: *407 + schema: *410 examples: default: value: @@ -59186,9 +59870,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 responses: '204': description: Response @@ -59209,9 +59893,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 - 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. @@ -59237,9 +59921,9 @@ paths: application/json: schema: type: array - items: *281 + items: *284 examples: - default: *283 + default: *286 headers: Link: *39 '404': *7 @@ -59260,9 +59944,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 requestBody: required: true content: @@ -59294,16 +59978,16 @@ paths: description: Reaction exists content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '201': description: Reaction created content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '422': *16 x-github: githubCloudOnly: false @@ -59325,10 +60009,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *292 - - *293 - - *103 - - *284 + - *295 + - *296 + - *106 + - *287 responses: '204': description: Response @@ -59376,8 +60060,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *292 - - *293 + - *295 + - *296 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -59433,9 +60117,9 @@ paths: application/json: schema: type: array - items: *408 + items: *411 examples: - default: &524 + default: &527 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -59508,7 +60192,7 @@ paths: '500': *73 '400': *15 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59528,9 +60212,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *292 - - *293 - - &409 + - *295 + - *296 + - &412 name: commit_sha description: The SHA of the commit. in: path @@ -59577,7 +60261,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *16 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59602,9 +60286,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *292 - - *293 - - *409 + - *295 + - *296 + - *412 - *18 - *20 responses: @@ -59614,9 +60298,9 @@ paths: application/json: schema: type: array - items: *407 + items: *410 examples: - default: *410 + default: *413 headers: Link: *39 x-github: @@ -59644,9 +60328,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *292 - - *293 - - *409 + - *295 + - *296 + - *412 requestBody: required: true content: @@ -59681,9 +60365,9 @@ paths: description: Response content: application/json: - schema: *407 + schema: *410 examples: - default: *411 + default: *414 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -59711,9 +60395,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: - - *292 - - *293 - - *409 + - *295 + - *296 + - *412 - *18 - *20 responses: @@ -59723,7 +60407,7 @@ paths: application/json: schema: type: array - items: &514 + items: &517 title: Pull Request Simple description: Pull Request Simple type: object @@ -59829,8 +60513,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *412 - required: *413 + properties: *415 + required: *416 nullable: true active_lock_reason: type: string @@ -59875,7 +60559,7 @@ paths: nullable: true requested_teams: type: array - items: *207 + items: *210 nullable: true head: type: object @@ -59926,7 +60610,7 @@ paths: _links: type: object properties: - comments: &414 + comments: &417 title: Link description: Hypermedia Link type: object @@ -59935,13 +60619,13 @@ paths: type: string required: - href - commits: *414 - statuses: *414 - html: *414 - issue: *414 - review_comments: *414 - review_comment: *414 - self: *414 + commits: *417 + statuses: *417 + html: *417 + issue: *417 + review_comments: *417 + review_comment: *417 + self: *417 required: - comments - commits @@ -59951,8 +60635,8 @@ paths: - review_comments - review_comment - self - author_association: *91 - auto_merge: &517 + author_association: *94 + auto_merge: &520 title: Auto merge description: The status of auto merging a pull request. type: object @@ -60015,7 +60699,7 @@ paths: - author_association - auto_merge examples: - default: &515 + default: &518 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -60495,7 +61179,7 @@ paths: draft: false headers: Link: *39 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60551,11 +61235,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *292 - - *293 + - *295 + - *296 - *20 - *18 - - &415 + - &418 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)" @@ -60570,9 +61254,9 @@ paths: description: Response content: application/json: - schema: *408 + schema: *411 examples: - default: &501 + default: &504 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -60659,7 +61343,7 @@ paths: '404': *7 '500': *73 '503': *85 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60684,11 +61368,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: - - *292 - - *293 - - *415 - - *416 - - *417 + - *295 + - *296 + - *418 + - *419 + - *420 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -60722,9 +61406,9 @@ paths: type: integer check_runs: type: array - items: *363 + items: *366 examples: - default: *418 + default: *421 headers: Link: *39 x-github: @@ -60749,9 +61433,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: - - *292 - - *293 - - *415 + - *295 + - *296 + - *418 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -60759,7 +61443,7 @@ paths: schema: type: integer example: 1 - - *416 + - *419 - *18 - *20 responses: @@ -60777,7 +61461,7 @@ paths: type: integer check_suites: type: array - items: *368 + items: *371 examples: default: value: @@ -60977,9 +61661,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: - - *292 - - *293 - - *415 + - *295 + - *296 + - *418 - *18 - *20 responses: @@ -61046,7 +61730,7 @@ paths: type: string total_count: type: integer - repository: *139 + repository: *142 commit_url: type: string format: uri @@ -61177,9 +61861,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *292 - - *293 - - *415 + - *295 + - *296 + - *418 - *18 - *20 responses: @@ -61189,7 +61873,7 @@ paths: application/json: schema: type: array - items: &578 + items: &581 title: Status description: The status of a commit. type: object @@ -61270,7 +61954,7 @@ paths: site_admin: false headers: Link: *39 - '301': *306 + '301': *309 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61298,8 +61982,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -61328,20 +62012,20 @@ paths: title: Code Of Conduct Simple description: Code of Conduct Simple type: object - properties: *419 - required: *420 + properties: *422 + required: *423 nullable: true code_of_conduct_file: title: Community Health File type: object - properties: &421 + properties: &424 url: type: string format: uri html_url: type: string format: uri - required: &422 + required: &425 - url - html_url nullable: true @@ -61349,32 +62033,32 @@ paths: title: License Simple description: License Simple type: object - properties: *105 - required: *106 + properties: *108 + required: *109 nullable: true contributing: title: Community Health File type: object - properties: *421 - required: *422 + properties: *424 + required: *425 nullable: true readme: title: Community Health File type: object - properties: *421 - required: *422 + properties: *424 + required: *425 nullable: true issue_template: title: Community Health File type: object - properties: *421 - required: *422 + properties: *424 + required: *425 nullable: true pull_request_template: title: Community Health File type: object - properties: *421 - required: *422 + properties: *424 + required: *425 nullable: true required: - code_of_conduct @@ -61500,8 +62184,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *292 - - *293 + - *295 + - *296 - *20 - *18 - name: basehead @@ -61544,8 +62228,8 @@ paths: type: string format: uri example: https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *408 - merge_base_commit: *408 + base_commit: *411 + merge_base_commit: *411 status: type: string enum: @@ -61565,10 +62249,10 @@ paths: example: 6 commits: type: array - items: *408 + items: *411 files: type: array - items: *423 + items: *426 required: - url - html_url @@ -61851,8 +62535,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *292 - - *293 + - *295 + - *296 - name: path description: path parameter in: path @@ -61993,7 +62677,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &424 + response-if-content-is-a-file: &427 summary: Response if content is a file value: type: file @@ -62125,7 +62809,7 @@ paths: - size - type - url - - &529 + - &532 title: Content File description: Content File type: object @@ -62326,7 +63010,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *424 + response-if-content-is-a-file: *427 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -62395,7 +63079,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *7 '403': *29 - '302': *425 + '302': *428 '304': *37 x-github: githubCloudOnly: false @@ -62418,8 +63102,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *292 - - *293 + - *295 + - *296 - name: path description: path parameter in: path @@ -62512,7 +63196,7 @@ paths: description: Response content: application/json: - schema: &426 + schema: &429 title: File Commit description: File Commit type: object @@ -62660,7 +63344,7 @@ paths: description: Response content: application/json: - schema: *426 + schema: *429 examples: example-for-creating-a-file: value: @@ -62713,7 +63397,7 @@ paths: schema: oneOf: - *3 - - &455 + - &458 description: Repository rule violation was detected type: object properties: @@ -62734,7 +63418,7 @@ paths: items: type: object properties: - placeholder_id: &571 + placeholder_id: &574 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -62766,8 +63450,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *292 - - *293 + - *295 + - *296 - name: path description: path parameter in: path @@ -62828,7 +63512,7 @@ paths: description: Response content: application/json: - schema: *426 + schema: *429 examples: default: value: @@ -62861,7 +63545,7 @@ paths: payload: '422': *16 '404': *7 - '409': *126 + '409': *129 '503': *85 x-github: githubCloudOnly: false @@ -62882,8 +63566,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *292 - - *293 + - *295 + - *296 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -63006,20 +63690,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *292 - - *293 - - *180 - - *181 - - *182 + - *295 + - *296 - *183 + - *184 + - *185 + - *186 - 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 - - *184 - - *185 + - *187 + - *188 - *67 - name: page description: "**Closing down notice**. Page number of the results to fetch. @@ -63039,8 +63723,8 @@ paths: default: 30 - *65 - *66 - - *186 - - *187 + - *189 + - *190 responses: '200': description: Response @@ -63048,7 +63732,7 @@ paths: application/json: schema: type: array - items: &429 + items: &432 type: object description: A Dependabot alert. properties: @@ -63081,7 +63765,7 @@ paths: enum: - development - runtime - security_advisory: *427 + security_advisory: *430 security_vulnerability: *77 url: *78 html_url: *79 @@ -63112,7 +63796,7 @@ paths: nullable: true maxLength: 280 fixed_at: *83 - auto_dismissed_at: *428 + auto_dismissed_at: *431 required: - number - state @@ -63339,9 +64023,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *292 - - *293 - - &430 + - *295 + - *296 + - &433 name: alert_number in: path description: |- @@ -63356,7 +64040,7 @@ paths: description: Response content: application/json: - schema: *429 + schema: *432 examples: default: value: @@ -63466,9 +64150,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *292 - - *293 - - *430 + - *295 + - *296 + - *433 requestBody: required: true content: @@ -63513,7 +64197,7 @@ paths: description: Response content: application/json: - schema: *429 + schema: *432 examples: default: value: @@ -63619,7 +64303,7 @@ paths: '400': *15 '403': *29 '404': *7 - '409': *126 + '409': *129 '422': *8 x-github: githubCloudOnly: false @@ -63642,8 +64326,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -63661,7 +64345,7 @@ paths: type: integer secrets: type: array - items: &433 + items: &436 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -63714,16 +64398,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: *431 + schema: *434 examples: - default: *432 + default: *435 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63743,15 +64427,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 responses: '200': description: Response content: application/json: - schema: *433 + schema: *436 examples: default: value: @@ -63777,9 +64461,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 requestBody: required: true content: @@ -63807,7 +64491,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -63831,9 +64515,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *292 - - *293 - - *149 + - *295 + - *296 + - *152 responses: '204': description: Response @@ -63855,8 +64539,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: - - *292 - - *293 + - *295 + - *296 - 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 @@ -64016,8 +64700,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -64220,8 +64904,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -64296,7 +64980,7 @@ paths: - version - url additionalProperties: false - metadata: &434 + metadata: &437 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -64329,7 +65013,7 @@ paths: the root of the Git repository. example: "/src/build/package-lock.json" additionalProperties: false - metadata: *434 + metadata: *437 resolved: type: object description: A collection of resolved package dependencies. @@ -64342,7 +65026,7 @@ paths: for more details. example: pkg:/npm/%40actions/http-client@1.0.11 pattern: "^pkg" - metadata: *434 + metadata: *437 relationship: type: string description: A notation of whether a dependency is requested @@ -64471,8 +65155,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *292 - - *293 + - *295 + - *296 - name: sha description: The SHA recorded at creation time. in: query @@ -64512,9 +65196,9 @@ paths: application/json: schema: type: array - items: *435 + items: *438 examples: - default: *436 + default: *439 headers: Link: *39 x-github: @@ -64580,8 +65264,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -64662,7 +65346,7 @@ paths: description: Response content: application/json: - schema: *435 + schema: *438 examples: simple-example: summary: Simple example @@ -64735,9 +65419,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *292 - - *293 - - &437 + - *295 + - *296 + - &440 name: deployment_id description: deployment_id parameter in: path @@ -64749,7 +65433,7 @@ paths: description: Response content: application/json: - schema: *435 + schema: *438 examples: default: value: @@ -64814,9 +65498,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *292 - - *293 - - *437 + - *295 + - *296 + - *440 responses: '204': description: Response @@ -64838,9 +65522,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *292 - - *293 - - *437 + - *295 + - *296 + - *440 - *18 - *20 responses: @@ -64850,7 +65534,7 @@ paths: application/json: schema: type: array - items: &438 + items: &441 title: Deployment Status description: The status of a deployment. type: object @@ -64941,8 +65625,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 required: - id - node_id @@ -65011,9 +65695,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *292 - - *293 - - *437 + - *295 + - *296 + - *440 requestBody: required: true content: @@ -65088,9 +65772,9 @@ paths: description: Response content: application/json: - schema: *438 + schema: *441 examples: - default: &439 + default: &442 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -65146,9 +65830,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *292 - - *293 - - *437 + - *295 + - *296 + - *440 - name: status_id in: path required: true @@ -65159,9 +65843,9 @@ paths: description: Response content: application/json: - schema: *438 + schema: *441 examples: - default: *439 + default: *442 '404': *7 x-github: githubCloudOnly: false @@ -65186,8 +65870,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -65244,8 +65928,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -65262,7 +65946,7 @@ paths: type: integer environments: type: array - items: &441 + items: &444 title: Environment description: Details of a deployment environment type: object @@ -65314,7 +65998,7 @@ paths: type: type: string example: wait_timer - wait_timer: &443 + wait_timer: &446 type: integer example: 30 description: The amount of time to delay a job after @@ -65351,11 +66035,11 @@ paths: items: type: object properties: - type: *440 + type: *443 reviewer: anyOf: - *19 - - *207 + - *210 required: - id - node_id @@ -65375,7 +66059,7 @@ paths: - id - node_id - type - deployment_branch_policy: &444 + deployment_branch_policy: &447 type: object description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`. @@ -65491,9 +66175,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *292 - - *293 - - &442 + - *295 + - *296 + - &445 name: environment_name in: path required: true @@ -65506,9 +66190,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *444 examples: - default: &445 + default: &448 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -65592,9 +66276,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *292 - - *293 - - *442 + - *295 + - *296 + - *445 requestBody: required: false content: @@ -65603,7 +66287,7 @@ paths: type: object nullable: true properties: - wait_timer: *443 + wait_timer: *446 prevent_self_review: type: boolean example: false @@ -65620,13 +66304,13 @@ paths: items: type: object properties: - type: *440 + type: *443 id: type: integer description: The id of the user or team who can review the deployment example: 4532992 - deployment_branch_policy: *444 + deployment_branch_policy: *447 additionalProperties: false examples: default: @@ -65646,9 +66330,9 @@ paths: description: Response content: application/json: - schema: *441 + schema: *444 examples: - default: *445 + default: *448 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -65672,9 +66356,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *292 - - *293 - - *442 + - *295 + - *296 + - *445 responses: '204': description: Default response @@ -65699,9 +66383,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *292 - - *293 - - *442 + - *295 + - *296 + - *445 - *18 - *20 responses: @@ -65719,7 +66403,7 @@ paths: example: 2 branch_policies: type: array - items: &446 + items: &449 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -65776,9 +66460,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *292 - - *293 - - *442 + - *295 + - *296 + - *445 requestBody: required: true content: @@ -65824,9 +66508,9 @@ paths: description: Response content: application/json: - schema: *446 + schema: *449 examples: - example-wildcard: &447 + example-wildcard: &450 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -65868,10 +66552,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *292 - - *293 - - *442 - - &448 + - *295 + - *296 + - *445 + - &451 name: branch_policy_id in: path required: true @@ -65883,9 +66567,9 @@ paths: description: Response content: application/json: - schema: *446 + schema: *449 examples: - default: *447 + default: *450 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65904,10 +66588,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *292 - - *293 - - *442 - - *448 + - *295 + - *296 + - *445 + - *451 requestBody: required: true content: @@ -65935,9 +66619,9 @@ paths: description: Response content: application/json: - schema: *446 + schema: *449 examples: - default: *447 + default: *450 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65956,10 +66640,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *292 - - *293 - - *442 - - *448 + - *295 + - *296 + - *445 + - *451 responses: '204': description: Response @@ -65984,9 +66668,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: - - *442 - - *293 - - *292 + - *445 + - *296 + - *295 responses: '200': description: List of deployment protection rules @@ -66002,7 +66686,7 @@ paths: example: 10 custom_deployment_protection_rules: type: array - items: &449 + items: &452 title: Deployment protection rule description: Deployment protection rule type: object @@ -66021,7 +66705,7 @@ paths: example: true description: Whether the deployment protection rule is enabled for the environment. - app: &450 + app: &453 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -66120,9 +66804,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: - - *442 - - *293 - - *292 + - *445 + - *296 + - *295 requestBody: content: application/json: @@ -66143,9 +66827,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *449 + schema: *452 examples: - default: &451 + default: &454 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -66180,9 +66864,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: - - *442 - - *293 - - *292 + - *445 + - *296 + - *295 - *20 - *18 responses: @@ -66201,7 +66885,7 @@ paths: example: 35 available_custom_deployment_protection_rule_integrations: type: array - items: *450 + items: *453 examples: default: value: @@ -66236,10 +66920,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: - - *292 - - *293 - - *442 - - &452 + - *295 + - *296 + - *445 + - &455 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -66251,9 +66935,9 @@ paths: description: Response content: application/json: - schema: *449 + schema: *452 examples: - default: *451 + default: *454 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66274,10 +66958,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: - - *442 - - *293 - - *292 - - *452 + - *445 + - *296 + - *295 + - *455 responses: '204': description: Response @@ -66303,9 +66987,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *292 - - *293 - - *442 + - *295 + - *296 + - *445 - *18 - *20 responses: @@ -66323,9 +67007,9 @@ paths: type: integer secrets: type: array - items: *329 + items: *332 examples: - default: *330 + default: *333 headers: Link: *39 x-github: @@ -66350,17 +67034,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *292 - - *293 - - *442 + - *295 + - *296 + - *445 responses: '200': description: Response content: application/json: - schema: *331 + schema: *334 examples: - default: *332 + default: *335 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66382,18 +67066,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *292 - - *293 - - *442 - - *149 + - *295 + - *296 + - *445 + - *152 responses: '200': description: Response content: application/json: - schema: *329 + schema: *332 examples: - default: *453 + default: *456 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66415,10 +67099,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *292 - - *293 - - *442 - - *149 + - *295 + - *296 + - *445 + - *152 requestBody: required: true content: @@ -66449,7 +67133,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -66475,10 +67159,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *292 - - *293 - - *442 - - *149 + - *295 + - *296 + - *445 + - *152 responses: '204': description: Default response @@ -66503,10 +67187,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *292 - - *293 - - *442 - - *316 + - *295 + - *296 + - *445 + - *319 - *20 responses: '200': @@ -66523,9 +67207,9 @@ paths: type: integer variables: type: array - items: *333 + items: *336 examples: - default: *334 + default: *337 headers: Link: *39 x-github: @@ -66548,9 +67232,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *292 - - *293 - - *442 + - *295 + - *296 + - *445 requestBody: required: true content: @@ -66577,7 +67261,7 @@ paths: description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -66602,18 +67286,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *292 - - *293 - - *442 - - *152 + - *295 + - *296 + - *445 + - *155 responses: '200': description: Response content: application/json: - schema: *333 + schema: *336 examples: - default: *454 + default: *457 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66634,10 +67318,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *292 - - *293 - - *152 - - *442 + - *295 + - *296 + - *155 + - *445 requestBody: required: true content: @@ -66679,10 +67363,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *292 - - *293 - - *152 - - *442 + - *295 + - *296 + - *155 + - *445 responses: '204': description: Response @@ -66704,8 +67388,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -66715,7 +67399,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: 200-response: value: @@ -66782,8 +67466,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *292 - - *293 + - *295 + - *296 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -66805,7 +67489,7 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: default: value: @@ -66942,8 +67626,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: false content: @@ -66975,9 +67659,9 @@ paths: description: Response content: application/json: - schema: *305 + schema: *308 examples: - default: *307 + default: *310 '400': *15 '422': *16 '403': *29 @@ -66998,8 +67682,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -67050,7 +67734,7 @@ paths: schema: type: string '404': *7 - '409': *126 + '409': *129 '403': *29 '422': description: Validation failed @@ -67058,8 +67742,8 @@ paths: application/json: schema: oneOf: - - *124 - - *455 + - *127 + - *458 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67084,8 +67768,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *292 - - *293 + - *295 + - *296 - name: file_sha in: path required: true @@ -67136,7 +67820,7 @@ paths: '404': *7 '422': *16 '403': *29 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67183,8 +67867,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -67293,7 +67977,7 @@ paths: description: Response content: application/json: - schema: &456 + schema: &459 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -67452,7 +68136,7 @@ paths: type: string '422': *16 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67501,15 +68185,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *292 - - *293 - - *409 + - *295 + - *296 + - *412 responses: '200': description: Response content: application/json: - schema: *456 + schema: *459 examples: default: value: @@ -67539,7 +68223,7 @@ paths: signature: payload: '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67564,9 +68248,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *292 - - *293 - - &457 + - *295 + - *296 + - &460 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. @@ -67583,7 +68267,7 @@ paths: application/json: schema: type: array - items: &458 + items: &461 title: Git Reference description: Git references within a repository type: object @@ -67637,7 +68321,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *39 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67658,17 +68342,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *292 - - *293 - - *457 + - *295 + - *296 + - *460 responses: '200': description: Response content: application/json: - schema: *458 + schema: *461 examples: - default: &459 + default: &462 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -67678,7 +68362,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67697,8 +68381,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -67727,16 +68411,16 @@ paths: description: Response content: application/json: - schema: *458 + schema: *461 examples: - default: *459 + default: *462 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *16 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67755,9 +68439,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *292 - - *293 - - *457 + - *295 + - *296 + - *460 requestBody: required: true content: @@ -67786,11 +68470,11 @@ paths: description: Response content: application/json: - schema: *458 + schema: *461 examples: - default: *459 + default: *462 '422': *16 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67806,14 +68490,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *292 - - *293 - - *457 + - *295 + - *296 + - *460 responses: '204': description: Response '422': *16 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67860,8 +68544,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -67928,7 +68612,7 @@ paths: description: Response content: application/json: - schema: &461 + schema: &464 title: Git Tag description: Metadata for a Git tag type: object @@ -67979,7 +68663,7 @@ paths: - sha - type - url - verification: *460 + verification: *463 required: - sha - url @@ -67989,7 +68673,7 @@ paths: - tag - message examples: - default: &462 + default: &465 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -68015,7 +68699,7 @@ paths: schema: type: string '422': *16 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68060,8 +68744,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *292 - - *293 + - *295 + - *296 - name: tag_sha in: path required: true @@ -68072,11 +68756,11 @@ paths: description: Response content: application/json: - schema: *461 + schema: *464 examples: - default: *462 + default: *465 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68098,8 +68782,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -68172,7 +68856,7 @@ paths: description: Response content: application/json: - schema: &463 + schema: &466 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -68261,7 +68945,7 @@ paths: '422': *16 '404': *7 '403': *29 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68284,8 +68968,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *292 - - *293 + - *295 + - *296 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -68308,7 +68992,7 @@ paths: description: Response content: application/json: - schema: *463 + schema: *466 examples: default-response: summary: Default response @@ -68349,7 +69033,7 @@ paths: truncated: false '422': *16 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68367,8 +69051,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -68378,7 +69062,7 @@ paths: application/json: schema: type: array - items: &464 + items: &467 title: Webhook description: Webhooks for repositories. type: object @@ -68432,7 +69116,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &708 + last_response: &711 title: Hook Response type: object properties: @@ -68506,8 +69190,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: false content: @@ -68559,9 +69243,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *467 examples: - default: &465 + default: &468 value: type: Repository id: 12345678 @@ -68609,17 +69293,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 responses: '200': description: Response content: application/json: - schema: *464 + schema: *467 examples: - default: *465 + default: *468 '404': *7 x-github: githubCloudOnly: false @@ -68639,9 +69323,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 requestBody: required: true content: @@ -68686,9 +69370,9 @@ paths: description: Response content: application/json: - schema: *464 + schema: *467 examples: - default: *465 + default: *468 '422': *16 '404': *7 x-github: @@ -68706,9 +69390,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 responses: '204': description: Response @@ -68732,9 +69416,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: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 responses: '200': description: Response @@ -68761,9 +69445,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: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 requestBody: required: false content: @@ -68807,11 +69491,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 - *18 - - *196 + - *199 - name: redelivery in: query required: false @@ -68824,9 +69508,9 @@ paths: application/json: schema: type: array - items: *197 + items: *200 examples: - default: *198 + default: *201 '400': *15 '422': *16 x-github: @@ -68845,18 +69529,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: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 - *17 responses: '200': description: Response content: application/json: - schema: *199 + schema: *202 examples: - default: *200 + default: *203 '400': *15 '422': *16 x-github: @@ -68875,12 +69559,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: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 - *17 responses: - '202': *127 + '202': *130 '400': *15 '422': *16 x-github: @@ -68900,9 +69584,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 responses: '204': description: Response @@ -68927,9 +69611,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *292 - - *293 - - *195 + - *295 + - *296 + - *198 responses: '204': description: Response @@ -68987,14 +69671,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: &466 + schema: &469 title: Import description: A repository import from an external source. type: object @@ -69093,7 +69777,7 @@ paths: - html_url - authors_url examples: - default: &469 + default: &472 value: vcs: subversion use_lfs: true @@ -69109,7 +69793,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *7 - '503': &467 + '503': &470 description: Unavailable due to service under maintenance. content: application/json: @@ -69138,8 +69822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -69187,7 +69871,7 @@ paths: description: Response content: application/json: - schema: *466 + schema: *469 examples: default: value: @@ -69212,7 +69896,7 @@ paths: type: string '422': *16 '404': *7 - '503': *467 + '503': *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69240,8 +69924,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: false content: @@ -69290,7 +69974,7 @@ paths: description: Response content: application/json: - schema: *466 + schema: *469 examples: example-1: summary: Example 1 @@ -69338,7 +70022,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': *467 + '503': *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69361,12 +70045,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response - '503': *467 + '503': *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69392,9 +70076,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *292 - - *293 - - &654 + - *295 + - *296 + - &657 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -69408,7 +70092,7 @@ paths: application/json: schema: type: array - items: &468 + items: &471 title: Porter Author description: Porter Author type: object @@ -69462,7 +70146,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *7 - '503': *467 + '503': *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69487,8 +70171,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *292 - - *293 + - *295 + - *296 - name: author_id in: path required: true @@ -69518,7 +70202,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *471 examples: default: value: @@ -69531,7 +70215,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *16 '404': *7 - '503': *467 + '503': *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69555,8 +70239,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -69597,7 +70281,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *467 + '503': *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69625,8 +70309,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -69653,11 +70337,11 @@ paths: description: Response content: application/json: - schema: *466 + schema: *469 examples: - default: *469 + default: *472 '422': *16 - '503': *467 + '503': *470 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69680,8 +70364,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -69689,8 +70373,8 @@ paths: application/json: schema: *22 examples: - default: *470 - '301': *306 + default: *473 + '301': *309 '404': *7 x-github: githubCloudOnly: false @@ -69710,8 +70394,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -69719,12 +70403,12 @@ paths: application/json: schema: anyOf: - - *202 + - *205 - type: object properties: {} additionalProperties: false examples: - default: &472 + default: &475 value: limit: collaborators_only origin: repository @@ -69749,13 +70433,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: application/json: - schema: *471 + schema: *474 examples: default: summary: Example request body @@ -69767,9 +70451,9 @@ paths: description: Response content: application/json: - schema: *202 + schema: *205 examples: - default: *472 + default: *475 '409': description: Response x-github: @@ -69791,8 +70475,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -69815,8 +70499,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -69826,9 +70510,9 @@ paths: application/json: schema: type: array - items: *473 + items: *476 examples: - default: &647 + default: &650 value: - id: 1 repository: @@ -69959,9 +70643,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *292 - - *293 - - *206 + - *295 + - *296 + - *209 requestBody: required: false content: @@ -69990,7 +70674,7 @@ paths: description: Response content: application/json: - schema: *473 + schema: *476 examples: default: value: @@ -70121,9 +70805,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *292 - - *293 - - *206 + - *295 + - *296 + - *209 responses: '204': description: Response @@ -70154,8 +70838,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *292 - - *293 + - *295 + - *296 - 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 @@ -70195,7 +70879,7 @@ paths: required: false schema: type: string - - *208 + - *211 - name: sort description: What to sort results by. in: query @@ -70208,7 +70892,7 @@ paths: - comments default: created - *67 - - *94 + - *97 - *18 - *20 responses: @@ -70218,7 +70902,7 @@ paths: application/json: schema: type: array - items: *104 + items: *107 examples: default: value: @@ -70368,7 +71052,7 @@ paths: state_reason: completed headers: Link: *39 - '301': *306 + '301': *309 '422': *16 '404': *7 x-github: @@ -70397,8 +71081,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -70473,9 +71157,9 @@ paths: description: Response content: application/json: - schema: *104 + schema: *107 examples: - default: &479 + default: &482 value: id: 1 node_id: MDU6SXNzdWUx @@ -70631,7 +71315,7 @@ paths: '422': *16 '503': *85 '404': *7 - '410': *303 + '410': *306 x-github: triggersNotification: true githubCloudOnly: false @@ -70659,9 +71343,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *292 - - *293 - - *114 + - *295 + - *296 + - *117 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -70671,7 +71355,7 @@ paths: enum: - asc - desc - - *94 + - *97 - *18 - *20 responses: @@ -70681,9 +71365,9 @@ paths: application/json: schema: type: array - items: *474 + items: *477 examples: - default: &481 + default: &484 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -70741,17 +71425,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 responses: '200': description: Response content: application/json: - schema: *474 + schema: *477 examples: - default: &475 + default: &478 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -70805,9 +71489,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 requestBody: required: true content: @@ -70829,9 +71513,9 @@ paths: description: Response content: application/json: - schema: *474 + schema: *477 examples: - default: *475 + default: *478 '422': *16 x-github: githubCloudOnly: false @@ -70849,9 +71533,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 responses: '204': description: Response @@ -70871,9 +71555,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 - 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. @@ -70899,9 +71583,9 @@ paths: application/json: schema: type: array - items: *281 + items: *284 examples: - default: *283 + default: *286 headers: Link: *39 '404': *7 @@ -70922,9 +71606,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 requestBody: required: true content: @@ -70956,16 +71640,16 @@ paths: description: Reaction exists content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '201': description: Reaction created content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '422': *16 x-github: githubCloudOnly: false @@ -70987,10 +71671,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *292 - - *293 - - *103 - - *284 + - *295 + - *296 + - *106 + - *287 responses: '204': description: Response @@ -71010,8 +71694,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -71021,7 +71705,7 @@ paths: application/json: schema: type: array - items: &478 + items: &481 title: Issue Event description: Issue Event type: object @@ -71064,8 +71748,8 @@ paths: description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. type: object - properties: *476 - required: *477 + properties: *479 + required: *480 nullable: true label: title: Issue Event Label @@ -71109,7 +71793,7 @@ paths: properties: *4 required: *5 nullable: true - requested_team: *207 + requested_team: *210 dismissed_review: title: Issue Event Dismissed Review type: object @@ -71174,7 +71858,7 @@ paths: required: - from - to - author_association: *91 + author_association: *94 lock_reason: type: string nullable: true @@ -71187,8 +71871,8 @@ paths: first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 required: - id - node_id @@ -71372,8 +72056,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *292 - - *293 + - *295 + - *296 - name: event_id in: path required: true @@ -71384,7 +72068,7 @@ paths: description: Response content: application/json: - schema: *478 + schema: *481 examples: default: value: @@ -71577,7 +72261,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *7 - '410': *303 + '410': *306 '403': *29 x-github: githubCloudOnly: false @@ -71611,9 +72295,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *292 - - *293 - - &480 + - *295 + - *296 + - &483 name: issue_number description: The number that identifies the issue. in: path @@ -71625,12 +72309,12 @@ paths: description: Response content: application/json: - schema: *104 + schema: *107 examples: - default: *479 - '301': *306 + default: *482 + '301': *309 '404': *7 - '410': *303 + '410': *306 '304': *37 x-github: githubCloudOnly: false @@ -71655,9 +72339,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 requestBody: required: false content: @@ -71752,15 +72436,15 @@ paths: description: Response content: application/json: - schema: *104 + schema: *107 examples: - default: *479 + default: *482 '422': *16 '503': *85 '403': *29 - '301': *306 + '301': *309 '404': *7 - '410': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71778,9 +72462,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 requestBody: required: false content: @@ -71806,9 +72490,9 @@ paths: description: Response content: application/json: - schema: *104 + schema: *107 examples: - default: *479 + default: *482 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71824,9 +72508,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 requestBody: content: application/json: @@ -71851,9 +72535,9 @@ paths: description: Response content: application/json: - schema: *104 + schema: *107 examples: - default: *479 + default: *482 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71875,9 +72559,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: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 - name: assignee in: path required: true @@ -71917,10 +72601,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *292 - - *293 - - *480 - - *94 + - *295 + - *296 + - *483 + - *97 - *18 - *20 responses: @@ -71930,13 +72614,13 @@ paths: application/json: schema: type: array - items: *474 + items: *477 examples: - default: *481 + default: *484 headers: Link: *39 '404': *7 - '410': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71965,9 +72649,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 requestBody: required: true content: @@ -71989,16 +72673,16 @@ paths: description: Response content: application/json: - schema: *474 + schema: *477 examples: - default: *475 + default: *478 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *29 - '410': *303 + '410': *306 '422': *16 '404': *7 x-github: @@ -72018,9 +72702,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 - *18 - *20 responses: @@ -72034,7 +72718,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &484 + - &487 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -72065,8 +72749,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 label: type: object properties: @@ -72088,7 +72772,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &485 + - &488 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -72119,8 +72803,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 label: type: object properties: @@ -72208,8 +72892,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 assignee: *19 assigner: *19 required: @@ -72224,7 +72908,7 @@ paths: - performed_via_github_app - assignee - assigner - - &486 + - &489 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -72255,8 +72939,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 milestone: type: object properties: @@ -72275,7 +72959,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &487 + - &490 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -72306,8 +72990,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 milestone: type: object properties: @@ -72326,7 +73010,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &488 + - &491 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -72357,8 +73041,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 rename: type: object properties: @@ -72380,7 +73064,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &489 + - &492 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -72411,10 +73095,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 review_requester: *19 - requested_team: *207 + requested_team: *210 requested_reviewer: *19 required: - review_requester @@ -72427,7 +73111,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &490 + - &493 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -72458,10 +73142,10 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 review_requester: *19 - requested_team: *207 + requested_team: *210 requested_reviewer: *19 required: - review_requester @@ -72474,7 +73158,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &491 + - &494 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -72505,8 +73189,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 dismissed_review: type: object properties: @@ -72534,7 +73218,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &492 + - &495 title: Locked Issue Event description: Locked Issue Event type: object @@ -72565,8 +73249,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 lock_reason: type: string example: '"off-topic"' @@ -72582,7 +73266,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &493 + - &496 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -72613,8 +73297,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 project_card: type: object properties: @@ -72648,7 +73332,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &494 + - &497 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -72679,8 +73363,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 project_card: type: object properties: @@ -72714,7 +73398,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &495 + - &498 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -72745,8 +73429,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 project_card: type: object properties: @@ -72780,7 +73464,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &496 + - &499 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -72871,7 +73555,7 @@ paths: color: red headers: Link: *39 - '410': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72888,9 +73572,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 - *18 - *20 responses: @@ -72900,7 +73584,7 @@ paths: application/json: schema: type: array - items: &482 + items: &485 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -72947,7 +73631,7 @@ paths: - color - default examples: - default: &483 + default: &486 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -72965,9 +73649,9 @@ paths: default: false headers: Link: *39 - '301': *306 + '301': *309 '404': *7 - '410': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72984,9 +73668,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 requestBody: required: false content: @@ -73045,12 +73729,12 @@ paths: application/json: schema: type: array - items: *482 + items: *485 examples: - default: *483 - '301': *306 + default: *486 + '301': *309 '404': *7 - '410': *303 + '410': *306 '422': *16 x-github: githubCloudOnly: false @@ -73067,9 +73751,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 requestBody: required: false content: @@ -73129,12 +73813,12 @@ paths: application/json: schema: type: array - items: *482 + items: *485 examples: - default: *483 - '301': *306 + default: *486 + '301': *309 '404': *7 - '410': *303 + '410': *306 '422': *16 x-github: githubCloudOnly: false @@ -73151,15 +73835,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 responses: '204': description: Response - '301': *306 + '301': *309 '404': *7 - '410': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73178,9 +73862,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 - name: name in: path required: true @@ -73193,7 +73877,7 @@ paths: application/json: schema: type: array - items: *482 + items: *485 examples: default: value: @@ -73204,9 +73888,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *306 + '301': *309 '404': *7 - '410': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73226,9 +73910,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 requestBody: required: false content: @@ -73256,7 +73940,7 @@ paths: '204': description: Response '403': *29 - '410': *303 + '410': *306 '404': *7 '422': *16 x-github: @@ -73274,9 +73958,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 responses: '204': description: Response @@ -73298,9 +73982,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 - 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. @@ -73326,13 +74010,13 @@ paths: application/json: schema: type: array - items: *281 + items: *284 examples: - default: *283 + default: *286 headers: Link: *39 '404': *7 - '410': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73350,9 +74034,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 requestBody: required: true content: @@ -73384,16 +74068,16 @@ paths: description: Response content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '201': description: Response content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '422': *16 x-github: githubCloudOnly: false @@ -73415,10 +74099,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *292 - - *293 - - *480 - - *284 + - *295 + - *296 + - *483 + - *287 responses: '204': description: Response @@ -73438,9 +74122,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *292 - - *293 - - *480 + - *295 + - *296 + - *483 - *18 - *20 responses: @@ -73455,9 +74139,6 @@ paths: description: Timeline Event type: object anyOf: - - *484 - - *485 - - *486 - *487 - *488 - *489 @@ -73468,6 +74149,9 @@ paths: - *494 - *495 - *496 + - *497 + - *498 + - *499 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -73510,7 +74194,7 @@ paths: issue_url: type: string format: uri - author_association: *91 + author_association: *94 performed_via_github_app: title: GitHub app description: GitHub apps are a new way to extend GitHub. They @@ -73520,9 +74204,9 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 - reactions: *92 + properties: *92 + required: *93 + reactions: *95 required: - event - actor @@ -73553,7 +74237,7 @@ paths: properties: type: type: string - issue: *104 + issue: *107 required: - event - created_at @@ -73745,7 +74429,7 @@ paths: type: string body_text: type: string - author_association: *91 + author_association: *94 required: - event - id @@ -73768,7 +74452,7 @@ paths: type: string comments: type: array - items: &518 + items: &521 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -73857,7 +74541,7 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *91 + author_association: *94 _links: type: object properties: @@ -73941,7 +74625,7 @@ paths: enum: - line - file - reactions: *92 + reactions: *95 body_html: type: string example: '"

comment body

"' @@ -73977,7 +74661,7 @@ paths: type: string comments: type: array - items: *407 + items: *410 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -74008,8 +74692,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 assignee: *19 required: - id @@ -74052,8 +74736,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 assignee: *19 required: - id @@ -74096,8 +74780,8 @@ paths: are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 state_reason: type: string nullable: true @@ -74266,7 +74950,7 @@ paths: headers: Link: *39 '404': *7 - '410': *303 + '410': *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74283,8 +74967,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -74294,7 +74978,7 @@ paths: application/json: schema: type: array - items: &497 + items: &500 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -74356,8 +75040,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -74393,9 +75077,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *500 examples: - default: &498 + default: &501 value: id: 1 key: ssh-rsa AAA... @@ -74428,9 +75112,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *292 - - *293 - - &499 + - *295 + - *296 + - &502 name: key_id description: The unique identifier of the key. in: path @@ -74442,9 +75126,9 @@ paths: description: Response content: application/json: - schema: *497 + schema: *500 examples: - default: *498 + default: *501 '404': *7 x-github: githubCloudOnly: false @@ -74462,9 +75146,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *292 - - *293 - - *499 + - *295 + - *296 + - *502 responses: '204': description: Response @@ -74484,8 +75168,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -74495,9 +75179,9 @@ paths: application/json: schema: type: array - items: *482 + items: *485 examples: - default: *483 + default: *486 headers: Link: *39 '404': *7 @@ -74518,8 +75202,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -74555,9 +75239,9 @@ paths: description: Response content: application/json: - schema: *482 + schema: *485 examples: - default: &500 + default: &503 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -74589,8 +75273,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *292 - - *293 + - *295 + - *296 - name: name in: path required: true @@ -74601,9 +75285,9 @@ paths: description: Response content: application/json: - schema: *482 + schema: *485 examples: - default: *500 + default: *503 '404': *7 x-github: githubCloudOnly: false @@ -74620,8 +75304,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *292 - - *293 + - *295 + - *296 - name: name in: path required: true @@ -74660,7 +75344,7 @@ paths: description: Response content: application/json: - schema: *482 + schema: *485 examples: default: value: @@ -74686,8 +75370,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *292 - - *293 + - *295 + - *296 - name: name in: path required: true @@ -74713,8 +75397,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -74750,10 +75434,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 responses: - '202': *127 + '202': *130 '403': description: |- We will return a 403 with one of the following messages: @@ -74779,8 +75463,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -74806,9 +75490,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *292 - - *293 - - *382 + - *295 + - *296 + - *385 responses: '200': description: Response @@ -74870,8 +75554,8 @@ paths: title: License Simple description: License Simple type: object - properties: *105 - required: *106 + properties: *108 + required: *109 nullable: true required: - _links @@ -74953,8 +75637,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -75019,8 +75703,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -75054,9 +75738,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *408 + schema: *411 examples: - default: *501 + default: *504 '204': description: Response when already merged '404': @@ -75081,8 +75765,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *292 - - *293 + - *295 + - *296 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -75123,12 +75807,12 @@ paths: application/json: schema: type: array - items: &502 + items: &505 title: Milestone description: A collection of related issues and pull requests. type: object - properties: *412 - required: *413 + properties: *415 + required: *416 examples: default: value: @@ -75184,8 +75868,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -75225,9 +75909,9 @@ paths: description: Response content: application/json: - schema: *502 + schema: *505 examples: - default: &503 + default: &506 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -75286,9 +75970,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *292 - - *293 - - &504 + - *295 + - *296 + - &507 name: milestone_number description: The number that identifies the milestone. in: path @@ -75300,9 +75984,9 @@ paths: description: Response content: application/json: - schema: *502 + schema: *505 examples: - default: *503 + default: *506 '404': *7 x-github: githubCloudOnly: false @@ -75319,9 +76003,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *292 - - *293 - - *504 + - *295 + - *296 + - *507 requestBody: required: false content: @@ -75359,9 +76043,9 @@ paths: description: Response content: application/json: - schema: *502 + schema: *505 examples: - default: *503 + default: *506 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75377,9 +76061,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *292 - - *293 - - *504 + - *295 + - *296 + - *507 responses: '204': description: Response @@ -75400,9 +76084,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: - - *292 - - *293 - - *504 + - *295 + - *296 + - *507 - *18 - *20 responses: @@ -75412,9 +76096,9 @@ paths: application/json: schema: type: array - items: *482 + items: *485 examples: - default: *483 + default: *486 headers: Link: *39 x-github: @@ -75433,12 +76117,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: - - *292 - - *293 - - *505 - - *506 - - *94 - - *507 + - *295 + - *296 + - *508 + - *509 + - *97 + - *510 - *18 - *20 responses: @@ -75448,9 +76132,9 @@ paths: application/json: schema: type: array - items: *117 + items: *120 examples: - default: *508 + default: *511 headers: Link: *39 x-github: @@ -75474,8 +76158,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: false content: @@ -75533,14 +76217,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: &509 + schema: &512 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -75665,7 +76349,7 @@ paths: - custom_404 - public examples: - default: &510 + default: &513 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -75706,8 +76390,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -75761,11 +76445,11 @@ paths: description: Response content: application/json: - schema: *509 + schema: *512 examples: - default: *510 + default: *513 '422': *16 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75786,8 +76470,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -75873,7 +76557,7 @@ paths: description: Response '422': *16 '400': *15 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75894,14 +76578,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response '422': *16 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75921,8 +76605,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -75932,7 +76616,7 @@ paths: application/json: schema: type: array - items: &511 + items: &514 title: Page Build description: Page Build type: object @@ -76026,8 +76710,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *292 - - *293 + - *295 + - *296 responses: '201': description: Response @@ -76072,16 +76756,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: *511 + schema: *514 examples: - default: &512 + default: &515 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -76129,8 +76813,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *292 - - *293 + - *295 + - *296 - name: build_id in: path required: true @@ -76141,9 +76825,9 @@ paths: description: Response content: application/json: - schema: *511 + schema: *514 examples: - default: *512 + default: *515 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76163,8 +76847,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -76270,9 +76954,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: - - *292 - - *293 - - &513 + - *295 + - *296 + - &516 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -76330,11 +77014,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *292 - - *293 - - *513 + - *295 + - *296 + - *516 responses: - '204': *170 + '204': *173 '404': *7 x-github: githubCloudOnly: false @@ -76359,8 +77043,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -76591,7 +77275,7 @@ paths: description: Empty response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -76618,8 +77302,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Private vulnerability reporting status @@ -76656,10 +77340,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: - - *292 - - *293 + - *295 + - *296 responses: - '204': *170 + '204': *173 '422': *15 x-github: githubCloudOnly: false @@ -76678,10 +77362,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: - - *292 - - *293 + - *295 + - *296 responses: - '204': *170 + '204': *173 '422': *15 x-github: githubCloudOnly: false @@ -76702,8 +77386,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-repository-projects parameters: - - *292 - - *293 + - *295 + - *296 - name: state description: Indicates the state of the projects to return. in: query @@ -76724,7 +77408,7 @@ paths: application/json: schema: type: array - items: *236 + items: *239 examples: default: value: @@ -76764,7 +77448,7 @@ paths: '401': *25 '403': *29 '404': *7 - '410': *303 + '410': *306 '422': *8 x-github: githubCloudOnly: false @@ -76784,8 +77468,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-a-repository-project parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -76811,13 +77495,13 @@ paths: description: Response content: application/json: - schema: *236 + schema: *239 examples: - default: *302 + default: *305 '401': *25 '403': *29 '404': *7 - '410': *303 + '410': *306 '422': *8 x-github: githubCloudOnly: false @@ -76837,8 +77521,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -76846,7 +77530,7 @@ paths: application/json: schema: type: array - items: *241 + items: *244 examples: default: value: @@ -76877,8 +77561,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -76890,7 +77574,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *241 + items: *244 required: - properties examples: @@ -76940,8 +77624,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *292 - - *293 + - *295 + - *296 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -77001,9 +77685,9 @@ paths: application/json: schema: type: array - items: *514 + items: *517 examples: - default: *515 + default: *518 headers: Link: *39 '304': *37 @@ -77035,8 +77719,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -77101,7 +77785,7 @@ paths: description: Response content: application/json: - schema: &520 + schema: &523 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -77212,8 +77896,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *412 - required: *413 + properties: *415 + required: *416 nullable: true active_lock_reason: type: string @@ -77258,7 +77942,7 @@ paths: nullable: true requested_teams: type: array - items: *516 + items: *519 nullable: true head: type: object @@ -77297,14 +77981,14 @@ paths: _links: type: object properties: - comments: *414 - commits: *414 - statuses: *414 - html: *414 - issue: *414 - review_comments: *414 - review_comment: *414 - self: *414 + comments: *417 + commits: *417 + statuses: *417 + html: *417 + issue: *417 + review_comments: *417 + review_comment: *417 + self: *417 required: - comments - commits @@ -77314,8 +77998,8 @@ paths: - review_comments - review_comment - self - author_association: *91 - auto_merge: *517 + author_association: *94 + auto_merge: *520 draft: description: Indicates whether or not the pull request is a draft. example: false @@ -77407,7 +78091,7 @@ paths: - merged_by - review_comments examples: - default: &521 + default: &524 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -77934,8 +78618,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *292 - - *293 + - *295 + - *296 - name: sort in: query required: false @@ -77954,7 +78638,7 @@ paths: enum: - asc - desc - - *94 + - *97 - *18 - *20 responses: @@ -77964,9 +78648,9 @@ paths: application/json: schema: type: array - items: *518 + items: *521 examples: - default: &523 + default: &526 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -78043,17 +78727,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: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 responses: '200': description: Response content: application/json: - schema: *518 + schema: *521 examples: - default: &519 + default: &522 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -78128,9 +78812,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: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 requestBody: required: true content: @@ -78152,9 +78836,9 @@ paths: description: Response content: application/json: - schema: *518 + schema: *521 examples: - default: *519 + default: *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78170,9 +78854,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: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 responses: '204': description: Response @@ -78193,9 +78877,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: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 - 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. @@ -78221,9 +78905,9 @@ paths: application/json: schema: type: array - items: *281 + items: *284 examples: - default: *283 + default: *286 headers: Link: *39 '404': *7 @@ -78244,9 +78928,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: - - *292 - - *293 - - *103 + - *295 + - *296 + - *106 requestBody: required: true content: @@ -78278,16 +78962,16 @@ paths: description: Reaction exists content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '201': description: Reaction created content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '422': *16 x-github: githubCloudOnly: false @@ -78309,10 +78993,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *292 - - *293 - - *103 - - *284 + - *295 + - *296 + - *106 + - *287 responses: '204': description: Response @@ -78355,9 +79039,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *292 - - *293 - - &522 + - *295 + - *296 + - &525 name: pull_number description: The number that identifies the pull request. in: path @@ -78370,9 +79054,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *520 + schema: *523 examples: - default: *521 + default: *524 '304': *37 '404': *7 '406': @@ -78407,9 +79091,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 requestBody: required: false content: @@ -78451,9 +79135,9 @@ paths: description: Response content: application/json: - schema: *520 + schema: *523 examples: - default: *521 + default: *524 '422': *16 '403': *29 x-github: @@ -78475,9 +79159,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: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 requestBody: required: true content: @@ -78537,17 +79221,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '401': *25 '403': *29 '404': *7 @@ -78577,10 +79261,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: - - *292 - - *293 - - *522 - - *114 + - *295 + - *296 + - *525 + - *117 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -78590,7 +79274,7 @@ paths: enum: - asc - desc - - *94 + - *97 - *18 - *20 responses: @@ -78600,9 +79284,9 @@ paths: application/json: schema: type: array - items: *518 + items: *521 examples: - default: *523 + default: *526 headers: Link: *39 x-github: @@ -78635,9 +79319,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: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 requestBody: required: true content: @@ -78742,7 +79426,7 @@ paths: description: Response content: application/json: - schema: *518 + schema: *521 examples: example-for-a-multi-line-comment: value: @@ -78830,10 +79514,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: - - *292 - - *293 - - *522 - - *103 + - *295 + - *296 + - *525 + - *106 requestBody: required: true content: @@ -78855,7 +79539,7 @@ paths: description: Response content: application/json: - schema: *518 + schema: *521 examples: default: value: @@ -78941,9 +79625,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 - *18 - *20 responses: @@ -78953,9 +79637,9 @@ paths: application/json: schema: type: array - items: *408 + items: *411 examples: - default: *524 + default: *527 headers: Link: *39 x-github: @@ -78985,9 +79669,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 - *18 - *20 responses: @@ -78997,7 +79681,7 @@ paths: application/json: schema: type: array - items: *423 + items: *426 examples: default: value: @@ -79035,9 +79719,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: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 responses: '204': description: Response if pull request has been merged @@ -79060,9 +79744,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 requestBody: required: false content: @@ -79173,9 +79857,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: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 responses: '200': description: Response @@ -79191,7 +79875,7 @@ paths: items: *19 teams: type: array - items: *207 + items: *210 required: - users - teams @@ -79250,9 +79934,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: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 requestBody: required: false content: @@ -79289,7 +79973,7 @@ paths: description: Response content: application/json: - schema: *514 + schema: *517 examples: default: value: @@ -79825,9 +80509,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: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 requestBody: required: true content: @@ -79861,7 +80545,7 @@ paths: description: Response content: application/json: - schema: *514 + schema: *517 examples: default: value: @@ -80366,9 +81050,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 - *18 - *20 responses: @@ -80378,7 +81062,7 @@ paths: application/json: schema: type: array - items: &525 + items: &528 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -80447,7 +81131,7 @@ paths: type: string body_text: type: string - author_association: *91 + author_association: *94 required: - id - node_id @@ -80529,9 +81213,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: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 requestBody: required: false content: @@ -80617,9 +81301,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *528 examples: - default: &527 + default: &530 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -80682,10 +81366,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: - - *292 - - *293 - - *522 - - &526 + - *295 + - *296 + - *525 + - &529 name: review_id description: The unique identifier of the review. in: path @@ -80697,9 +81381,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *528 examples: - default: &528 + default: &531 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -80758,10 +81442,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: - - *292 - - *293 - - *522 - - *526 + - *295 + - *296 + - *525 + - *529 requestBody: required: true content: @@ -80784,7 +81468,7 @@ paths: description: Response content: application/json: - schema: *525 + schema: *528 examples: default: value: @@ -80846,18 +81530,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: - - *292 - - *293 - - *522 - - *526 + - *295 + - *296 + - *525 + - *529 responses: '200': description: Response content: application/json: - schema: *525 + schema: *528 examples: - default: *527 + default: *530 '422': *8 '404': *7 x-github: @@ -80884,10 +81568,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: - - *292 - - *293 - - *522 - - *526 + - *295 + - *296 + - *525 + - *529 - *18 - *20 responses: @@ -80966,13 +81650,13 @@ paths: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *91 + author_association: *94 _links: type: object properties: - self: *414 - html: *414 - pull_request: *414 + self: *417 + html: *417 + pull_request: *417 required: - self - html @@ -80981,7 +81665,7 @@ paths: type: string body_html: type: string - reactions: *92 + reactions: *95 side: description: The side of the first line of the range for a multi-line comment. @@ -81115,10 +81799,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: - - *292 - - *293 - - *522 - - *526 + - *295 + - *296 + - *525 + - *529 requestBody: required: true content: @@ -81146,7 +81830,7 @@ paths: description: Response content: application/json: - schema: *525 + schema: *528 examples: default: value: @@ -81209,10 +81893,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: - - *292 - - *293 - - *522 - - *526 + - *295 + - *296 + - *525 + - *529 requestBody: required: true content: @@ -81247,9 +81931,9 @@ paths: description: Response content: application/json: - schema: *525 + schema: *528 examples: - default: *528 + default: *531 '404': *7 '422': *8 '403': *29 @@ -81271,9 +81955,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *292 - - *293 - - *522 + - *295 + - *296 + - *525 requestBody: required: false content: @@ -81336,8 +82020,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *292 - - *293 + - *295 + - *296 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -81350,9 +82034,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *532 examples: - default: &530 + default: &533 value: type: file encoding: base64 @@ -81394,8 +82078,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: - - *292 - - *293 + - *295 + - *296 - name: dir description: The alternate path to look for a README file in: path @@ -81415,9 +82099,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *532 examples: - default: *530 + default: *533 '404': *7 '422': *16 x-github: @@ -81439,8 +82123,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -81450,7 +82134,7 @@ paths: application/json: schema: type: array - items: &531 + items: &534 title: Release description: A release. type: object @@ -81513,7 +82197,7 @@ paths: author: *19 assets: type: array - items: &532 + items: &535 title: Release Asset description: Data related to a release. type: object @@ -81584,7 +82268,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *92 + reactions: *95 required: - assets_url - upload_url @@ -81694,8 +82378,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -81771,9 +82455,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *534 examples: - default: &535 + default: &538 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -81874,9 +82558,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *292 - - *293 - - &533 + - *295 + - *296 + - &536 name: asset_id description: The unique identifier of the asset. in: path @@ -81888,9 +82572,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *535 examples: - default: &534 + default: &537 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 @@ -81924,7 +82608,7 @@ paths: type: User site_admin: false '404': *7 - '302': *425 + '302': *428 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81940,9 +82624,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *292 - - *293 - - *533 + - *295 + - *296 + - *536 requestBody: required: false content: @@ -81970,9 +82654,9 @@ paths: description: Response content: application/json: - schema: *532 + schema: *535 examples: - default: *534 + default: *537 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81988,9 +82672,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *292 - - *293 - - *533 + - *295 + - *296 + - *536 responses: '204': description: Response @@ -82014,8 +82698,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -82100,16 +82784,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response content: application/json: - schema: *531 + schema: *534 examples: - default: *535 + default: *538 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82126,8 +82810,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *292 - - *293 + - *295 + - *296 - name: tag description: tag parameter in: path @@ -82140,9 +82824,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *534 examples: - default: *535 + default: *538 '404': *7 x-github: githubCloudOnly: false @@ -82164,9 +82848,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *292 - - *293 - - &536 + - *295 + - *296 + - &539 name: release_id description: The unique identifier of the release. in: path @@ -82180,9 +82864,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: *531 + schema: *534 examples: - default: *535 + default: *538 '401': description: Unauthorized x-github: @@ -82200,9 +82884,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *292 - - *293 - - *536 + - *295 + - *296 + - *539 requestBody: required: false content: @@ -82266,9 +82950,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *534 examples: - default: *535 + default: *538 '404': description: Not Found if the discussion category name is invalid content: @@ -82289,9 +82973,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *292 - - *293 - - *536 + - *295 + - *296 + - *539 responses: '204': description: Response @@ -82311,9 +82995,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *292 - - *293 - - *536 + - *295 + - *296 + - *539 - *18 - *20 responses: @@ -82323,7 +83007,7 @@ paths: application/json: schema: type: array - items: *532 + items: *535 examples: default: value: @@ -82404,9 +83088,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: - - *292 - - *293 - - *536 + - *295 + - *296 + - *539 - name: name in: query required: true @@ -82432,7 +83116,7 @@ paths: description: Response for successful upload content: application/json: - schema: *532 + schema: *535 examples: response-for-successful-upload: value: @@ -82486,9 +83170,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *292 - - *293 - - *536 + - *295 + - *296 + - *539 - 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. @@ -82512,9 +83196,9 @@ paths: application/json: schema: type: array - items: *281 + items: *284 examples: - default: *283 + default: *286 headers: Link: *39 '404': *7 @@ -82535,9 +83219,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *292 - - *293 - - *536 + - *295 + - *296 + - *539 requestBody: required: true content: @@ -82567,16 +83251,16 @@ paths: description: Reaction exists content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '201': description: Reaction created content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 '422': *16 x-github: githubCloudOnly: false @@ -82598,10 +83282,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *292 - - *293 - - *536 - - *284 + - *295 + - *296 + - *539 + - *287 responses: '204': description: Response @@ -82625,9 +83309,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *292 - - *293 - - *351 + - *295 + - *296 + - *354 - *18 - *20 responses: @@ -82643,8 +83327,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *537 - - &539 + - *540 + - &542 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -82663,54 +83347,54 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *538 - - *539 - - allOf: - - *540 - - *539 - allOf: - *541 - - *539 - - allOf: - *542 - - *539 - allOf: - *543 - - *539 + - *542 - allOf: - *544 - - *539 + - *542 - allOf: - *545 - - *539 + - *542 - allOf: - *546 - - *539 + - *542 - allOf: - *547 - - *539 + - *542 - allOf: - *548 - - *539 + - *542 - allOf: - *549 - - *539 + - *542 - allOf: - *550 - - *539 + - *542 - allOf: - *551 - - *539 + - *542 - allOf: - *552 - - *539 + - *542 - allOf: - *553 - - *539 + - *542 - allOf: - *554 - - *539 + - *542 + - allOf: + - *555 + - *542 + - allOf: + - *556 + - *542 + - allOf: + - *557 + - *542 examples: default: value: @@ -82749,8 +83433,8 @@ paths: category: repos subcategory: rules parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 - name: includes_parents @@ -82761,7 +83445,7 @@ paths: schema: type: boolean default: true - - *555 + - *558 responses: '200': description: Response @@ -82769,7 +83453,7 @@ paths: application/json: schema: type: array - items: *253 + items: *256 examples: default: value: @@ -82816,8 +83500,8 @@ paths: category: repos subcategory: rules parameters: - - *292 - - *293 + - *295 + - *296 requestBody: description: Request body required: true @@ -82837,16 +83521,16 @@ paths: - tag - push default: branch - enforcement: *249 + enforcement: *252 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *250 - conditions: *247 + items: *253 + conditions: *250 rules: type: array description: An array of rules within the ruleset. - items: *252 + items: *255 required: - name - enforcement @@ -82877,9 +83561,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: &565 + default: &568 value: id: 42 name: super cool ruleset @@ -82926,12 +83610,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *292 - - *293 - - *556 - - *557 - - *558 + - *295 + - *296 - *559 + - *560 + - *561 + - *562 - *18 - *20 responses: @@ -82939,9 +83623,9 @@ paths: description: Response content: application/json: - schema: *560 + schema: *563 examples: - default: *561 + default: *564 '404': *7 '500': *73 x-github: @@ -82962,17 +83646,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *292 - - *293 - - *562 + - *295 + - *296 + - *565 responses: '200': description: Response content: application/json: - schema: *563 + schema: *566 examples: - default: *564 + default: *567 '404': *7 '500': *73 x-github: @@ -83000,8 +83684,8 @@ paths: category: repos subcategory: rules parameters: - - *292 - - *293 + - *295 + - *296 - name: ruleset_id description: The ID of the ruleset. in: path @@ -83021,9 +83705,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: *565 + default: *568 '404': *7 '500': *73 put: @@ -83041,8 +83725,8 @@ paths: category: repos subcategory: rules parameters: - - *292 - - *293 + - *295 + - *296 - name: ruleset_id description: The ID of the ruleset. in: path @@ -83067,16 +83751,16 @@ paths: - branch - tag - push - enforcement: *249 + enforcement: *252 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *250 - conditions: *247 + items: *253 + conditions: *250 rules: description: An array of rules within the ruleset. type: array - items: *252 + items: *255 examples: default: value: @@ -83104,9 +83788,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *256 examples: - default: *565 + default: *568 '404': *7 '500': *73 delete: @@ -83124,8 +83808,8 @@ paths: category: repos subcategory: rules parameters: - - *292 - - *293 + - *295 + - *296 - name: ruleset_id description: The ID of the ruleset. in: path @@ -83153,20 +83837,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: - - *292 - - *293 - - *255 - - *256 - - *257 + - *295 + - *296 - *258 - - *67 - - *20 - - *18 - - *566 - - *567 - *259 - *260 - *261 + - *67 + - *20 + - *18 + - *569 + - *570 + - *262 + - *263 + - *264 responses: '200': description: Response @@ -83174,7 +83858,7 @@ paths: application/json: schema: type: array - items: &570 + items: &573 type: object properties: number: *74 @@ -83193,8 +83877,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *568 - resolution: *569 + state: *571 + resolution: *572 resolved_at: type: string format: date-time @@ -83359,15 +84043,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: - - *292 - - *293 - - *380 + - *295 + - *296 + - *383 responses: '200': description: Response content: application/json: - schema: *570 + schema: *573 examples: default: value: @@ -83415,9 +84099,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: - - *292 - - *293 - - *380 + - *295 + - *296 + - *383 requestBody: required: true content: @@ -83425,8 +84109,8 @@ paths: schema: type: object properties: - state: *568 - resolution: *569 + state: *571 + resolution: *572 resolution_comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -83444,7 +84128,7 @@ paths: description: Response content: application/json: - schema: *570 + schema: *573 examples: default: value: @@ -83515,9 +84199,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: - - *292 - - *293 - - *380 + - *295 + - *296 + - *383 - *20 - *18 responses: @@ -83528,7 +84212,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &729 + items: &732 type: object properties: type: @@ -83887,8 +84571,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -83896,14 +84580,14 @@ paths: schema: type: object properties: - reason: &572 + reason: &575 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *571 + placeholder_id: *574 required: - reason - placeholder_id @@ -83920,7 +84604,7 @@ paths: schema: type: object properties: - reason: *572 + reason: *575 expire_at: type: string format: date-time @@ -83965,8 +84649,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *292 - - *293 + - *295 + - *296 - *67 - name: sort description: The property to sort the results by. @@ -84010,9 +84694,9 @@ paths: application/json: schema: type: array - items: *573 + items: *576 examples: - default: *574 + default: *577 '400': *15 '404': *7 x-github: @@ -84035,8 +84719,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -84109,7 +84793,7 @@ paths: login: type: string description: The username of the user credited. - type: *264 + type: *267 required: - login - type @@ -84196,9 +84880,9 @@ paths: description: Response content: application/json: - schema: *573 + schema: *576 examples: - default: &576 + default: &579 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -84431,8 +85115,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -84536,7 +85220,7 @@ paths: description: Response content: application/json: - schema: *573 + schema: *576 examples: default: value: @@ -84683,17 +85367,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: - - *292 - - *293 - - *575 + - *295 + - *296 + - *578 responses: '200': description: Response content: application/json: - schema: *573 + schema: *576 examples: - default: *576 + default: *579 '403': *29 '404': *7 x-github: @@ -84717,9 +85401,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: - - *292 - - *293 - - *575 + - *295 + - *296 + - *578 requestBody: required: true content: @@ -84792,7 +85476,7 @@ paths: login: type: string description: The username of the user credited. - type: *264 + type: *267 required: - login - type @@ -84878,17 +85562,17 @@ paths: description: Response content: application/json: - schema: *573 + schema: *576 examples: - default: *576 - add_credit: *576 + default: *579 + add_credit: *579 '403': *29 '404': *7 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *124 + schema: *127 examples: invalid_state_transition: value: @@ -84919,11 +85603,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: - - *292 - - *293 - - *575 + - *295 + - *296 + - *578 responses: - '202': *127 + '202': *130 '400': *15 '403': *29 '404': *7 @@ -84948,17 +85632,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: - - *292 - - *293 - - *575 + - *295 + - *296 + - *578 responses: '202': description: Response content: application/json: - schema: *305 + schema: *308 examples: - default: *307 + default: *310 '400': *15 '422': *16 '403': *29 @@ -84984,8 +85668,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -85084,8 +85768,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -85094,7 +85778,7 @@ paths: application/json: schema: type: array - items: &577 + items: &580 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -85106,8 +85790,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *127 - '204': *170 + '202': *130 + '204': *173 '422': description: Repository contains more than 10,000 commits x-github: @@ -85127,8 +85811,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -85176,8 +85860,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *127 - '204': *170 + '202': *130 + '204': *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85204,8 +85888,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -85278,8 +85962,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *127 - '204': *170 + '202': *130 + '204': *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85301,8 +85985,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -85456,8 +86140,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -85467,7 +86151,7 @@ paths: application/json: schema: type: array - items: *577 + items: *580 examples: default: value: @@ -85480,7 +86164,7 @@ paths: - - 0 - 2 - 21 - '204': *170 + '204': *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -85500,8 +86184,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *292 - - *293 + - *295 + - *296 - name: sha in: path required: true @@ -85555,7 +86239,7 @@ paths: description: Response content: application/json: - schema: *578 + schema: *581 examples: default: value: @@ -85609,8 +86293,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -85622,7 +86306,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 x-github: @@ -85642,14 +86326,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &579 + schema: &582 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -85717,8 +86401,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: false content: @@ -85744,7 +86428,7 @@ paths: description: Response content: application/json: - schema: *579 + schema: *582 examples: default: value: @@ -85771,8 +86455,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -85792,8 +86476,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -85872,8 +86556,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: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -85881,7 +86565,7 @@ paths: application/json: schema: type: array - items: &580 + items: &583 title: Tag protection description: Tag protection type: object @@ -85933,8 +86617,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: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -85957,7 +86641,7 @@ paths: description: Response content: application/json: - schema: *580 + schema: *583 examples: default: value: @@ -85988,8 +86672,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: - - *292 - - *293 + - *295 + - *296 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -86026,8 +86710,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *292 - - *293 + - *295 + - *296 - name: ref in: path required: true @@ -86063,8 +86747,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *292 - - *293 + - *295 + - *296 - *18 - *20 responses: @@ -86074,9 +86758,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - default: *222 + default: *225 headers: Link: *39 '404': *7 @@ -86096,8 +86780,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *292 - - *293 + - *295 + - *296 - *20 - *18 responses: @@ -86105,7 +86789,7 @@ paths: description: Response content: application/json: - schema: &581 + schema: &584 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -86117,7 +86801,7 @@ paths: required: - names examples: - default: &582 + default: &585 value: names: - octocat @@ -86140,8 +86824,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -86172,9 +86856,9 @@ paths: description: Response content: application/json: - schema: *581 + schema: *584 examples: - default: *582 + default: *585 '404': *7 '422': *8 x-github: @@ -86195,9 +86879,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *292 - - *293 - - &583 + - *295 + - *296 + - &586 name: per description: The time frame to display results for. in: query @@ -86226,7 +86910,7 @@ paths: example: 128 clones: type: array - items: &584 + items: &587 title: Traffic type: object properties: @@ -86313,8 +86997,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -86404,8 +87088,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *292 - - *293 + - *295 + - *296 responses: '200': description: Response @@ -86465,9 +87149,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *292 - - *293 - - *583 + - *295 + - *296 + - *586 responses: '200': description: Response @@ -86486,7 +87170,7 @@ paths: example: 3782 views: type: array - items: *584 + items: *587 required: - uniques - count @@ -86563,8 +87247,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *292 - - *293 + - *295 + - *296 requestBody: required: true content: @@ -86600,7 +87284,7 @@ paths: description: Response content: application/json: - schema: *139 + schema: *142 examples: default: value: @@ -86838,8 +87522,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: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -86862,8 +87546,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -86885,8 +87569,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -86912,8 +87596,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *292 - - *293 + - *295 + - *296 - name: ref in: path required: true @@ -87005,9 +87689,9 @@ paths: description: Response content: application/json: - schema: *305 + schema: *308 examples: - default: *307 + default: *310 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -87048,7 +87732,7 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: default: value: @@ -87161,7 +87845,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &592 + - &595 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -87170,7 +87854,7 @@ paths: schema: type: string example: members - - &597 + - &600 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -87181,7 +87865,7 @@ paths: default: 1 format: int32 example: 1 - - &598 + - &601 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -87223,7 +87907,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &586 + items: &589 allOf: - type: object required: @@ -87298,7 +87982,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: &599 + meta: &602 type: object description: The metadata associated with the creation/updates to the user. @@ -87358,31 +88042,31 @@ paths: location: https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e startIndex: 1 itemsPerPage: 20 - '400': &587 + '400': &590 description: Bad request content: application/json: - schema: *585 + schema: *588 application/scim+json: - schema: *585 - '401': &588 + schema: *588 + '401': &591 description: Authorization failure - '403': &589 + '403': &592 description: Permission denied - '429': &590 + '429': &593 description: Too many requests content: application/json: - schema: *585 + schema: *588 application/scim+json: - schema: *585 - '500': &591 + schema: *588 + '500': &594 description: Internal server error content: application/json: - schema: *585 + schema: *588 application/scim+json: - schema: *585 + schema: *588 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -87409,7 +88093,7 @@ paths: required: true content: application/json: - schema: &595 + schema: &598 type: object required: - schemas @@ -87465,9 +88149,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *586 + schema: *589 examples: - group: &593 + group: &596 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -87486,13 +88170,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': *587 - '401': *588 - '403': *589 - '409': &596 + '400': *590 + '401': *591 + '403': *592 + '409': &599 description: Duplicate record detected - '429': *590 - '500': *591 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -87513,7 +88197,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: - - &594 + - &597 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -87521,22 +88205,22 @@ paths: schema: type: string example: 7fce0092-d52e-4f76-b727-3955bd72c939 - - *592 + - *595 - *40 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *586 + schema: *589 examples: - default: *593 - '400': *587 - '401': *588 - '403': *589 + default: *596 + '400': *590 + '401': *591 + '403': *592 '404': *7 - '429': *590 - '500': *591 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -87558,13 +88242,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: - - *594 + - *597 - *40 requestBody: required: true content: application/json: - schema: *595 + schema: *598 examples: group: summary: Group @@ -87590,17 +88274,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *586 + schema: *589 examples: - group: *593 - groupWithMembers: *593 - '400': *587 - '401': *588 - '403': *589 + group: *596 + groupWithMembers: *596 + '400': *590 + '401': *591 + '403': *592 '404': *7 - '409': *596 - '429': *590 - '500': *591 + '409': *599 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -87627,13 +88311,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: - - *594 + - *597 - *40 requestBody: required: true content: application/json: - schema: &606 + schema: &609 type: object required: - Operations @@ -87693,17 +88377,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *586 + schema: *589 examples: - updateGroup: *593 - addMembers: *593 - '400': *587 - '401': *588 - '403': *589 + updateGroup: *596 + addMembers: *596 + '400': *590 + '401': *591 + '403': *592 '404': *7 - '409': *596 - '429': *590 - '500': *591 + '409': *599 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -87723,17 +88407,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: - - *594 + - *597 - *40 responses: '204': description: Group was deleted, no content - '400': *587 - '401': *588 - '403': *589 + '400': *590 + '401': *591 + '403': *592 '404': *7 - '429': *590 - '500': *591 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -87770,8 +88454,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *597 - - *598 + - *600 + - *601 - *40 responses: '200': @@ -87804,7 +88488,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &601 + items: &604 allOf: - type: object required: @@ -87883,7 +88567,7 @@ paths: description: Whether this email address is the primary address. example: true - roles: &600 + roles: &603 type: array description: The roles assigned to the user. items: @@ -87939,7 +88623,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *599 + meta: *602 startIndex: type: integer description: A starting index for the returned page @@ -87976,11 +88660,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *587 - '401': *588 - '403': *589 - '429': *590 - '500': *591 + '400': *590 + '401': *591 + '403': *592 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -88007,7 +88691,7 @@ paths: required: true content: application/json: - schema: &604 + schema: &607 type: object required: - schemas @@ -88089,9 +88773,9 @@ paths: type: boolean description: Whether this email address is the primary address. example: true - roles: *600 + roles: *603 examples: - user: &605 + user: &608 summary: User value: schemas: @@ -88138,9 +88822,9 @@ paths: description: User has been created content: application/scim+json: - schema: *601 + schema: *604 examples: - user: &602 + user: &605 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -88166,13 +88850,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: *602 - '400': *587 - '401': *588 - '403': *589 - '409': *596 - '429': *590 - '500': *591 + enterpriseOwner: *605 + '400': *590 + '401': *591 + '403': *592 + '409': *599 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -88193,7 +88877,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: - - &603 + - &606 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -88206,15 +88890,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *601 + schema: *604 examples: - default: *602 - '400': *587 - '401': *588 - '403': *589 + default: *605 + '400': *590 + '401': *591 + '403': *592 '404': *7 - '429': *590 - '500': *591 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -88239,30 +88923,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: - - *603 + - *606 - *40 requestBody: required: true content: application/json: - schema: *604 + schema: *607 examples: - user: *605 + user: *608 responses: '200': description: User was updated content: application/scim+json: - schema: *601 + schema: *604 examples: - user: *602 - '400': *587 - '401': *588 - '403': *589 + user: *605 + '400': *590 + '401': *591 + '403': *592 '404': *7 - '409': *596 - '429': *590 - '500': *591 + '409': *599 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -88300,13 +88984,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: - - *603 + - *606 - *40 requestBody: required: true content: application/json: - schema: *606 + schema: *609 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -88346,18 +89030,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *601 - examples: - userMultiValuedProperties: *602 - userSingleValuedProperties: *602 - disableUser: *602 - '400': *587 - '401': *588 - '403': *589 + schema: *604 + examples: + userMultiValuedProperties: *605 + userSingleValuedProperties: *605 + disableUser: *605 + '400': *590 + '401': *591 + '403': *592 '404': *7 - '409': *596 - '429': *590 - '500': *591 + '409': *599 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -88377,17 +89061,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: - - *603 + - *606 - *40 responses: '204': description: User was deleted, no content - '400': *587 - '401': *588 - '403': *589 + '400': *590 + '401': *591 + '403': *592 '404': *7 - '429': *590 - '500': *591 + '429': *593 + '500': *594 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -88420,7 +89104,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *121 + - *124 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -88474,7 +89158,7 @@ paths: example: 1 Resources: type: array - items: &607 + items: &610 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -88705,22 +89389,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *37 - '404': &608 + '404': &611 description: Resource not found content: application/json: - schema: *585 + schema: *588 application/scim+json: - schema: *585 - '403': &609 + schema: *588 + '403': &612 description: Forbidden content: application/json: - schema: *585 + schema: *588 application/scim+json: - schema: *585 - '400': *587 - '429': *590 + schema: *588 + '400': *590 + '429': *593 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -88740,15 +89424,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *121 + - *124 responses: '201': description: Response content: application/scim+json: - schema: *607 + schema: *610 examples: - default: &610 + default: &613 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -88771,17 +89455,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *37 - '404': *608 - '403': *609 - '500': *591 + '404': *611 + '403': *612 + '500': *594 '409': description: Conflict content: application/json: - schema: *585 + schema: *588 application/scim+json: - schema: *585 - '400': *587 + schema: *588 + '400': *590 requestBody: required: true content: @@ -88873,18 +89557,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: - - *121 - - *603 + - *124 + - *606 responses: '200': description: Response content: application/scim+json: - schema: *607 + schema: *610 examples: - default: *610 - '404': *608 - '403': *609 + default: *613 + '404': *611 + '403': *612 '304': *37 x-github: githubCloudOnly: true @@ -88907,19 +89591,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *121 - - *603 + - *124 + - *606 responses: '200': description: Response content: application/scim+json: - schema: *607 + schema: *610 examples: - default: *610 + default: *613 '304': *37 - '404': *608 - '403': *609 + '404': *611 + '403': *612 requestBody: required: true content: @@ -89027,20 +89711,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: - - *121 - - *603 + - *124 + - *606 responses: '200': description: Response content: application/scim+json: - schema: *607 + schema: *610 examples: - default: *610 + default: *613 '304': *37 - '404': *608 - '403': *609 - '400': *587 + '404': *611 + '403': *612 + '400': *590 '429': description: Response content: @@ -89130,13 +89814,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: - - *121 - - *603 + - *124 + - *606 responses: '204': description: Response - '404': *608 - '403': *609 + '404': *611 + '403': *612 '304': *37 x-github: githubCloudOnly: true @@ -89251,7 +89935,7 @@ paths: html_url: type: string format: uri - repository: *139 + repository: *142 score: type: number file_size: @@ -89269,7 +89953,7 @@ paths: example: - 73..77 - 77..78 - text_matches: &611 + text_matches: &614 title: Search Result Text Matches type: array items: @@ -89432,7 +90116,7 @@ paths: enum: - author-date - committer-date - - &612 + - &615 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 @@ -89503,7 +90187,7 @@ paths: description: Metaproperties for Git author/committer information. type: object - properties: *349 + properties: *352 nullable: true comment_count: type: integer @@ -89523,7 +90207,7 @@ paths: url: type: string format: uri - verification: *460 + verification: *463 required: - author - committer @@ -89542,7 +90226,7 @@ paths: title: Git User description: Metaproperties for Git author/committer information. type: object - properties: *349 + properties: *352 nullable: true parents: type: array @@ -89555,12 +90239,12 @@ paths: type: string sha: type: string - repository: *139 + repository: *142 score: type: number node_id: type: string - text_matches: *611 + text_matches: *614 required: - sha - node_id @@ -89753,7 +90437,7 @@ paths: - interactions - created - updated - - *612 + - *615 - *18 - *20 responses: @@ -89858,8 +90542,8 @@ paths: title: Milestone description: A collection of related issues and pull requests. type: object - properties: *412 - required: *413 + properties: *415 + required: *416 nullable: true comments: type: integer @@ -89873,7 +90557,7 @@ paths: type: string format: date-time nullable: true - text_matches: *611 + text_matches: *614 pull_request: type: object properties: @@ -89906,7 +90590,7 @@ paths: type: string score: type: number - author_association: *91 + author_association: *94 draft: type: boolean repository: *57 @@ -89926,9 +90610,9 @@ paths: GitHub apps are first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 - reactions: *92 + properties: *92 + required: *93 + reactions: *95 required: - assignee - closed_at @@ -90097,7 +90781,7 @@ paths: enum: - created - updated - - *612 + - *615 - *18 - *20 responses: @@ -90141,7 +90825,7 @@ paths: nullable: true score: type: number - text_matches: *611 + text_matches: *614 required: - id - node_id @@ -90227,7 +90911,7 @@ paths: - forks - help-wanted-issues - updated - - *612 + - *615 - *18 - *20 responses: @@ -90446,8 +91130,8 @@ paths: title: License Simple description: License Simple type: object - properties: *105 - required: *106 + properties: *108 + required: *109 nullable: true permissions: type: object @@ -90466,7 +91150,7 @@ paths: - admin - pull - push - text_matches: *611 + text_matches: *614 temp_clone_token: type: string allow_merge_commit: @@ -90767,7 +91451,7 @@ paths: type: string format: uri nullable: true - text_matches: *611 + text_matches: *614 related: type: array nullable: true @@ -90960,7 +91644,7 @@ paths: - followers - repositories - joined - - *612 + - *615 - *18 - *20 responses: @@ -91064,7 +91748,7 @@ paths: hireable: type: boolean nullable: true - text_matches: *611 + text_matches: *614 blog: type: string nullable: true @@ -91143,7 +91827,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &613 + - &616 name: team_id description: The unique identifier of the team. in: path @@ -91155,9 +91839,9 @@ paths: description: Response content: application/json: - schema: *273 + schema: *276 examples: - default: *274 + default: *277 '404': *7 x-github: githubCloudOnly: false @@ -91184,7 +91868,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *613 + - *616 requestBody: required: true content: @@ -91247,16 +91931,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *273 + schema: *276 examples: - default: *274 + default: *277 '201': description: Response content: application/json: - schema: *273 + schema: *276 examples: - default: *274 + default: *277 '404': *7 '422': *16 '403': *29 @@ -91284,7 +91968,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *613 + - *616 responses: '204': description: Response @@ -91315,7 +91999,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *613 + - *616 - *67 - *18 - *20 @@ -91326,9 +92010,9 @@ paths: application/json: schema: type: array - items: *275 + items: *278 examples: - default: *614 + default: *617 headers: Link: *39 x-github: @@ -91357,7 +92041,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *613 + - *616 requestBody: required: true content: @@ -91391,9 +92075,9 @@ paths: description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: *276 + default: *279 x-github: triggersNotification: true githubCloudOnly: false @@ -91420,16 +92104,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *613 - - *277 + - *616 + - *280 responses: '200': description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: *276 + default: *279 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91454,8 +92138,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *613 - - *277 + - *616 + - *280 requestBody: required: false content: @@ -91478,9 +92162,9 @@ paths: description: Response content: application/json: - schema: *275 + schema: *278 examples: - default: *615 + default: *618 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91505,8 +92189,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *613 - - *277 + - *616 + - *280 responses: '204': description: Response @@ -91535,8 +92219,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *613 - - *277 + - *616 + - *280 - *67 - *18 - *20 @@ -91547,9 +92231,9 @@ paths: application/json: schema: type: array - items: *278 + items: *281 examples: - default: *616 + default: *619 headers: Link: *39 x-github: @@ -91578,8 +92262,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *613 - - *277 + - *616 + - *280 requestBody: required: true content: @@ -91601,9 +92285,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *281 examples: - default: *279 + default: *282 x-github: triggersNotification: true githubCloudOnly: false @@ -91630,17 +92314,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *613 - - *277 + - *616 - *280 + - *283 responses: '200': description: Response content: application/json: - schema: *278 + schema: *281 examples: - default: *279 + default: *282 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91665,9 +92349,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *613 - - *277 + - *616 - *280 + - *283 requestBody: required: true content: @@ -91689,9 +92373,9 @@ paths: description: Response content: application/json: - schema: *278 + schema: *281 examples: - default: *617 + default: *620 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91716,9 +92400,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *613 - - *277 + - *616 - *280 + - *283 responses: '204': description: Response @@ -91747,9 +92431,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: - - *613 - - *277 + - *616 - *280 + - *283 - 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. @@ -91775,9 +92459,9 @@ paths: application/json: schema: type: array - items: *281 + items: *284 examples: - default: *283 + default: *286 headers: Link: *39 x-github: @@ -91806,9 +92490,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: - - *613 - - *277 + - *616 - *280 + - *283 requestBody: required: true content: @@ -91840,9 +92524,9 @@ paths: description: Response content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -91868,8 +92552,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: - - *613 - - *277 + - *616 + - *280 - 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. @@ -91895,9 +92579,9 @@ paths: application/json: schema: type: array - items: *281 + items: *284 examples: - default: *283 + default: *286 headers: Link: *39 x-github: @@ -91926,8 +92610,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: - - *613 - - *277 + - *616 + - *280 requestBody: required: true content: @@ -91959,9 +92643,9 @@ paths: description: Response content: application/json: - schema: *281 + schema: *284 examples: - default: *282 + default: *285 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -91985,7 +92669,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *613 + - *616 - *18 - *20 responses: @@ -91995,9 +92679,9 @@ paths: application/json: schema: type: array - items: *204 + items: *207 examples: - default: *205 + default: *208 headers: Link: *39 x-github: @@ -92023,7 +92707,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *613 + - *616 - name: role description: Filters members returned by their role in the team. in: query @@ -92046,7 +92730,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 '404': *7 @@ -92074,8 +92758,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *613 - - *161 + - *616 + - *164 responses: '204': description: if user is a member @@ -92111,8 +92795,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *613 - - *161 + - *616 + - *164 responses: '204': description: Response @@ -92151,8 +92835,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *613 - - *161 + - *616 + - *164 responses: '204': description: Response @@ -92188,16 +92872,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: - - *613 - - *161 + - *616 + - *164 responses: '200': description: Response content: application/json: - schema: *289 + schema: *292 examples: - response-if-user-is-a-team-maintainer: *618 + response-if-user-is-a-team-maintainer: *621 '404': *7 x-github: githubCloudOnly: false @@ -92230,8 +92914,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: - - *613 - - *161 + - *616 + - *164 requestBody: required: false content: @@ -92256,9 +92940,9 @@ paths: description: Response content: application/json: - schema: *289 + schema: *292 examples: - response-if-users-membership-with-team-is-now-pending: *619 + response-if-users-membership-with-team-is-now-pending: *622 '403': description: Forbidden if team synchronization is set up '422': @@ -92292,8 +92976,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: - - *613 - - *161 + - *616 + - *164 responses: '204': description: Response @@ -92322,7 +93006,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *613 + - *616 - *18 - *20 responses: @@ -92332,9 +93016,9 @@ paths: application/json: schema: type: array - items: *290 + items: *293 examples: - default: *620 + default: *623 headers: Link: *39 '404': *7 @@ -92361,16 +93045,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: - - *613 - - *291 + - *616 + - *294 responses: '200': description: Response content: application/json: - schema: *290 + schema: *293 examples: - default: *621 + default: *624 '404': description: Not Found if project is not managed by this team x-github: @@ -92395,8 +93079,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: - - *613 - - *291 + - *616 + - *294 requestBody: required: false content: @@ -92464,8 +93148,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: - - *613 - - *291 + - *616 + - *294 responses: '204': description: Response @@ -92492,7 +93176,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *613 + - *616 - *18 - *20 responses: @@ -92502,9 +93186,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 '404': *7 @@ -92534,15 +93218,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: - - *613 - - *292 - - *293 + - *616 + - *295 + - *296 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *622 + schema: *625 examples: alternative-response-with-extra-repository-information: value: @@ -92693,9 +93377,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: - - *613 - - *292 - - *293 + - *616 + - *295 + - *296 requestBody: required: false content: @@ -92745,9 +93429,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: - - *613 - - *292 - - *293 + - *616 + - *295 + - *296 responses: '204': description: Response @@ -92776,15 +93460,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: - - *613 + - *616 responses: '200': description: Response content: application/json: - schema: *294 + schema: *297 examples: - default: *295 + default: *298 '403': *29 '404': *7 x-github: @@ -92811,7 +93495,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: - - *613 + - *616 requestBody: required: true content: @@ -92868,7 +93552,7 @@ paths: description: Response content: application/json: - schema: *294 + schema: *297 examples: default: value: @@ -92899,7 +93583,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *613 + - *616 - *18 - *20 responses: @@ -92909,9 +93593,9 @@ paths: application/json: schema: type: array - items: *207 + items: *210 examples: - response-if-child-teams-exist: *623 + response-if-child-teams-exist: *626 headers: Link: *39 '404': *7 @@ -92944,7 +93628,7 @@ paths: application/json: schema: oneOf: - - &625 + - &628 title: Private User description: Private User type: object @@ -93147,7 +93831,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *624 + - *627 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -93300,7 +93984,7 @@ paths: description: Response content: application/json: - schema: *625 + schema: *628 examples: default: value: @@ -93379,7 +94063,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 '304': *37 '404': *7 '403': *29 @@ -93402,7 +94086,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: - - *161 + - *164 responses: '204': description: If the user is blocked @@ -93430,7 +94114,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *161 + - *164 responses: '204': description: Response @@ -93454,7 +94138,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *161 + - *164 responses: '204': description: Response @@ -93503,9 +94187,9 @@ paths: type: integer codespaces: type: array - items: *211 + items: *214 examples: - default: *212 + default: *215 '304': *37 '500': *73 '401': *25 @@ -93644,17 +94328,17 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '401': *25 '403': *29 '404': *7 @@ -93698,7 +94382,7 @@ paths: type: integer secrets: type: array - items: &626 + items: &629 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -93738,7 +94422,7 @@ paths: - visibility - selected_repositories_url examples: - default: *400 + default: *403 headers: Link: *39 x-github: @@ -93808,13 +94492,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: - - *149 + - *152 responses: '200': description: Response content: application/json: - schema: *626 + schema: *629 examples: default: value: @@ -93844,7 +94528,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: - - *149 + - *152 requestBody: required: true content: @@ -93889,7 +94573,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -93917,7 +94601,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: - - *149 + - *152 responses: '204': description: Response @@ -93942,7 +94626,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: - - *149 + - *152 responses: '200': description: Response @@ -93958,9 +94642,9 @@ paths: type: integer repositories: type: array - items: *139 + items: *142 examples: - default: *627 + default: *630 '401': *25 '403': *29 '404': *7 @@ -93985,7 +94669,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: - - *149 + - *152 requestBody: required: true content: @@ -94039,7 +94723,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: - - *149 + - *152 - name: repository_id in: path required: true @@ -94072,7 +94756,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: - - *149 + - *152 - name: repository_id in: path required: true @@ -94104,15 +94788,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: - - *213 + - *216 responses: '200': description: Response content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '304': *37 '500': *73 '401': *25 @@ -94138,7 +94822,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: - - *213 + - *216 requestBody: required: false content: @@ -94168,9 +94852,9 @@ paths: description: Response content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '401': *25 '403': *29 '404': *7 @@ -94192,9 +94876,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: - - *213 + - *216 responses: - '202': *127 + '202': *130 '304': *37 '500': *73 '401': *25 @@ -94221,13 +94905,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: - - *213 + - *216 responses: '202': description: Response content: application/json: - schema: &628 + schema: &631 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -94268,7 +94952,7 @@ paths: description: Web url for the exported branch example: https://github.com/octocat/hello-world/tree/:branch examples: - default: &629 + default: &632 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -94300,7 +94984,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *213 + - *216 - name: export_id in: path required: true @@ -94313,9 +94997,9 @@ paths: description: Response content: application/json: - schema: *628 + schema: *631 examples: - default: *629 + default: *632 '404': *7 x-github: githubCloudOnly: false @@ -94336,7 +95020,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *213 + - *216 responses: '200': description: Response @@ -94352,9 +95036,9 @@ paths: type: integer machines: type: array - items: *630 + items: *633 examples: - default: *631 + default: *634 '304': *37 '500': *73 '401': *25 @@ -94383,7 +95067,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: - - *213 + - *216 requestBody: required: true content: @@ -94433,13 +95117,13 @@ paths: nullable: true owner: *19 billable_owner: *19 - repository: *305 + repository: *308 machine: type: object title: Codespace machine description: A description of the machine powering a codespace. - properties: *398 - required: *399 + properties: *401 + required: *402 nullable: true devcontainer_path: description: Path to devcontainer.json from repo root used to @@ -95213,15 +95897,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: - - *213 + - *216 responses: '200': description: Response content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '304': *37 '500': *73 '400': *15 @@ -95233,7 +95917,7 @@ paths: schema: *3 '403': *29 '404': *7 - '409': *126 + '409': *129 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -95253,15 +95937,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: - - *213 + - *216 responses: '200': description: Response content: application/json: - schema: *211 + schema: *214 examples: - default: *397 + default: *400 '500': *73 '401': *25 '403': *29 @@ -95291,9 +95975,9 @@ paths: application/json: schema: type: array - items: *223 + items: *226 examples: - default: &644 + default: &647 value: - id: 197 name: hello_docker @@ -95394,7 +96078,7 @@ paths: application/json: schema: type: array - items: &632 + items: &635 title: Email description: Email type: object @@ -95459,9 +96143,9 @@ paths: application/json: schema: type: array - items: *632 + items: *635 examples: - default: &646 + default: &649 value: - email: octocat@github.com verified: true @@ -95536,7 +96220,7 @@ paths: application/json: schema: type: array - items: *632 + items: *635 examples: default: value: @@ -95646,7 +96330,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 '304': *37 @@ -95679,7 +96363,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 '304': *37 @@ -95701,7 +96385,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: - - *161 + - *164 responses: '204': description: if the person is followed by the authenticated user @@ -95731,7 +96415,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *161 + - *164 responses: '204': description: Response @@ -95755,7 +96439,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *161 + - *164 responses: '204': description: Response @@ -95791,7 +96475,7 @@ paths: application/json: schema: type: array - items: &633 + items: &636 title: GPG Key description: A unique encryption key type: object @@ -95922,7 +96606,7 @@ paths: - subkeys - revoked examples: - default: &657 + default: &660 value: - id: 3 name: Octocat's GPG Key @@ -96007,9 +96691,9 @@ paths: description: Response content: application/json: - schema: *633 + schema: *636 examples: - default: &634 + default: &637 value: id: 3 name: Octocat's GPG Key @@ -96066,7 +96750,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: - - &635 + - &638 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -96078,9 +96762,9 @@ paths: description: Response content: application/json: - schema: *633 + schema: *636 examples: - default: *634 + default: *637 '404': *7 '304': *37 '403': *29 @@ -96103,7 +96787,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: - - *635 + - *638 responses: '204': description: Response @@ -96294,7 +96978,7 @@ paths: type: array items: *57 examples: - default: *636 + default: *639 headers: Link: *39 '404': *7 @@ -96319,7 +97003,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *23 - - *134 + - *137 responses: '204': description: Response @@ -96345,7 +97029,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *23 - - *134 + - *137 responses: '204': description: Response @@ -96379,12 +97063,12 @@ paths: application/json: schema: anyOf: - - *202 + - *205 - type: object properties: {} additionalProperties: false examples: - default: *203 + default: *206 '204': description: Response when there are no restrictions x-github: @@ -96408,7 +97092,7 @@ paths: required: true content: application/json: - schema: *471 + schema: *474 examples: default: value: @@ -96419,7 +97103,7 @@ paths: description: Response content: application/json: - schema: *202 + schema: *205 examples: default: value: @@ -96500,7 +97184,7 @@ paths: - closed - all default: open - - *208 + - *211 - name: sort description: What to sort results by. in: query @@ -96513,7 +97197,7 @@ paths: - comments default: created - *67 - - *94 + - *97 - *18 - *20 responses: @@ -96523,9 +97207,9 @@ paths: application/json: schema: type: array - items: *104 + items: *107 examples: - default: *209 + default: *212 headers: Link: *39 '404': *7 @@ -96558,7 +97242,7 @@ paths: application/json: schema: type: array - items: &637 + items: &640 title: Key description: Key type: object @@ -96655,9 +97339,9 @@ paths: description: Response content: application/json: - schema: *637 + schema: *640 examples: - default: &638 + default: &641 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -96690,15 +97374,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: - - *499 + - *502 responses: '200': description: Response content: application/json: - schema: *637 + schema: *640 examples: - default: *638 + default: *641 '404': *7 '304': *37 '403': *29 @@ -96721,7 +97405,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: - - *499 + - *502 responses: '204': description: Response @@ -96754,7 +97438,7 @@ paths: application/json: schema: type: array - items: &639 + items: &642 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -96811,7 +97495,7 @@ paths: - id - type - login - plan: *108 + plan: *111 required: - billing_cycle - next_billing_date @@ -96822,7 +97506,7 @@ paths: - account - plan examples: - default: &640 + default: &643 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -96884,9 +97568,9 @@ paths: application/json: schema: type: array - items: *639 + items: *642 examples: - default: *640 + default: *643 headers: Link: *39 '304': *37 @@ -96926,7 +97610,7 @@ paths: application/json: schema: type: array - items: *214 + items: *217 examples: default: value: @@ -97028,13 +97712,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: - - *121 + - *124 responses: '200': description: Response content: application/json: - schema: *214 + schema: *217 examples: default: value: @@ -97092,7 +97776,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: - - *121 + - *124 requestBody: required: true content: @@ -97117,7 +97801,7 @@ paths: description: Response content: application/json: - schema: *214 + schema: *217 examples: default: value: @@ -97185,7 +97869,7 @@ paths: application/json: schema: type: array - items: *216 + items: *219 examples: default: value: @@ -97438,7 +98122,7 @@ paths: description: Response content: application/json: - schema: *216 + schema: *219 examples: default: value: @@ -97618,7 +98302,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *217 + - *220 - name: exclude in: query required: false @@ -97631,7 +98315,7 @@ paths: description: Response content: application/json: - schema: *216 + schema: *219 examples: default: value: @@ -97825,7 +98509,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *217 + - *220 responses: '302': description: Response @@ -97851,7 +98535,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *217 + - *220 responses: '204': description: Response @@ -97880,8 +98564,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *217 - - *641 + - *220 + - *644 responses: '204': description: Response @@ -97905,7 +98589,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *217 + - *220 - *18 - *20 responses: @@ -97915,9 +98599,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 '404': *7 @@ -97954,7 +98638,7 @@ paths: type: array items: *52 examples: - default: *642 + default: *645 headers: Link: *39 '304': *37 @@ -97996,7 +98680,7 @@ paths: - docker - nuget - container - - *643 + - *646 - *20 - *18 responses: @@ -98006,10 +98690,10 @@ paths: application/json: schema: type: array - items: *223 + items: *226 examples: - default: *644 - '400': *645 + default: *647 + '400': *648 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98029,16 +98713,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: - - *225 - - *226 + - *228 + - *229 responses: '200': description: Response content: application/json: - schema: *223 + schema: *226 examples: - default: &658 + default: &661 value: id: 40201 name: octo-name @@ -98151,8 +98835,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: - - *225 - - *226 + - *228 + - *229 responses: '204': description: Response @@ -98182,8 +98866,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: - - *225 - - *226 + - *228 + - *229 - name: token description: package token schema: @@ -98215,8 +98899,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: - - *225 - - *226 + - *228 + - *229 - *20 - *18 - name: state @@ -98236,7 +98920,7 @@ paths: application/json: schema: type: array - items: *227 + items: *230 examples: default: value: @@ -98285,15 +98969,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: - - *225 - - *226 - *228 + - *229 + - *231 responses: '200': description: Response content: application/json: - schema: *227 + schema: *230 examples: default: value: @@ -98329,9 +99013,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: - - *225 - - *226 - *228 + - *229 + - *231 responses: '204': description: Response @@ -98361,9 +99045,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: - - *225 - - *226 - *228 + - *229 + - *231 responses: '204': description: Response @@ -98419,7 +99103,7 @@ paths: description: Response content: application/json: - schema: *236 + schema: *239 examples: default: value: @@ -98488,9 +99172,9 @@ paths: application/json: schema: type: array - items: *632 + items: *635 examples: - default: *646 + default: *649 headers: Link: *39 '304': *37 @@ -98603,7 +99287,7 @@ paths: type: array items: *57 examples: - default: &653 + default: &656 summary: Default response value: - id: 1296269 @@ -98905,9 +99589,9 @@ paths: description: Response content: application/json: - schema: *305 + schema: *308 examples: - default: *307 + default: *310 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -98945,9 +99629,9 @@ paths: application/json: schema: type: array - items: *473 + items: *476 examples: - default: *647 + default: *650 headers: Link: *39 '304': *37 @@ -98970,12 +99654,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *206 + - *209 responses: '204': description: Response '403': *29 - '409': *126 + '409': *129 '404': *7 '304': *37 x-github: @@ -98993,11 +99677,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *206 + - *209 responses: '204': description: Response - '409': *126 + '409': *129 '304': *37 '404': *7 '403': *29 @@ -99026,7 +99710,7 @@ paths: application/json: schema: type: array - items: &648 + items: &651 title: Social account description: Social media account type: object @@ -99041,7 +99725,7 @@ paths: - provider - url examples: - default: &649 + default: &652 value: - provider: twitter url: https://twitter.com/github @@ -99103,9 +99787,9 @@ paths: application/json: schema: type: array - items: *648 + items: *651 examples: - default: *649 + default: *652 '422': *16 '304': *37 '404': *7 @@ -99192,7 +99876,7 @@ paths: application/json: schema: type: array - items: &650 + items: &653 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -99212,7 +99896,7 @@ paths: - title - created_at examples: - default: &659 + default: &662 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -99278,9 +99962,9 @@ paths: description: Response content: application/json: - schema: *650 + schema: *653 examples: - default: &651 + default: &654 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -99311,7 +99995,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: - - &652 + - &655 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -99323,9 +100007,9 @@ paths: description: Response content: application/json: - schema: *650 + schema: *653 examples: - default: *651 + default: *654 '404': *7 '304': *37 '403': *29 @@ -99348,7 +100032,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: - - *652 + - *655 responses: '204': description: Response @@ -99377,7 +100061,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: - - &660 + - &663 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 @@ -99402,11 +100086,11 @@ paths: type: array items: *57 examples: - default-response: *653 + default-response: *656 application/vnd.github.v3.star+json: schema: type: array - items: &661 + items: &664 title: Starred Repository description: Starred Repository type: object @@ -99562,8 +100246,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: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response if this repository is starred by you @@ -99591,8 +100275,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: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -99616,8 +100300,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: - - *292 - - *293 + - *295 + - *296 responses: '204': description: Response @@ -99650,9 +100334,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 '304': *37 @@ -99689,7 +100373,7 @@ paths: application/json: schema: type: array - items: *273 + items: *276 examples: default: value: @@ -99765,7 +100449,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *110 + - *113 responses: '200': description: Response @@ -99773,10 +100457,10 @@ paths: application/json: schema: oneOf: - - *625 - - *624 + - *628 + - *627 examples: - default-response: &655 + default-response: &658 summary: Default response value: login: octocat @@ -99811,7 +100495,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &656 + response-with-git-hub-plan-information: &659 summary: Response with GitHub plan information value: login: octocat @@ -99871,7 +100555,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *654 + - *657 - *18 responses: '200': @@ -99882,7 +100566,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: example: ; rel="next" @@ -99910,7 +100594,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *161 + - *164 responses: '200': description: Response @@ -99918,11 +100602,11 @@ paths: application/json: schema: oneOf: - - *625 - - *624 + - *628 + - *627 examples: - default-response: *655 - response-with-git-hub-plan-information: *656 + default-response: *658 + response-with-git-hub-plan-information: *659 '404': *7 x-github: githubCloudOnly: false @@ -99948,7 +100632,7 @@ paths: - *18 - *65 - *66 - - *161 + - *164 - name: subject_digest description: Subject Digest in: path @@ -100048,7 +100732,7 @@ paths: description: Response content: application/json: - schema: *150 + schema: *153 examples: default: value: @@ -100074,7 +100758,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: - - *161 + - *164 responses: '200': description: Response @@ -100082,9 +100766,9 @@ paths: application/json: schema: type: array - items: *223 + items: *226 examples: - default: *644 + default: *647 '403': *29 '401': *25 x-github: @@ -100107,7 +100791,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *161 + - *164 - *18 - *20 responses: @@ -100117,7 +100801,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: default: value: @@ -100188,8 +100872,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: - - *161 - - *121 + - *164 + - *124 - *18 - *20 responses: @@ -100199,7 +100883,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: default: value: @@ -100278,7 +100962,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *161 + - *164 - *18 - *20 responses: @@ -100288,7 +100972,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: default: value: @@ -100355,7 +101039,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *161 + - *164 - *18 - *20 responses: @@ -100367,7 +101051,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 x-github: @@ -100386,7 +101070,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *161 + - *164 - *18 - *20 responses: @@ -100398,7 +101082,7 @@ paths: type: array items: *19 examples: - default: *210 + default: *213 headers: Link: *39 x-github: @@ -100417,7 +101101,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: - - *161 + - *164 - name: target_user in: path required: true @@ -100444,8 +101128,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *161 - - *94 + - *164 + - *97 - *18 - *20 responses: @@ -100455,9 +101139,9 @@ paths: application/json: schema: type: array - items: *95 + items: *98 examples: - default: *96 + default: *99 headers: Link: *39 '422': *16 @@ -100478,7 +101162,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: - - *161 + - *164 - *18 - *20 responses: @@ -100488,9 +101172,9 @@ paths: application/json: schema: type: array - items: *633 + items: *636 examples: - default: *657 + default: *660 headers: Link: *39 x-github: @@ -100514,7 +101198,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *161 + - *164 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -100586,7 +101270,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: - - *161 + - *164 responses: '200': description: Response @@ -100594,7 +101278,7 @@ paths: application/json: schema: *22 examples: - default: *470 + default: *473 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100612,7 +101296,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *161 + - *164 - *18 - *20 responses: @@ -100660,7 +101344,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *161 + - *164 - *18 - *20 responses: @@ -100672,7 +101356,7 @@ paths: type: array items: *52 examples: - default: *642 + default: *645 headers: Link: *39 x-github: @@ -100711,8 +101395,8 @@ paths: - docker - nuget - container - - *643 - - *161 + - *646 + - *164 - *20 - *18 responses: @@ -100722,12 +101406,12 @@ paths: application/json: schema: type: array - items: *223 + items: *226 examples: - default: *644 + default: *647 '403': *29 '401': *25 - '400': *645 + '400': *648 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100747,17 +101431,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *225 - - *226 - - *161 + - *228 + - *229 + - *164 responses: '200': description: Response content: application/json: - schema: *223 + schema: *226 examples: - default: *658 + default: *661 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100778,9 +101462,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *225 - - *226 - - *161 + - *228 + - *229 + - *164 responses: '204': description: Response @@ -100812,9 +101496,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *225 - - *226 - - *161 + - *228 + - *229 + - *164 - name: token description: package token schema: @@ -100846,9 +101530,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: - - *225 - - *226 - - *161 + - *228 + - *229 + - *164 responses: '200': description: Response @@ -100856,7 +101540,7 @@ paths: application/json: schema: type: array - items: *227 + items: *230 examples: default: value: @@ -100914,16 +101598,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: - - *225 - - *226 - *228 - - *161 + - *229 + - *231 + - *164 responses: '200': description: Response content: application/json: - schema: *227 + schema: *230 examples: default: value: @@ -100958,10 +101642,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *225 - - *226 - - *161 - *228 + - *229 + - *164 + - *231 responses: '204': description: Response @@ -100993,10 +101677,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *225 - - *226 - - *161 - *228 + - *229 + - *164 + - *231 responses: '204': description: Response @@ -101019,7 +101703,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-user-projects parameters: - - *161 + - *164 - name: state description: Indicates the state of the projects to return. in: query @@ -101040,7 +101724,7 @@ paths: application/json: schema: type: array - items: *236 + items: *239 examples: default: value: @@ -101099,7 +101783,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: - - *161 + - *164 - *18 - *20 responses: @@ -101109,7 +101793,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: default: value: @@ -101188,7 +101872,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: - - *161 + - *164 - *18 - *20 responses: @@ -101198,7 +101882,7 @@ paths: application/json: schema: type: array - items: *116 + items: *119 examples: default: value: @@ -101275,7 +101959,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *161 + - *164 - name: type description: Limit results to repositories of the specified type. in: query @@ -101318,9 +102002,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 x-github: @@ -101344,15 +102028,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: - - *161 + - *164 responses: '200': description: Response content: application/json: - schema: *265 + schema: *268 examples: - default: *266 + default: *269 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -101374,15 +102058,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: - - *161 + - *164 responses: '200': description: Response content: application/json: - schema: *269 + schema: *272 examples: - default: *270 + default: *273 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -101404,15 +102088,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: - - *161 + - *164 responses: '200': description: Response content: application/json: - schema: *271 + schema: *274 examples: - default: *272 + default: *275 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -101430,7 +102114,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: - - *161 + - *164 - *18 - *20 responses: @@ -101440,9 +102124,9 @@ paths: application/json: schema: type: array - items: *648 + items: *651 examples: - default: *649 + default: *652 headers: Link: *39 x-github: @@ -101462,7 +102146,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: - - *161 + - *164 - *18 - *20 responses: @@ -101472,9 +102156,9 @@ paths: application/json: schema: type: array - items: *650 + items: *653 examples: - default: *659 + default: *662 headers: Link: *39 x-github: @@ -101498,8 +102182,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *161 - - *660 + - *164 + - *663 - *67 - *18 - *20 @@ -101511,11 +102195,11 @@ paths: schema: anyOf: - type: array - items: *661 + items: *664 - type: array items: *57 examples: - default-response: *653 + default-response: *656 headers: Link: *39 x-github: @@ -101534,7 +102218,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *161 + - *164 - *18 - *20 responses: @@ -101544,9 +102228,9 @@ paths: application/json: schema: type: array - items: *139 + items: *142 examples: - default: *229 + default: *232 headers: Link: *39 x-github: @@ -101674,7 +102358,7 @@ x-webhooks: type: string enum: - disabled - enterprise: &662 + enterprise: &665 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -101732,7 +102416,7 @@ x-webhooks: - created_at - updated_at - avatar_url - installation: &663 + installation: &666 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -101751,7 +102435,7 @@ x-webhooks: required: - id - node_id - organization: &664 + organization: &667 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -101811,13 +102495,13 @@ x-webhooks: - public_members_url - avatar_url - description - repository: &665 + repository: &668 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: &702 + properties: &705 id: description: Unique identifier of the repository example: 42 @@ -101837,8 +102521,8 @@ x-webhooks: title: License Simple description: License Simple type: object - properties: *105 - required: *106 + properties: *108 + required: *109 nullable: true organization: title: Simple User @@ -102500,7 +103184,7 @@ x-webhooks: type: boolean description: Whether anonymous git access is enabled for this repository - required: &703 + required: &706 - archive_url - assignees_url - blobs_url @@ -102651,10 +103335,10 @@ x-webhooks: type: string enum: - enabled - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -102730,11 +103414,11 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - rule: &666 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + rule: &669 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) @@ -102957,11 +103641,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - rule: *666 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + rule: *669 sender: *19 required: - action @@ -103144,11 +103828,11 @@ x-webhooks: - everyone required: - from - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - rule: *666 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + rule: *669 sender: *19 required: - action @@ -103221,7 +103905,7 @@ x-webhooks: required: true content: application/json: - schema: &669 + schema: &672 title: Exemption request cancellation event type: object properties: @@ -103229,11 +103913,11 @@ x-webhooks: type: string enum: - cancelled - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - exemption_request: &667 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + exemption_request: &670 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -103369,7 +104053,7 @@ x-webhooks: type: array description: The responses to the exemption request. nullable: true - items: &668 + items: &671 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -103474,7 +104158,7 @@ x-webhooks: required: true content: application/json: - schema: &670 + schema: &673 title: Exemption request completed event type: object properties: @@ -103482,11 +104166,11 @@ x-webhooks: type: string enum: - completed - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - exemption_request: *667 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + exemption_request: *670 sender: *19 required: - action @@ -103558,7 +104242,7 @@ x-webhooks: required: true content: application/json: - schema: &671 + schema: &674 title: Exemption request created event type: object properties: @@ -103566,11 +104250,11 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - exemption_request: *667 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + exemption_request: *670 sender: *19 required: - action @@ -103642,7 +104326,7 @@ x-webhooks: required: true content: application/json: - schema: &672 + schema: &675 title: Exemption response dismissed event type: object properties: @@ -103650,12 +104334,12 @@ x-webhooks: type: string enum: - response_dismissed - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - exemption_request: *667 - exemption_response: *668 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + exemption_request: *670 + exemption_response: *671 sender: *19 required: - action @@ -103729,7 +104413,7 @@ x-webhooks: required: true content: application/json: - schema: &673 + schema: &676 title: Exemption response submitted event type: object properties: @@ -103737,12 +104421,12 @@ x-webhooks: type: string enum: - response_submitted - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - exemption_request: *667 - exemption_response: *668 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + exemption_request: *670 + exemption_response: *671 sender: *19 required: - action @@ -103815,7 +104499,7 @@ x-webhooks: required: true content: application/json: - schema: *669 + schema: *672 responses: '200': description: Return a 200 status to indicate that the data was received @@ -103882,7 +104566,7 @@ x-webhooks: required: true content: application/json: - schema: *670 + schema: *673 responses: '200': description: Return a 200 status to indicate that the data was received @@ -103949,7 +104633,7 @@ x-webhooks: required: true content: application/json: - schema: *671 + schema: *674 responses: '200': description: Return a 200 status to indicate that the data was received @@ -104016,7 +104700,7 @@ x-webhooks: required: true content: application/json: - schema: *672 + schema: *675 responses: '200': description: Return a 200 status to indicate that the data was received @@ -104084,7 +104768,7 @@ x-webhooks: required: true content: application/json: - schema: *673 + schema: *676 responses: '200': description: Return a 200 status to indicate that the data was received @@ -104162,7 +104846,7 @@ x-webhooks: type: string enum: - completed - check_run: &675 + check_run: &678 title: CheckRun description: A check performed on the code of a given code change type: object @@ -104176,8 +104860,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 check_suite: description: A suite of checks performed on the code of a given code change @@ -104225,8 +104909,8 @@ x-webhooks: type: string pull_requests: type: array - items: *362 - repository: *139 + items: *365 + repository: *142 status: example: completed type: string @@ -104263,7 +104947,7 @@ x-webhooks: - skipped - timed_out - action_required - deployment: *674 + deployment: *677 details_url: example: https://example.com type: string @@ -104313,7 +104997,7 @@ x-webhooks: - annotations_url pull_requests: type: array - items: *362 + items: *365 started_at: example: '2018-05-04T01:14:52Z' type: string @@ -104348,9 +105032,9 @@ x-webhooks: - output - app - pull_requests - installation: *663 - organization: *664 - repository: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - check_run @@ -104743,10 +105427,10 @@ x-webhooks: type: string enum: - created - check_run: *675 - installation: *663 - organization: *664 - repository: *665 + check_run: *678 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - check_run @@ -105142,10 +105826,10 @@ x-webhooks: type: string enum: - requested_action - check_run: *675 - installation: *663 - organization: *664 - repository: *665 + check_run: *678 + installation: *666 + organization: *667 + repository: *668 requested_action: description: The action requested by the user. type: object @@ -105550,10 +106234,10 @@ x-webhooks: type: string enum: - rerequested - check_run: *675 - installation: *663 - organization: *664 - repository: *665 + check_run: *678 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - check_run @@ -106530,10 +107214,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -107203,10 +107887,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -107870,10 +108554,10 @@ x-webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -108173,20 +108857,20 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: &676 + commit_oid: &679 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: *662 - installation: *663 - organization: *664 - ref: &677 + enterprise: *665 + installation: *666 + organization: *667 + ref: &680 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: *665 + repository: *668 sender: *19 required: - action @@ -108504,12 +109188,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *676 - enterprise: *662 - installation: *663 - organization: *664 - ref: *677 - repository: *665 + commit_oid: *679 + enterprise: *665 + installation: *666 + organization: *667 + ref: *680 + repository: *668 sender: *19 required: - action @@ -108604,7 +109288,7 @@ x-webhooks: nullable: true dismissed_by: nullable: true - dismissed_comment: *375 + dismissed_comment: *378 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -108766,12 +109450,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *676 - enterprise: *662 - installation: *663 - organization: *664 - ref: *677 - repository: *665 + commit_oid: *679 + enterprise: *665 + installation: *666 + organization: *667 + ref: *680 + repository: *668 sender: *19 required: - action @@ -109092,12 +109776,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *676 - enterprise: *662 - installation: *663 - organization: *664 - ref: *677 - repository: *665 + commit_oid: *679 + enterprise: *665 + installation: *666 + organization: *667 + ref: *680 + repository: *668 sender: *19 required: - action @@ -109354,16 +110038,16 @@ x-webhooks: triggered by the `sender` and this value will be empty. type: string nullable: true - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true - repository: *665 + repository: *668 sender: *19 required: - action @@ -109589,12 +110273,12 @@ x-webhooks: - dismissed_reason - rule - tool - commit_oid: *676 - enterprise: *662 - installation: *663 - organization: *664 - ref: *677 - repository: *665 + commit_oid: *679 + enterprise: *665 + installation: *666 + organization: *667 + ref: *680 + repository: *668 sender: *19 required: - action @@ -109851,10 +110535,10 @@ x-webhooks: - updated_at - author_association - body - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -109934,18 +110618,18 @@ x-webhooks: description: The repository's current description. type: string nullable: true - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *664 - pusher_type: &678 + organization: *667 + pusher_type: &681 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &679 + ref: &682 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -109955,7 +110639,7 @@ x-webhooks: enum: - tag - branch - repository: *665 + repository: *668 sender: *19 required: - ref @@ -110037,10 +110721,10 @@ x-webhooks: type: string enum: - created - definition: *237 - enterprise: *662 - installation: *663 - organization: *664 + definition: *240 + enterprise: *665 + installation: *666 + organization: *667 sender: *19 required: - action @@ -110124,9 +110808,9 @@ x-webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 sender: *19 required: - action @@ -110202,10 +110886,10 @@ x-webhooks: type: string enum: - updated - definition: *237 - enterprise: *662 - installation: *663 - organization: *664 + definition: *240 + enterprise: *665 + installation: *666 + organization: *667 sender: *19 required: - action @@ -110281,19 +110965,19 @@ x-webhooks: type: string enum: - updated - enterprise: *662 - installation: *663 - repository: *665 - organization: *664 + enterprise: *665 + installation: *666 + repository: *668 + organization: *667 sender: *19 new_property_values: type: array description: The new custom property values for the repository. - items: *241 + items: *244 old_property_values: type: array description: The old custom property values for the repository. - items: *241 + items: *244 required: - action - repository @@ -110369,18 +111053,18 @@ x-webhooks: title: delete event type: object properties: - enterprise: *662 - installation: *663 - organization: *664 - pusher_type: *678 - ref: *679 + enterprise: *665 + installation: *666 + organization: *667 + pusher_type: *681 + ref: *682 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *665 + repository: *668 sender: *19 required: - ref @@ -110464,11 +111148,11 @@ x-webhooks: type: string enum: - auto_dismissed - alert: *429 - installation: *663 - organization: *664 - enterprise: *662 - repository: *665 + alert: *432 + installation: *666 + organization: *667 + enterprise: *665 + repository: *668 sender: *19 required: - action @@ -110552,11 +111236,11 @@ x-webhooks: type: string enum: - auto_reopened - alert: *429 - installation: *663 - organization: *664 - enterprise: *662 - repository: *665 + alert: *432 + installation: *666 + organization: *667 + enterprise: *665 + repository: *668 sender: *19 required: - action @@ -110640,11 +111324,11 @@ x-webhooks: type: string enum: - created - alert: *429 - installation: *663 - organization: *664 - enterprise: *662 - repository: *665 + alert: *432 + installation: *666 + organization: *667 + enterprise: *665 + repository: *668 sender: *19 required: - action @@ -110726,11 +111410,11 @@ x-webhooks: type: string enum: - dismissed - alert: *429 - installation: *663 - organization: *664 - enterprise: *662 - repository: *665 + alert: *432 + installation: *666 + organization: *667 + enterprise: *665 + repository: *668 sender: *19 required: - action @@ -110812,11 +111496,11 @@ x-webhooks: type: string enum: - fixed - alert: *429 - installation: *663 - organization: *664 - enterprise: *662 - repository: *665 + alert: *432 + installation: *666 + organization: *667 + enterprise: *665 + repository: *668 sender: *19 required: - action @@ -110899,11 +111583,11 @@ x-webhooks: type: string enum: - reintroduced - alert: *429 - installation: *663 - organization: *664 - enterprise: *662 - repository: *665 + alert: *432 + installation: *666 + organization: *667 + enterprise: *665 + repository: *668 sender: *19 required: - action @@ -110985,11 +111669,11 @@ x-webhooks: type: string enum: - reopened - alert: *429 - installation: *663 - organization: *664 - enterprise: *662 - repository: *665 + alert: *432 + installation: *666 + organization: *667 + enterprise: *665 + repository: *668 sender: *19 required: - action @@ -111066,9 +111750,9 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - key: &680 + enterprise: *665 + installation: *666 + key: &683 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -111102,8 +111786,8 @@ x-webhooks: - verified - created_at - read_only - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -111180,11 +111864,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - key: *680 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + key: *683 + organization: *667 + repository: *668 sender: *19 required: - action @@ -111745,12 +112429,12 @@ x-webhooks: - updated_at - statuses_url - repository_url - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - workflow: &684 + workflow: &687 title: Workflow type: object nullable: true @@ -112476,13 +113160,13 @@ x-webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *435 + deployment: *438 pull_requests: type: array - items: *520 - repository: *665 - organization: *664 - installation: *663 + items: *523 + repository: *668 + organization: *667 + installation: *666 sender: *19 responses: '200': @@ -112553,7 +113237,7 @@ x-webhooks: type: string enum: - approved - approver: &681 + approver: &684 type: object properties: avatar_url: @@ -112596,11 +113280,11 @@ x-webhooks: type: string comment: type: string - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - reviewers: &682 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + reviewers: &685 type: array items: type: object @@ -112679,7 +113363,7 @@ x-webhooks: sender: *19 since: type: string - workflow_job_run: &683 + workflow_job_run: &686 type: object properties: conclusion: @@ -113410,18 +114094,18 @@ x-webhooks: type: string enum: - rejected - approver: *681 + approver: *684 comment: type: string - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - reviewers: *682 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + reviewers: *685 sender: *19 since: type: string - workflow_job_run: *683 + workflow_job_run: *686 workflow_job_runs: type: array items: @@ -114125,13 +114809,13 @@ x-webhooks: type: string enum: - requested - enterprise: *662 + enterprise: *665 environment: type: string - installation: *663 - organization: *664 - repository: *665 - requestor: &689 + installation: *666 + organization: *667 + repository: *668 + requestor: &692 title: User type: object nullable: true @@ -116030,12 +116714,12 @@ x-webhooks: - updated_at - deployment_url - repository_url - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - workflow: *684 + workflow: *687 workflow_run: title: Deployment Workflow Run type: object @@ -116715,7 +117399,7 @@ x-webhooks: type: string enum: - answered - answer: &687 + answer: &690 type: object properties: author_association: @@ -116872,7 +117556,7 @@ x-webhooks: - created_at - updated_at - body - discussion: &685 + discussion: &688 title: Discussion description: A Discussion in a repository. type: object @@ -117158,7 +117842,7 @@ x-webhooks: - id labels: type: array - items: *482 + items: *485 required: - repository_url - category @@ -117180,10 +117864,10 @@ x-webhooks: - author_association - active_lock_reason - body - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -117310,11 +117994,11 @@ x-webhooks: - from required: - category - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -117397,11 +118081,11 @@ x-webhooks: type: string enum: - closed - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -117483,7 +118167,7 @@ x-webhooks: type: string enum: - created - comment: &686 + comment: &689 type: object properties: author_association: @@ -117640,11 +118324,11 @@ x-webhooks: - updated_at - body - reactions - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -117727,12 +118411,12 @@ x-webhooks: type: string enum: - deleted - comment: *686 - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + comment: *689 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -117827,12 +118511,12 @@ x-webhooks: - from required: - body - comment: *686 - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + comment: *689 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -117916,11 +118600,11 @@ x-webhooks: type: string enum: - created - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118002,11 +118686,11 @@ x-webhooks: type: string enum: - deleted - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118106,11 +118790,11 @@ x-webhooks: type: string required: - from - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118192,10 +118876,10 @@ x-webhooks: type: string enum: - labeled - discussion: *685 - enterprise: *662 - installation: *663 - label: &688 + discussion: *688 + enterprise: *665 + installation: *666 + label: &691 title: Label type: object properties: @@ -118227,8 +118911,8 @@ x-webhooks: - color - default - description - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118311,11 +118995,11 @@ x-webhooks: type: string enum: - locked - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118397,11 +119081,11 @@ x-webhooks: type: string enum: - pinned - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118483,11 +119167,11 @@ x-webhooks: type: string enum: - reopened - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118572,16 +119256,16 @@ x-webhooks: changes: type: object properties: - new_discussion: *685 - new_repository: *665 + new_discussion: *688 + new_repository: *668 required: - new_discussion - new_repository - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118664,10 +119348,10 @@ x-webhooks: type: string enum: - unanswered - discussion: *685 - old_answer: *687 - organization: *664 - repository: *665 + discussion: *688 + old_answer: *690 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118749,12 +119433,12 @@ x-webhooks: type: string enum: - unlabeled - discussion: *685 - enterprise: *662 - installation: *663 - label: *688 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + label: *691 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118837,11 +119521,11 @@ x-webhooks: type: string enum: - unlocked - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -118923,11 +119607,11 @@ x-webhooks: type: string enum: - unpinned - discussion: *685 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + discussion: *688 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -119000,7 +119684,7 @@ x-webhooks: description: A user forks a repository. type: object properties: - enterprise: *662 + enterprise: *665 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -119660,9 +120344,9 @@ x-webhooks: type: integer watchers_count: type: integer - installation: *663 - organization: *664 - repository: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - forkee @@ -119808,9 +120492,9 @@ x-webhooks: title: gollum event type: object properties: - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 pages: description: The pages that were updated. type: array @@ -119847,7 +120531,7 @@ x-webhooks: - action - sha - html_url - repository: *665 + repository: *668 sender: *19 required: - pages @@ -119923,10 +120607,10 @@ x-webhooks: type: string enum: - created - enterprise: *662 + enterprise: *665 installation: *22 - organization: *664 - repositories: &690 + organization: *667 + repositories: &693 description: An array of repository objects that the installation can access. type: array @@ -119952,8 +120636,8 @@ x-webhooks: - name - full_name - private - repository: *665 - requester: *689 + repository: *668 + requester: *692 sender: *19 required: - action @@ -120028,11 +120712,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 + enterprise: *665 installation: *22 - organization: *664 - repositories: *690 - repository: *665 + organization: *667 + repositories: *693 + repository: *668 requester: nullable: true sender: *19 @@ -120108,11 +120792,11 @@ x-webhooks: type: string enum: - new_permissions_accepted - enterprise: *662 + enterprise: *665 installation: *22 - organization: *664 - repositories: *690 - repository: *665 + organization: *667 + repositories: *693 + repository: *668 requester: nullable: true sender: *19 @@ -120188,10 +120872,10 @@ x-webhooks: type: string enum: - added - enterprise: *662 + enterprise: *665 installation: *22 - organization: *664 - repositories_added: &691 + organization: *667 + repositories_added: &694 description: An array of repository objects, which were added to the installation. type: array @@ -120237,15 +120921,15 @@ x-webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *665 - repository_selection: &692 + repository: *668 + repository_selection: &695 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *689 + requester: *692 sender: *19 required: - action @@ -120324,10 +121008,10 @@ x-webhooks: type: string enum: - removed - enterprise: *662 + enterprise: *665 installation: *22 - organization: *664 - repositories_added: *691 + organization: *667 + repositories_added: *694 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -120354,9 +121038,9 @@ x-webhooks: - name - full_name - private - repository: *665 - repository_selection: *692 - requester: *689 + repository: *668 + repository_selection: *695 + requester: *692 sender: *19 required: - action @@ -120435,11 +121119,11 @@ x-webhooks: type: string enum: - suspend - enterprise: *662 + enterprise: *665 installation: *22 - organization: *664 - repositories: *690 - repository: *665 + organization: *667 + repositories: *693 + repository: *668 requester: nullable: true sender: *19 @@ -120618,10 +121302,10 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 target_type: type: string @@ -120700,11 +121384,11 @@ x-webhooks: type: string enum: - unsuspend - enterprise: *662 + enterprise: *665 installation: *22 - organization: *664 - repositories: *690 - repository: *665 + organization: *667 + repositories: *693 + repository: *668 requester: nullable: true sender: *19 @@ -120828,8 +121512,8 @@ x-webhooks: first class actors within GitHub. type: object nullable: true - properties: *89 - required: *90 + properties: *92 + required: *93 reactions: title: Reactions type: object @@ -120956,8 +121640,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -122098,8 +122782,8 @@ x-webhooks: - state - locked - assignee - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -122179,7 +122863,7 @@ x-webhooks: type: string enum: - deleted - comment: &693 + comment: &696 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -122344,8 +123028,8 @@ x-webhooks: - performed_via_github_app - body - reactions - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -123484,8 +124168,8 @@ x-webhooks: - state - locked - assignee - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -123565,7 +124249,7 @@ x-webhooks: type: string enum: - edited - changes: &721 + changes: &724 description: The changes to the comment. type: object properties: @@ -123577,9 +124261,9 @@ x-webhooks: type: string required: - from - comment: *693 - enterprise: *662 - installation: *663 + comment: *696 + enterprise: *665 + installation: *666 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -124719,8 +125403,8 @@ x-webhooks: - state - locked - assignee - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -124802,10 +125486,10 @@ x-webhooks: type: string enum: - assigned - assignee: *689 - enterprise: *662 - installation: *663 - issue: &696 + assignee: *692 + enterprise: *665 + installation: *666 + issue: &699 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -125709,8 +126393,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -125790,8 +126474,8 @@ x-webhooks: type: string enum: - closed - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -126835,8 +127519,8 @@ x-webhooks: required: - state - closed_at - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -126915,8 +127599,8 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -127813,8 +128497,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -127893,8 +128577,8 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -128794,7 +129478,7 @@ x-webhooks: format: uri user_view_type: type: string - milestone: &694 + milestone: &697 title: Milestone description: A collection of related issues and pull requests. type: object @@ -128932,8 +129616,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -129032,8 +129716,8 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -129937,9 +130621,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *688 - organization: *664 - repository: *665 + label: *691 + organization: *667 + repository: *668 sender: *19 required: - action @@ -130019,8 +130703,8 @@ x-webhooks: type: string enum: - labeled - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -130923,9 +131607,9 @@ x-webhooks: - active_lock_reason - body - reactions - label: *688 - organization: *664 - repository: *665 + label: *691 + organization: *667 + repository: *668 sender: *19 required: - action @@ -131005,8 +131689,8 @@ x-webhooks: type: string enum: - locked - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -131910,8 +132594,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -131990,8 +132674,8 @@ x-webhooks: type: string enum: - milestoned - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -132889,9 +133573,9 @@ x-webhooks: format: uri user_view_type: type: string - milestone: *694 - organization: *664 - repository: *665 + milestone: *697 + organization: *667 + repository: *668 sender: *19 required: - action @@ -134338,8 +135022,8 @@ x-webhooks: required: - old_issue - old_repository - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -135242,8 +135926,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -135323,9 +136007,9 @@ x-webhooks: type: string enum: - pinned - enterprise: *662 - installation: *663 - issue: &695 + enterprise: *665 + installation: *666 + issue: &698 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -136222,8 +136906,8 @@ x-webhooks: - active_lock_reason - body - reactions - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -136302,8 +136986,8 @@ x-webhooks: type: string enum: - reopened - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -137206,8 +137890,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -138655,11 +139339,11 @@ x-webhooks: required: - new_issue - new_repository - enterprise: *662 - installation: *663 - issue: *695 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + issue: *698 + organization: *667 + repository: *668 sender: *19 required: - action @@ -138740,7 +139424,7 @@ x-webhooks: type: string enum: - unassigned - assignee: &724 + assignee: &727 title: User type: object nullable: true @@ -138810,11 +139494,11 @@ x-webhooks: required: - login - id - enterprise: *662 - installation: *663 - issue: *696 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + issue: *699 + organization: *667 + repository: *668 sender: *19 required: - action @@ -138893,12 +139577,12 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *662 - installation: *663 - issue: *696 - label: *688 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + issue: *699 + label: *691 + organization: *667 + repository: *668 sender: *19 required: - action @@ -138978,8 +139662,8 @@ x-webhooks: type: string enum: - unlocked - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -139881,8 +140565,8 @@ x-webhooks: format: uri user_view_type: type: string - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -139962,11 +140646,11 @@ x-webhooks: type: string enum: - unpinned - enterprise: *662 - installation: *663 - issue: *695 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + issue: *698 + organization: *667 + repository: *668 sender: *19 required: - action @@ -140045,11 +140729,11 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - label: *688 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + label: *691 + organization: *667 + repository: *668 sender: *19 required: - action @@ -140127,11 +140811,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - label: *688 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + label: *691 + organization: *667 + repository: *668 sender: *19 required: - action @@ -140241,11 +140925,11 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 - label: *688 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + label: *691 + organization: *667 + repository: *668 sender: *19 required: - action @@ -140327,9 +141011,9 @@ x-webhooks: - cancelled effective_date: type: string - enterprise: *662 - installation: *663 - marketplace_purchase: &697 + enterprise: *665 + installation: *666 + marketplace_purchase: &700 title: Marketplace Purchase type: object required: @@ -140412,8 +141096,8 @@ x-webhooks: type: integer unit_count: type: integer - organization: *664 - previous_marketplace_purchase: &698 + organization: *667 + previous_marketplace_purchase: &701 title: Marketplace Purchase type: object properties: @@ -140493,7 +141177,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *665 + repository: *668 sender: *19 required: - action @@ -140573,10 +141257,10 @@ x-webhooks: - changed effective_date: type: string - enterprise: *662 - installation: *663 - marketplace_purchase: *697 - organization: *664 + enterprise: *665 + installation: *666 + marketplace_purchase: *700 + organization: *667 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -140659,7 +141343,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *665 + repository: *668 sender: *19 required: - action @@ -140741,10 +141425,10 @@ x-webhooks: - pending_change effective_date: type: string - enterprise: *662 - installation: *663 - marketplace_purchase: *697 - organization: *664 + enterprise: *665 + installation: *666 + marketplace_purchase: *700 + organization: *667 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -140826,7 +141510,7 @@ x-webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *665 + repository: *668 sender: *19 required: - action @@ -140907,8 +141591,8 @@ x-webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 marketplace_purchase: title: Marketplace Purchase type: object @@ -140990,9 +141674,9 @@ x-webhooks: type: integer unit_count: type: integer - organization: *664 - previous_marketplace_purchase: *698 - repository: *665 + organization: *667 + previous_marketplace_purchase: *701 + repository: *668 sender: *19 required: - action @@ -141072,12 +141756,12 @@ x-webhooks: - purchased effective_date: type: string - enterprise: *662 - installation: *663 - marketplace_purchase: *697 - organization: *664 - previous_marketplace_purchase: *698 - repository: *665 + enterprise: *665 + installation: *666 + marketplace_purchase: *700 + organization: *667 + previous_marketplace_purchase: *701 + repository: *668 sender: *19 required: - action @@ -141179,11 +141863,11 @@ x-webhooks: type: string required: - to - enterprise: *662 - installation: *663 - member: *689 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + member: *692 + organization: *667 + repository: *668 sender: *19 required: - action @@ -141283,11 +141967,11 @@ x-webhooks: to: type: string nullable: true - enterprise: *662 - installation: *663 - member: *689 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + member: *692 + organization: *667 + repository: *668 sender: *19 required: - action @@ -141366,11 +142050,11 @@ x-webhooks: type: string enum: - removed - enterprise: *662 - installation: *663 - member: *689 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + member: *692 + organization: *667 + repository: *668 sender: *19 required: - action @@ -141448,11 +142132,11 @@ x-webhooks: type: string enum: - added - enterprise: *662 - installation: *663 - member: *689 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + member: *692 + organization: *667 + repository: *668 scope: description: The scope of the membership. Currently, can only be `team`. @@ -141528,7 +142212,7 @@ x-webhooks: required: - login - id - team: &699 + team: &702 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -141718,11 +142402,11 @@ x-webhooks: type: string enum: - removed - enterprise: *662 - installation: *663 - member: *689 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + member: *692 + organization: *667 + repository: *668 scope: description: The scope of the membership. Currently, can only be `team`. @@ -141799,7 +142483,7 @@ x-webhooks: required: - login - id - team: *699 + team: *702 required: - action - scope @@ -141881,8 +142565,8 @@ x-webhooks: type: string enum: - checks_requested - installation: *663 - merge_group: &701 + installation: *666 + merge_group: &704 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -141901,15 +142585,15 @@ x-webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *700 + head_commit: *703 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -141995,10 +142679,10 @@ x-webhooks: - merged - invalidated - dequeued - installation: *663 - merge_group: *701 - organization: *664 - repository: *665 + installation: *666 + merge_group: *704 + organization: *667 + repository: *668 sender: *19 required: - action @@ -142071,7 +142755,7 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 + enterprise: *665 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -142179,16 +142863,16 @@ x-webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *663 - organization: *664 + installation: *666 + organization: *667 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *702 - required: *703 + properties: *705 + required: *706 nullable: true sender: *19 required: @@ -142269,11 +142953,11 @@ x-webhooks: type: string enum: - closed - enterprise: *662 - installation: *663 - milestone: *694 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + milestone: *697 + organization: *667 + repository: *668 sender: *19 required: - action @@ -142352,9 +143036,9 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - milestone: &704 + enterprise: *665 + installation: *666 + milestone: &707 title: Milestone description: A collection of related issues and pull requests. type: object @@ -142491,8 +143175,8 @@ x-webhooks: - updated_at - due_on - closed_at - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -142571,11 +143255,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - milestone: *694 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + milestone: *697 + organization: *667 + repository: *668 sender: *19 required: - action @@ -142685,11 +143369,11 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 - milestone: *694 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + milestone: *697 + organization: *667 + repository: *668 sender: *19 required: - action @@ -142769,11 +143453,11 @@ x-webhooks: type: string enum: - opened - enterprise: *662 - installation: *663 - milestone: *704 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + milestone: *707 + organization: *667 + repository: *668 sender: *19 required: - action @@ -142852,11 +143536,11 @@ x-webhooks: type: string enum: - blocked - blocked_user: *689 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + blocked_user: *692 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -142935,11 +143619,11 @@ x-webhooks: type: string enum: - unblocked - blocked_user: *689 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + blocked_user: *692 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -143018,9 +143702,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - membership: &705 + enterprise: *665 + installation: *666 + membership: &708 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -143112,8 +143796,8 @@ x-webhooks: - role - organization_url - user - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 required: - action @@ -143191,11 +143875,11 @@ x-webhooks: type: string enum: - member_added - enterprise: *662 - installation: *663 - membership: *705 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + membership: *708 + organization: *667 + repository: *668 sender: *19 required: - action @@ -143274,8 +143958,8 @@ x-webhooks: type: string enum: - member_invited - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -143391,10 +144075,10 @@ x-webhooks: - inviter - team_count - invitation_teams_url - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 - user: *689 + user: *692 required: - action - invitation @@ -143472,11 +144156,11 @@ x-webhooks: type: string enum: - member_removed - enterprise: *662 - installation: *663 - membership: *705 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + membership: *708 + organization: *667 + repository: *668 sender: *19 required: - action @@ -143563,11 +144247,11 @@ x-webhooks: properties: from: type: string - enterprise: *662 - installation: *663 - membership: *705 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + membership: *708 + organization: *667 + repository: *668 sender: *19 required: - action @@ -143643,9 +144327,9 @@ x-webhooks: type: string enum: - published - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 package: description: Information about the package. type: object @@ -144144,7 +144828,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: &706 + items: &709 title: Ruby Gems metadata type: object properties: @@ -144239,7 +144923,7 @@ x-webhooks: - owner - package_version - registry - repository: *665 + repository: *668 sender: *19 required: - action @@ -144315,9 +144999,9 @@ x-webhooks: type: string enum: - updated - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 package: description: Information about the package. type: object @@ -144670,7 +145354,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *706 + items: *709 source_url: type: string format: uri @@ -144740,7 +145424,7 @@ x-webhooks: - owner - package_version - registry - repository: *665 + repository: *668 sender: *19 required: - action @@ -144917,12 +145601,12 @@ x-webhooks: - duration - created_at - updated_at - enterprise: *662 + enterprise: *665 id: type: integer - installation: *663 - organization: *664 - repository: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - id @@ -145002,7 +145686,7 @@ x-webhooks: type: string enum: - approved - personal_access_token_request: &707 + personal_access_token_request: &710 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -145136,10 +145820,10 @@ x-webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *662 - organization: *664 + enterprise: *665 + organization: *667 sender: *19 - installation: *663 + installation: *666 required: - action - personal_access_token_request @@ -145218,11 +145902,11 @@ x-webhooks: type: string enum: - cancelled - personal_access_token_request: *707 - enterprise: *662 - organization: *664 + personal_access_token_request: *710 + enterprise: *665 + organization: *667 sender: *19 - installation: *663 + installation: *666 required: - action - personal_access_token_request @@ -145300,11 +145984,11 @@ x-webhooks: type: string enum: - created - personal_access_token_request: *707 - enterprise: *662 - organization: *664 + personal_access_token_request: *710 + enterprise: *665 + organization: *667 sender: *19 - installation: *663 + installation: *666 required: - action - personal_access_token_request @@ -145381,11 +146065,11 @@ x-webhooks: type: string enum: - denied - personal_access_token_request: *707 - organization: *664 - enterprise: *662 + personal_access_token_request: *710 + organization: *667 + enterprise: *665 sender: *19 - installation: *663 + installation: *666 required: - action - personal_access_token_request @@ -145489,7 +146173,7 @@ x-webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *708 + last_response: *711 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -145521,8 +146205,8 @@ x-webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 zen: description: Random string of GitHub zen. @@ -145767,10 +146451,10 @@ x-webhooks: - from required: - note - enterprise: *662 - installation: *663 - organization: *664 - project_card: &709 + enterprise: *665 + installation: *666 + organization: *667 + project_card: &712 title: Project Card type: object properties: @@ -145889,7 +146573,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *665 + repository: *668 sender: *19 required: - action @@ -145970,11 +146654,11 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - project_card: *709 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + project_card: *712 + repository: *668 sender: *19 required: - action @@ -146054,9 +146738,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 project_card: title: Project Card type: object @@ -146184,8 +146868,8 @@ x-webhooks: The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *702 - required: *703 + properties: *705 + required: *706 nullable: true sender: *19 required: @@ -146279,11 +146963,11 @@ x-webhooks: - from required: - note - enterprise: *662 - installation: *663 - organization: *664 - project_card: *709 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + project_card: *712 + repository: *668 sender: *19 required: - action @@ -146377,9 +147061,9 @@ x-webhooks: - from required: - column_id - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 project_card: allOf: - title: Project Card @@ -146569,7 +147253,7 @@ x-webhooks: type: string required: - after_id - repository: *665 + repository: *668 sender: *19 required: - action @@ -146649,10 +147333,10 @@ x-webhooks: type: string enum: - closed - enterprise: *662 - installation: *663 - organization: *664 - project: &711 + enterprise: *665 + installation: *666 + organization: *667 + project: &714 title: Project type: object properties: @@ -146776,7 +147460,7 @@ x-webhooks: - creator - created_at - updated_at - repository: *665 + repository: *668 sender: *19 required: - action @@ -146856,10 +147540,10 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - project_column: &710 + enterprise: *665 + installation: *666 + organization: *667 + project_column: &713 title: Project Column type: object properties: @@ -146898,7 +147582,7 @@ x-webhooks: - name - created_at - updated_at - repository: *665 + repository: *668 sender: *19 required: - action @@ -146977,18 +147661,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 - project_column: *710 + enterprise: *665 + installation: *666 + organization: *667 + project_column: *713 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *702 - required: *703 + properties: *705 + required: *706 nullable: true sender: *19 required: @@ -147078,11 +147762,11 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 - organization: *664 - project_column: *710 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + project_column: *713 + repository: *668 sender: *19 required: - action @@ -147162,11 +147846,11 @@ x-webhooks: type: string enum: - moved - enterprise: *662 - installation: *663 - organization: *664 - project_column: *710 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + project_column: *713 + repository: *668 sender: *19 required: - action @@ -147246,11 +147930,11 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - project: *711 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + project: *714 + repository: *668 sender: *19 required: - action @@ -147330,18 +148014,18 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 - project: *711 + enterprise: *665 + installation: *666 + organization: *667 + project: *714 repository: title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. type: object - properties: *702 - required: *703 + properties: *705 + required: *706 nullable: true sender: *19 required: @@ -147443,11 +148127,11 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 - organization: *664 - project: *711 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + project: *714 + repository: *668 sender: *19 required: - action @@ -147526,11 +148210,11 @@ x-webhooks: type: string enum: - reopened - enterprise: *662 - installation: *663 - organization: *664 - project: *711 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + project: *714 + repository: *668 sender: *19 required: - action @@ -147611,9 +148295,9 @@ x-webhooks: type: string enum: - closed - installation: *663 - organization: *664 - projects_v2: &712 + installation: *666 + organization: *667 + projects_v2: &715 title: Projects v2 Project description: A projects v2 project type: object @@ -147756,9 +148440,9 @@ x-webhooks: type: string enum: - created - installation: *663 - organization: *664 - projects_v2: *712 + installation: *666 + organization: *667 + projects_v2: *715 sender: *19 required: - action @@ -147839,9 +148523,9 @@ x-webhooks: type: string enum: - deleted - installation: *663 - organization: *664 - projects_v2: *712 + installation: *666 + organization: *667 + projects_v2: *715 sender: *19 required: - action @@ -147958,9 +148642,9 @@ x-webhooks: type: string to: type: string - installation: *663 - organization: *664 - projects_v2: *712 + installation: *666 + organization: *667 + projects_v2: *715 sender: *19 required: - action @@ -148043,7 +148727,7 @@ x-webhooks: type: string enum: - archived - changes: &716 + changes: &719 type: object properties: archived_at: @@ -148057,9 +148741,9 @@ x-webhooks: type: string nullable: true format: date-time - installation: *663 - organization: *664 - projects_v2_item: &713 + installation: *666 + organization: *667 + projects_v2_item: &716 title: Projects v2 Item description: An item belonging to a project type: object @@ -148193,9 +148877,9 @@ x-webhooks: nullable: true to: type: string - installation: *663 - organization: *664 - projects_v2_item: *713 + installation: *666 + organization: *667 + projects_v2_item: *716 sender: *19 required: - action @@ -148277,9 +148961,9 @@ x-webhooks: type: string enum: - created - installation: *663 - organization: *664 - projects_v2_item: *713 + installation: *666 + organization: *667 + projects_v2_item: *716 sender: *19 required: - action @@ -148360,9 +149044,9 @@ x-webhooks: type: string enum: - deleted - installation: *663 - organization: *664 - projects_v2_item: *713 + installation: *666 + organization: *667 + projects_v2_item: *716 sender: *19 required: - action @@ -148468,7 +149152,7 @@ x-webhooks: oneOf: - type: string - type: integer - - &714 + - &717 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -148486,7 +149170,7 @@ x-webhooks: required: - id - name - - &715 + - &718 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -148509,8 +149193,8 @@ x-webhooks: oneOf: - type: string - type: integer - - *714 - - *715 + - *717 + - *718 required: - field_value - type: object @@ -148526,9 +149210,9 @@ x-webhooks: nullable: true required: - body - installation: *663 - organization: *664 - projects_v2_item: *713 + installation: *666 + organization: *667 + projects_v2_item: *716 sender: *19 required: - action @@ -148623,9 +149307,9 @@ x-webhooks: to: type: string nullable: true - installation: *663 - organization: *664 - projects_v2_item: *713 + installation: *666 + organization: *667 + projects_v2_item: *716 sender: *19 required: - action @@ -148708,10 +149392,10 @@ x-webhooks: type: string enum: - restored - changes: *716 - installation: *663 - organization: *664 - projects_v2_item: *713 + changes: *719 + installation: *666 + organization: *667 + projects_v2_item: *716 sender: *19 required: - action @@ -148793,9 +149477,9 @@ x-webhooks: type: string enum: - reopened - installation: *663 - organization: *664 - projects_v2: *712 + installation: *666 + organization: *667 + projects_v2: *715 sender: *19 required: - action @@ -148876,9 +149560,9 @@ x-webhooks: type: string enum: - created - installation: *663 - organization: *664 - projects_v2_status_update: &717 + installation: *666 + organization: *667 + projects_v2_status_update: &720 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -149005,9 +149689,9 @@ x-webhooks: type: string enum: - deleted - installation: *663 - organization: *664 - projects_v2_status_update: *717 + installation: *666 + organization: *667 + projects_v2_status_update: *720 sender: *19 required: - action @@ -149143,9 +149827,9 @@ x-webhooks: type: string format: date nullable: true - installation: *663 - organization: *664 - projects_v2_status_update: *717 + installation: *666 + organization: *667 + projects_v2_status_update: *720 sender: *19 required: - action @@ -149216,10 +149900,10 @@ x-webhooks: title: public event type: object properties: - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - repository @@ -149296,13 +149980,13 @@ x-webhooks: type: string enum: - assigned - assignee: *689 - enterprise: *662 - installation: *663 - number: &718 + assignee: *692 + enterprise: *665 + installation: *666 + number: &721 description: The pull request number. type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -151585,7 +152269,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -151667,11 +152351,11 @@ x-webhooks: type: string enum: - auto_merge_disabled - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 number: type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -153949,7 +154633,7 @@ x-webhooks: - draft reason: type: string - repository: *665 + repository: *668 sender: *19 required: - action @@ -154031,11 +154715,11 @@ x-webhooks: type: string enum: - auto_merge_enabled - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 number: type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -156313,7 +156997,7 @@ x-webhooks: - draft reason: type: string - repository: *665 + repository: *668 sender: *19 required: - action @@ -156395,13 +157079,13 @@ x-webhooks: type: string enum: - closed - enterprise: *662 - installation: *663 - number: *718 - organization: *664 - pull_request: &719 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 + pull_request: &722 allOf: - - *520 + - *523 - type: object properties: allow_auto_merge: @@ -156463,7 +157147,7 @@ x-webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *665 + repository: *668 sender: *19 required: - action @@ -156544,12 +157228,12 @@ x-webhooks: type: string enum: - converted_to_draft - enterprise: *662 - installation: *663 - number: *718 - organization: *664 - pull_request: *719 - repository: *665 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 + pull_request: *722 + repository: *668 sender: *19 required: - action @@ -156629,11 +157313,11 @@ x-webhooks: type: string enum: - demilestoned - enterprise: *662 - milestone: *502 - number: *718 - organization: *664 - pull_request: &720 + enterprise: *665 + milestone: *505 + number: *721 + organization: *667 + pull_request: &723 title: Pull Request type: object properties: @@ -158896,7 +159580,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -158975,11 +159659,11 @@ x-webhooks: type: string enum: - dequeued - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 number: type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -161261,7 +161945,7 @@ x-webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *665 + repository: *668 sender: *19 required: - action @@ -161385,12 +162069,12 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 - number: *718 - organization: *664 - pull_request: *719 - repository: *665 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 + pull_request: *722 + repository: *668 sender: *19 required: - action @@ -161470,11 +162154,11 @@ x-webhooks: type: string enum: - enqueued - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 number: type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -163741,7 +164425,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -163821,11 +164505,11 @@ x-webhooks: type: string enum: - labeled - enterprise: *662 - installation: *663 - label: *688 - number: *718 - organization: *664 + enterprise: *665 + installation: *666 + label: *691 + number: *721 + organization: *667 pull_request: title: Pull Request type: object @@ -166107,7 +166791,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -166188,10 +166872,10 @@ x-webhooks: type: string enum: - locked - enterprise: *662 - installation: *663 - number: *718 - organization: *664 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 pull_request: title: Pull Request type: object @@ -168471,7 +169155,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -168551,12 +169235,12 @@ x-webhooks: type: string enum: - milestoned - enterprise: *662 - milestone: *502 - number: *718 - organization: *664 - pull_request: *720 - repository: *665 + enterprise: *665 + milestone: *505 + number: *721 + organization: *667 + pull_request: *723 + repository: *668 sender: *19 required: - action @@ -168635,12 +169319,12 @@ x-webhooks: type: string enum: - opened - enterprise: *662 - installation: *663 - number: *718 - organization: *664 - pull_request: *719 - repository: *665 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 + pull_request: *722 + repository: *668 sender: *19 required: - action @@ -168721,12 +169405,12 @@ x-webhooks: type: string enum: - ready_for_review - enterprise: *662 - installation: *663 - number: *718 - organization: *664 - pull_request: *719 - repository: *665 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 + pull_request: *722 + repository: *668 sender: *19 required: - action @@ -168806,12 +169490,12 @@ x-webhooks: type: string enum: - reopened - enterprise: *662 - installation: *663 - number: *718 - organization: *664 - pull_request: *719 - repository: *665 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 + pull_request: *722 + repository: *668 sender: *19 required: - action @@ -169177,9 +169861,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 pull_request: type: object properties: @@ -171349,7 +172033,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *665 + repository: *668 sender: *19 required: - action @@ -171429,7 +172113,7 @@ x-webhooks: type: string enum: - deleted - comment: &722 + comment: &725 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. @@ -171714,9 +172398,9 @@ x-webhooks: - start_side - side - reactions - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 pull_request: type: object properties: @@ -173874,7 +174558,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *665 + repository: *668 sender: *19 required: - action @@ -173954,11 +174638,11 @@ x-webhooks: type: string enum: - edited - changes: *721 - comment: *722 - enterprise: *662 - installation: *663 - organization: *664 + changes: *724 + comment: *725 + enterprise: *665 + installation: *666 + organization: *667 pull_request: type: object properties: @@ -176119,7 +176803,7 @@ x-webhooks: - _links - author_association - active_lock_reason - repository: *665 + repository: *668 sender: *19 required: - action @@ -176200,9 +176884,9 @@ x-webhooks: type: string enum: - dismissed - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 pull_request: title: Simple Pull Request type: object @@ -178375,7 +179059,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *665 + repository: *668 review: description: The review that was affected. type: object @@ -178618,9 +179302,9 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 pull_request: title: Simple Pull Request type: object @@ -180674,8 +181358,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *665 - review: &723 + repository: *668 + review: &726 description: The review that was affected. type: object properties: @@ -180904,12 +181588,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 number: description: The pull request number. type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -183192,7 +183876,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 requested_reviewer: title: User type: object @@ -183276,12 +183960,12 @@ x-webhooks: type: string enum: - review_request_removed - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 number: description: The pull request number. type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -185571,7 +186255,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 requested_team: title: Team description: Groups of organization members that gives permissions @@ -185763,12 +186447,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 number: description: The pull request number. type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -188053,7 +188737,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 requested_reviewer: title: User type: object @@ -188138,12 +188822,12 @@ x-webhooks: type: string enum: - review_requested - enterprise: *662 - installation: *663 + enterprise: *665 + installation: *666 number: description: The pull request number. type: integer - organization: *664 + organization: *667 pull_request: title: Pull Request type: object @@ -190419,7 +191103,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 requested_team: title: Team description: Groups of organization members that gives permissions @@ -190600,9 +191284,9 @@ x-webhooks: type: string enum: - submitted - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 pull_request: title: Simple Pull Request type: object @@ -192777,8 +193461,8 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *665 - review: *723 + repository: *668 + review: *726 sender: *19 required: - action @@ -192858,9 +193542,9 @@ x-webhooks: type: string enum: - resolved - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 pull_request: title: Simple Pull Request type: object @@ -194930,7 +195614,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *665 + repository: *668 sender: *19 thread: type: object @@ -195313,9 +195997,9 @@ x-webhooks: type: string enum: - unresolved - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 pull_request: title: Simple Pull Request type: object @@ -197371,7 +198055,7 @@ x-webhooks: - author_association - auto_merge - active_lock_reason - repository: *665 + repository: *668 sender: *19 thread: type: object @@ -197757,10 +198441,10 @@ x-webhooks: type: string before: type: string - enterprise: *662 - installation: *663 - number: *718 - organization: *664 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 pull_request: title: Pull Request type: object @@ -200031,7 +200715,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -200113,11 +200797,11 @@ x-webhooks: type: string enum: - unassigned - assignee: *724 - enterprise: *662 - installation: *663 - number: *718 - organization: *664 + assignee: *727 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 pull_request: title: Pull Request type: object @@ -202400,7 +203084,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -202479,11 +203163,11 @@ x-webhooks: type: string enum: - unlabeled - enterprise: *662 - installation: *663 - label: *688 - number: *718 - organization: *664 + enterprise: *665 + installation: *666 + label: *691 + number: *721 + organization: *667 pull_request: title: Pull Request type: object @@ -204756,7 +205440,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -204837,10 +205521,10 @@ x-webhooks: type: string enum: - unlocked - enterprise: *662 - installation: *663 - number: *718 - organization: *664 + enterprise: *665 + installation: *666 + number: *721 + organization: *667 pull_request: title: Pull Request type: object @@ -207105,7 +207789,7 @@ x-webhooks: - auto_merge - active_lock_reason - draft - repository: *665 + repository: *668 sender: *19 required: - action @@ -207305,7 +207989,7 @@ x-webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *662 + enterprise: *665 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -207397,8 +208081,8 @@ x-webhooks: - url - author - committer - installation: *663 - organization: *664 + installation: *666 + organization: *667 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -207973,9 +208657,9 @@ x-webhooks: type: string enum: - published - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 registry_package: type: object properties: @@ -208421,7 +209105,7 @@ x-webhooks: type: string rubygems_metadata: type: array - items: *706 + items: *709 summary: type: string tag_name: @@ -208475,7 +209159,7 @@ x-webhooks: - owner - package_version - registry - repository: *665 + repository: *668 sender: *19 required: - action @@ -208553,9 +209237,9 @@ x-webhooks: type: string enum: - updated - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 registry_package: type: object properties: @@ -208863,7 +209547,7 @@ x-webhooks: - published_at rubygems_metadata: type: array - items: *706 + items: *709 summary: type: string tag_name: @@ -208912,7 +209596,7 @@ x-webhooks: - owner - package_version - registry - repository: *665 + repository: *668 sender: *19 required: - action @@ -208989,10 +209673,10 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - release: &725 + enterprise: *665 + installation: *666 + organization: *667 + release: &728 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -209297,7 +209981,7 @@ x-webhooks: - tarball_url - zipball_url - body - repository: *665 + repository: *668 sender: *19 required: - action @@ -209374,11 +210058,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 - release: *725 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + release: *728 + repository: *668 sender: *19 required: - action @@ -209486,11 +210170,11 @@ x-webhooks: type: boolean required: - to - enterprise: *662 - installation: *663 - organization: *664 - release: *725 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + release: *728 + repository: *668 sender: *19 required: - action @@ -209568,9 +210252,9 @@ x-webhooks: type: string enum: - prereleased - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -209879,7 +210563,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *665 + repository: *668 sender: *19 required: - action @@ -209955,10 +210639,10 @@ x-webhooks: type: string enum: - published - enterprise: *662 - installation: *663 - organization: *664 - release: &726 + enterprise: *665 + installation: *666 + organization: *667 + release: &729 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -210264,7 +210948,7 @@ x-webhooks: type: string nullable: true format: uri - repository: *665 + repository: *668 sender: *19 required: - action @@ -210340,11 +211024,11 @@ x-webhooks: type: string enum: - released - enterprise: *662 - installation: *663 - organization: *664 - release: *725 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + release: *728 + repository: *668 sender: *19 required: - action @@ -210420,11 +211104,11 @@ x-webhooks: type: string enum: - unpublished - enterprise: *662 - installation: *663 - organization: *664 - release: *726 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + release: *729 + repository: *668 sender: *19 required: - action @@ -210500,11 +211184,11 @@ x-webhooks: type: string enum: - published - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - repository_advisory: *573 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + repository_advisory: *576 sender: *19 required: - action @@ -210580,11 +211264,11 @@ x-webhooks: type: string enum: - reported - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - repository_advisory: *573 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + repository_advisory: *576 sender: *19 required: - action @@ -210660,10 +211344,10 @@ x-webhooks: type: string enum: - archived - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -210740,10 +211424,10 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -210821,10 +211505,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -210908,10 +211592,10 @@ x-webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -211023,10 +211707,10 @@ x-webhooks: nullable: true items: type: string - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -211098,10 +211782,10 @@ x-webhooks: title: repository_import event type: object properties: - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 status: type: string @@ -211182,10 +211866,10 @@ x-webhooks: type: string enum: - privatized - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -211262,10 +211946,10 @@ x-webhooks: type: string enum: - publicized - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -211359,10 +212043,10 @@ x-webhooks: - name required: - repository - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -211442,11 +212126,11 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - repository_ruleset: *253 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + repository_ruleset: *256 sender: *19 required: - action @@ -211524,11 +212208,11 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - repository_ruleset: *253 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + repository_ruleset: *256 sender: *19 required: - action @@ -211606,11 +212290,11 @@ x-webhooks: type: string enum: - edited - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - repository_ruleset: *253 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + repository_ruleset: *256 changes: type: object properties: @@ -211629,16 +212313,16 @@ x-webhooks: properties: added: type: array - items: *247 + items: *250 deleted: type: array - items: *247 + items: *250 updated: type: array items: type: object properties: - condition: *247 + condition: *250 changes: type: object properties: @@ -211671,16 +212355,16 @@ x-webhooks: properties: added: type: array - items: *252 + items: *255 deleted: type: array - items: *252 + items: *255 updated: type: array items: type: object properties: - rule: *252 + rule: *255 changes: type: object properties: @@ -211914,10 +212598,10 @@ x-webhooks: - from required: - owner - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -211995,10 +212679,10 @@ x-webhooks: type: string enum: - unarchived - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -212076,7 +212760,7 @@ x-webhooks: type: string enum: - create - alert: &727 + alert: &730 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -212197,10 +212881,10 @@ x-webhooks: type: string enum: - open - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -212406,10 +213090,10 @@ x-webhooks: type: string enum: - dismissed - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -212487,11 +213171,11 @@ x-webhooks: type: string enum: - reopen - alert: *727 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + alert: *730 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -212690,10 +213374,10 @@ x-webhooks: enum: - fixed - open - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -212771,7 +213455,7 @@ x-webhooks: type: string enum: - created - alert: &728 + alert: &731 type: object properties: number: *74 @@ -212860,10 +213544,10 @@ x-webhooks: description: Whether the detected secret was found in multiple repositories in the same organization or business. nullable: true - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -212944,11 +213628,11 @@ x-webhooks: type: string enum: - created - alert: *728 - installation: *663 - location: *729 - organization: *664 - repository: *665 + alert: *731 + installation: *666 + location: *732 + organization: *667 + repository: *668 sender: *19 required: - location @@ -213186,11 +213870,11 @@ x-webhooks: type: string enum: - publicly_leaked - alert: *728 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + alert: *731 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -213268,11 +213952,11 @@ x-webhooks: type: string enum: - reopened - alert: *728 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + alert: *731 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -213350,11 +214034,11 @@ x-webhooks: type: string enum: - resolved - alert: *728 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + alert: *731 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -213432,11 +214116,11 @@ x-webhooks: type: string enum: - validated - alert: *728 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + alert: *731 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -213512,11 +214196,11 @@ x-webhooks: type: string enum: - published - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - security_advisory: &730 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + security_advisory: &733 description: The details of the security advisory, including summary, description, and severity. type: object @@ -213699,11 +214383,11 @@ x-webhooks: type: string enum: - updated - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 - security_advisory: *730 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 + security_advisory: *733 sender: *19 required: - action @@ -213776,10 +214460,10 @@ x-webhooks: type: string enum: - withdrawn - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -213963,11 +214647,11 @@ x-webhooks: from: type: object properties: - security_and_analysis: *244 - enterprise: *662 - installation: *663 - organization: *664 - repository: *305 + security_and_analysis: *247 + enterprise: *665 + installation: *666 + organization: *667 + repository: *308 sender: *19 required: - changes @@ -214045,12 +214729,12 @@ x-webhooks: type: string enum: - cancelled - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - sponsorship: &731 + sponsorship: &734 type: object properties: created_at: @@ -214351,12 +215035,12 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - sponsorship: *731 + sponsorship: *734 required: - action - sponsorship @@ -214444,12 +215128,12 @@ x-webhooks: type: string required: - from - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - sponsorship: *731 + sponsorship: *734 required: - action - changes @@ -214526,17 +215210,17 @@ x-webhooks: type: string enum: - pending_cancellation - effective_date: &732 + effective_date: &735 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: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - sponsorship: *731 + sponsorship: *734 required: - action - sponsorship @@ -214610,7 +215294,7 @@ x-webhooks: type: string enum: - pending_tier_change - changes: &733 + changes: &736 type: object properties: tier: @@ -214654,13 +215338,13 @@ x-webhooks: - from required: - tier - effective_date: *732 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + effective_date: *735 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - sponsorship: *731 + sponsorship: *734 required: - action - changes @@ -214737,13 +215421,13 @@ x-webhooks: type: string enum: - tier_changed - changes: *733 - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + changes: *736 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - sponsorship: *731 + sponsorship: *734 required: - action - changes @@ -214817,10 +215501,10 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 starred_at: description: 'The time the star was created. This is a timestamp @@ -214903,10 +215587,10 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 starred_at: description: 'The time the star was created. This is a timestamp @@ -215322,15 +216006,15 @@ x-webhooks: status. type: string nullable: true - enterprise: *662 + enterprise: *665 id: description: The unique identifier of the status. type: integer - installation: *663 + installation: *666 name: type: string - organization: *664 - repository: *665 + organization: *667 + repository: *668 sender: *19 sha: description: The Commit SHA. @@ -215439,15 +216123,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *104 + parent_issue: *107 parent_issue_repo: *57 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *104 - installation: *663 - organization: *664 - repository: *665 + sub_issue: *107 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -215531,15 +216215,15 @@ x-webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *104 + parent_issue: *107 parent_issue_repo: *57 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *104 - installation: *663 - organization: *664 - repository: *665 + sub_issue: *107 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -215623,15 +216307,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *104 + sub_issue: *107 sub_issue_repo: *57 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *104 - installation: *663 - organization: *664 - repository: *665 + parent_issue: *107 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -215715,15 +216399,15 @@ x-webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *104 + sub_issue: *107 sub_issue_repo: *57 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *104 - installation: *663 - organization: *664 - repository: *665 + parent_issue: *107 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -215800,12 +216484,12 @@ x-webhooks: title: team_add event type: object properties: - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - team: &734 + team: &737 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -215995,9 +216679,9 @@ x-webhooks: type: string enum: - added_to_repository - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 repository: title: Repository description: A git repository @@ -216455,7 +217139,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *734 + team: *737 required: - action - team @@ -216531,9 +217215,9 @@ x-webhooks: type: string enum: - created - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 repository: title: Repository description: A git repository @@ -216991,7 +217675,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *734 + team: *737 required: - action - team @@ -217068,9 +217752,9 @@ x-webhooks: type: string enum: - deleted - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 repository: title: Repository description: A git repository @@ -217528,7 +218212,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *734 + team: *737 required: - action - team @@ -217672,9 +218356,9 @@ x-webhooks: - from required: - permissions - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 repository: title: Repository description: A git repository @@ -218132,7 +218816,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *734 + team: *737 required: - action - changes @@ -218210,9 +218894,9 @@ x-webhooks: type: string enum: - removed_from_repository - enterprise: *662 - installation: *663 - organization: *664 + enterprise: *665 + installation: *666 + organization: *667 repository: title: Repository description: A git repository @@ -218670,7 +219354,7 @@ x-webhooks: - topics - visibility sender: *19 - team: *734 + team: *737 required: - action - team @@ -218746,10 +219430,10 @@ x-webhooks: type: string enum: - started - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 required: - action @@ -218822,16 +219506,16 @@ x-webhooks: title: workflow_dispatch event type: object properties: - enterprise: *662 + enterprise: *665 inputs: type: object nullable: true additionalProperties: true - installation: *663 - organization: *664 + installation: *666 + organization: *667 ref: type: string - repository: *665 + repository: *668 sender: *19 workflow: type: string @@ -218913,10 +219597,10 @@ x-webhooks: type: string enum: - completed - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 workflow_job: allOf: @@ -219153,7 +219837,7 @@ x-webhooks: type: string required: - conclusion - deployment: *435 + deployment: *438 required: - action - repository @@ -219232,10 +219916,10 @@ x-webhooks: type: string enum: - in_progress - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 workflow_job: allOf: @@ -219495,7 +220179,7 @@ x-webhooks: required: - status - steps - deployment: *435 + deployment: *438 required: - action - repository @@ -219574,10 +220258,10 @@ x-webhooks: type: string enum: - queued - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 workflow_job: type: object @@ -219712,7 +220396,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *435 + deployment: *438 required: - action - repository @@ -219791,10 +220475,10 @@ x-webhooks: type: string enum: - waiting - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 workflow_job: type: object @@ -219930,7 +220614,7 @@ x-webhooks: - workflow_name - head_branch - created_at - deployment: *435 + deployment: *438 required: - action - repository @@ -220010,12 +220694,12 @@ x-webhooks: type: string enum: - completed - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - workflow: *684 + workflow: *687 workflow_run: title: Workflow Run type: object @@ -221014,12 +221698,12 @@ x-webhooks: type: string enum: - in_progress - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - workflow: *684 + workflow: *687 workflow_run: title: Workflow Run type: object @@ -222003,12 +222687,12 @@ x-webhooks: type: string enum: - requested - enterprise: *662 - installation: *663 - organization: *664 - repository: *665 + enterprise: *665 + installation: *666 + organization: *667 + repository: *668 sender: *19 - workflow: *684 + workflow: *687 workflow_run: title: Workflow Run type: object diff --git a/descriptions/ghec/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index ea306bbdb2..2d0e9164e9 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -4665,6 +4665,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", @@ -5414,6 +5501,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", @@ -15055,6 +15232,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", @@ -23467,6 +23731,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", @@ -102849,6 +103203,318 @@ ], "additionalProperties": false }, + "copilot-ide-code-completions": { + "type": "object", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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.", @@ -274390,6 +275056,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": [ { @@ -302676,6 +303497,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.", @@ -304165,6 +304995,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/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index de6cd45ed9..a2982ee41a 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -3309,6 +3309,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 @@ -3826,6 +3897,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 @@ -10991,6 +11137,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 @@ -17109,6 +17329,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 @@ -74869,6 +75164,287 @@ components: - assignee - created_at additionalProperties: false + copilot-ide-code-completions: + type: object + description: Usage metrics for Copilot editor code completions in the IDE. + nullable: true + 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 + nullable: true + 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 + description: Usage metrics for Copilot Chat in the IDE. + nullable: true + 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 + nullable: true + 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 + description: Usage metrics for Copilot Chat in github.com + nullable: true + 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 + description: The training date for the custom model (if applicable). + nullable: true + 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 + description: Usage metrics for Copilot for pull requests. + nullable: true + 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 + nullable: true + 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. @@ -205312,6 +205888,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' @@ -229684,6 +230359,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. @@ -230908,6 +231590,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/ghec/ghec.json b/descriptions/ghec/ghec.json index ea306bbdb2..2d0e9164e9 100644 --- a/descriptions/ghec/ghec.json +++ b/descriptions/ghec/ghec.json @@ -4665,6 +4665,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", @@ -5414,6 +5501,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", @@ -15055,6 +15232,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", @@ -23467,6 +23731,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", @@ -102849,6 +103203,318 @@ ], "additionalProperties": false }, + "copilot-ide-code-completions": { + "type": "object", + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in the IDE.", + "nullable": true, + "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", + "nullable": true, + "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", + "description": "Usage metrics for Copilot Chat in github.com", + "nullable": true, + "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", + "description": "The training date for the custom model (if applicable).", + "nullable": true + }, + "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", + "description": "Usage metrics for Copilot for pull requests.", + "nullable": true, + "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", + "nullable": true, + "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.", @@ -274390,6 +275056,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": [ { @@ -302676,6 +303497,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.", @@ -304165,6 +304995,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/ghec/ghec.yaml b/descriptions/ghec/ghec.yaml index de6cd45ed9..a2982ee41a 100644 --- a/descriptions/ghec/ghec.yaml +++ b/descriptions/ghec/ghec.yaml @@ -3309,6 +3309,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 @@ -3826,6 +3897,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 @@ -10991,6 +11137,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 @@ -17109,6 +17329,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 @@ -74869,6 +75164,287 @@ components: - assignee - created_at additionalProperties: false + copilot-ide-code-completions: + type: object + description: Usage metrics for Copilot editor code completions in the IDE. + nullable: true + 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 + nullable: true + 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 + description: Usage metrics for Copilot Chat in the IDE. + nullable: true + 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 + nullable: true + 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 + description: Usage metrics for Copilot Chat in github.com + nullable: true + 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 + description: The training date for the custom model (if applicable). + nullable: true + 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 + description: Usage metrics for Copilot for pull requests. + nullable: true + 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 + nullable: true + 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. @@ -205312,6 +205888,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' @@ -229684,6 +230359,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. @@ -230908,6 +231590,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: