diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index f1cd7c771..e7c7c2b1e 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -2086,263 +2086,6 @@ } } }, - "/enterprises/{enterprise}/copilot/billing/seats": { - "get": { - "summary": "List all Copilot seat assignments for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/list-copilot-seats-for-enterprise", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise" - }, - "parameters": [ - { - "$ref": "#/components/parameters/enterprise" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 50 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "total_seats": { - "type": "integer", - "description": "The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once." - }, - "seats": { - "type": "array", - "items": { - "$ref": "#/components/schemas/copilot-seat-details" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/copilot-seats-list" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "500": { - "$ref": "#/components/responses/internal_error" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "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.\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", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage 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\nThe time zone in the response is in UTC time, that means that the cutoff time for the \"day\" is UTC time.\n\nOnly owners and billing managers can view Copilot usage 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/usage-metrics-for-enterprise", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-enterprise-members" - }, - "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" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/copilot-usage-metrics-enterprise" - } - } - } - } - }, - "500": { - "$ref": "#/components/responses/internal_error" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage" - } - } - }, "/enterprises/{enterprise}/dependabot/alerts": { "get": { "summary": "List Dependabot alerts for an enterprise", @@ -2528,186 +2271,6 @@ } } }, - "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { - "get": { - "summary": "Get Copilot metrics for an enterprise team", - "description": "> [!NOTE]\n> This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nUse 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", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage 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, as evaluated at the end of that day.\n\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage 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/usage-metrics-for-enterprise-team", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team" - }, - "parameters": [ - { - "$ref": "#/components/parameters/enterprise" - }, - { - "$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" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/copilot-usage-metrics-org" - } - } - } - } - }, - "500": { - "$ref": "#/components/responses/internal_error" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage" - } - } - }, "/events": { "get": { "summary": "List public events", @@ -9296,6 +8859,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -18081,67 +17647,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - } - }, - "required": [ - "value_type" - ] + "$ref": "#/components/schemas/custom-property-set-payload" }, "examples": { "default": { @@ -18954,7 +18460,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ], "default": "branch" }, @@ -19283,7 +18790,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "enforcement": { @@ -28903,6 +28411,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -66151,6 +65662,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -95335,885 +94849,6 @@ "name" ] }, - "organization-simple": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "team-simple": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - }, - "team": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/team-simple" - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - }, - "enterprise-team": { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "sync_to_organizations": { - "type": "string", - "examples": [ - "disabled | all" - ] - }, - "group_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "62ab9291-fae2-468e-974b-7e45096d5021" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/dc/teams/justice-league" - ] - }, - "members_url": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "url", - "members_url", - "sync_to_organizations", - "name", - "html_url", - "slug", - "created_at", - "updated_at" - ] - }, - "copilot-seat-details": { - "title": "Copilot Business Seat Detail", - "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", - "type": "object", - "properties": { - "assignee": { - "$ref": "#/components/schemas/simple-user" - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/organization-simple" - } - ] - }, - "assigning_team": { - "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", - "oneOf": [ - { - "$ref": "#/components/schemas/team" - }, - { - "$ref": "#/components/schemas/enterprise-team" - } - ], - "type": [ - "null", - "object" - ] - }, - "pending_cancellation_date": { - "type": [ - "string", - "null" - ], - "format": "date", - "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." - }, - "last_activity_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." - }, - "last_activity_editor": { - "type": [ - "string", - "null" - ], - "description": "Last editor that was used by the user for a GitHub Copilot completion." - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "deprecated": true, - "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." - }, - "plan_type": { - "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise", - "unknown" - ] - } - }, - "required": [ - "assignee", - "created_at" - ], - "additionalProperties": false - }, - "copilot-ide-code-completions": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot-ide-chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot-dotcom-chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in github.com", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." - }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model (if applicable)." - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot-dotcom-pull-requests": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot for pull requests.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." - }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } - } - } - } - } - } - }, - "copilot-usage-metrics-day": { - "title": "Copilot Usage Metrics", - "description": "Copilot usage metrics for a given day.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "total_engaged_users": { - "type": "integer", - "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "copilot_ide_code_completions": { - "$ref": "#/components/schemas/copilot-ide-code-completions" - }, - "copilot_ide_chat": { - "$ref": "#/components/schemas/copilot-ide-chat" - }, - "copilot_dotcom_chat": { - "$ref": "#/components/schemas/copilot-dotcom-chat" - }, - "copilot_dotcom_pull_requests": { - "$ref": "#/components/schemas/copilot-dotcom-pull-requests" - } - }, - "required": [ - "date" - ], - "additionalProperties": true - }, - "copilot-usage-metrics": { - "title": "Copilot Usage Metrics", - "description": "Summary of Copilot usage.", - "type": "object", - "properties": { - "day": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." - }, - "total_suggestions_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions shown to users." - }, - "total_acceptances_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions accepted by users." - }, - "total_lines_suggested": { - "type": "integer", - "description": "The total number of lines of code completions suggested by Copilot." - }, - "total_lines_accepted": { - "type": "integer", - "description": "The total number of lines of code completions accepted by users." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." - }, - "total_chat_acceptances": { - "type": "integer", - "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." - }, - "total_chat_turns": { - "type": "integer", - "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." - }, - "total_active_chat_users": { - "type": "integer", - "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." - }, - "breakdown": { - "type": [ - "array", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "items": { - "type": "object", - "description": "Breakdown of Copilot usage by editor for this language", - "additionalProperties": true, - "properties": { - "language": { - "type": "string", - "description": "The language in which Copilot suggestions were shown to users in the specified editor." - }, - "editor": { - "type": "string", - "description": "The editor in which Copilot suggestions were shown to users for the specified language." - }, - "suggestions_count": { - "type": "integer", - "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." - }, - "acceptances_count": { - "type": "integer", - "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." - }, - "lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." - }, - "lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted by users in the editor specified during the day specified." - }, - "active_users": { - "type": "integer", - "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." - } - } - } - } - }, - "required": [ - "day", - "breakdown" - ], - "additionalProperties": false - }, "alert-number": { "type": "integer", "description": "The security alert number.", @@ -97182,6 +95817,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -100326,6 +98968,105 @@ "subscribed" ] }, + "organization-simple": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, "billing-usage-report": { "type": "object", "properties": { @@ -102654,6 +101395,786 @@ ], "additionalProperties": true }, + "team-simple": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + }, + "team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/team-simple" + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + }, + "enterprise-team": { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "examples": [ + "disabled | all" + ] + }, + "group_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "62ab9291-fae2-468e-974b-7e45096d5021" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/dc/teams/justice-league" + ] + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "sync_to_organizations", + "name", + "html_url", + "slug", + "created_at", + "updated_at" + ] + }, + "copilot-seat-details": { + "title": "Copilot Business Seat Detail", + "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", + "type": "object", + "properties": { + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/organization-simple" + } + ] + }, + "assigning_team": { + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", + "oneOf": [ + { + "$ref": "#/components/schemas/team" + }, + { + "$ref": "#/components/schemas/enterprise-team" + } + ], + "type": [ + "null", + "object" + ] + }, + "pending_cancellation_date": { + "type": [ + "string", + "null" + ], + "format": "date", + "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." + }, + "last_activity_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": [ + "string", + "null" + ], + "description": "Last editor that was used by the user for a GitHub Copilot completion." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise", + "unknown" + ] + } + }, + "required": [ + "assignee", + "created_at" + ], + "additionalProperties": false + }, + "copilot-ide-code-completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot-ide-chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot-dotcom-chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot-dotcom-pull-requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + }, + "copilot-usage-metrics-day": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "$ref": "#/components/schemas/copilot-ide-code-completions" + }, + "copilot_ide_chat": { + "$ref": "#/components/schemas/copilot-ide-chat" + }, + "copilot_dotcom_chat": { + "$ref": "#/components/schemas/copilot-dotcom-chat" + }, + "copilot_dotcom_pull_requests": { + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + } + }, + "required": [ + "date" + ], + "additionalProperties": true + }, + "copilot-usage-metrics": { + "title": "Copilot Usage Metrics", + "description": "Summary of Copilot usage.", + "type": "object", + "properties": { + "day": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." + }, + "total_suggestions_count": { + "type": "integer", + "description": "The total number of Copilot code completion suggestions shown to users." + }, + "total_acceptances_count": { + "type": "integer", + "description": "The total number of Copilot code completion suggestions accepted by users." + }, + "total_lines_suggested": { + "type": "integer", + "description": "The total number of lines of code completions suggested by Copilot." + }, + "total_lines_accepted": { + "type": "integer", + "description": "The total number of lines of code completions accepted by users." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." + }, + "total_chat_acceptances": { + "type": "integer", + "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." + }, + "total_chat_turns": { + "type": "integer", + "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." + }, + "total_active_chat_users": { + "type": "integer", + "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." + }, + "breakdown": { + "type": [ + "array", + "null" + ], + "description": "Breakdown of Copilot code completions usage by language and editor", + "items": { + "type": "object", + "description": "Breakdown of Copilot usage by editor for this language", + "additionalProperties": true, + "properties": { + "language": { + "type": "string", + "description": "The language in which Copilot suggestions were shown to users in the specified editor." + }, + "editor": { + "type": "string", + "description": "The editor in which Copilot suggestions were shown to users for the specified language." + }, + "suggestions_count": { + "type": "integer", + "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." + }, + "acceptances_count": { + "type": "integer", + "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." + }, + "lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." + }, + "lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted by users in the editor specified during the day specified." + }, + "active_users": { + "type": "integer", + "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." + } + } + } + } + }, + "required": [ + "day", + "breakdown" + ], + "additionalProperties": false + }, "organization-dependabot-secret": { "title": "Dependabot Secret for an Organization", "description": "Secrets for GitHub Dependabot for an organization.", @@ -104385,6 +103906,71 @@ "value_type" ] }, + "custom-property-set-payload": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + }, + "required": [ + "value_type" + ] + }, "custom-property-value": { "title": "Custom Property Value", "description": "Custom property name and associated value", @@ -105439,7 +105025,7 @@ "org-ruleset-conditions": { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -105726,6 +105312,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -106421,7 +106014,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -106429,7 +106023,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -109204,6 +108799,9 @@ }, "dependency_snapshots": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -123408,6 +123006,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -140397,6 +140002,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -274438,322 +274050,6 @@ "zzz": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8" } }, - "copilot-seats-list": { - "value": { - "total_seats": 2, - "seats": [ - { - "created_at": "2021-08-03T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": null, - "last_activity_at": "2021-10-14T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "plan_type": "business", - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "assigning_team": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - }, - { - "created_at": "2021-09-23T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": "2021-11-01", - "last_activity_at": "2021-10-13T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "assignee": { - "login": "octokitten", - "id": 1, - "node_id": "MDQ76VNlcjE=", - "avatar_url": "https://github.com/images/error/octokitten_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octokitten", - "html_url": "https://github.com/octokitten", - "followers_url": "https://api.github.com/users/octokitten/followers", - "following_url": "https://api.github.com/users/octokitten/following{/other_user}", - "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", - "organizations_url": "https://api.github.com/users/octokitten/orgs", - "repos_url": "https://api.github.com/users/octokitten/repos", - "events_url": "https://api.github.com/users/octokitten/events{/privacy}", - "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": 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": [ - { - "day": "2023-10-15", - "total_suggestions_count": 5000, - "total_acceptances_count": 3000, - "total_lines_suggested": 7000, - "total_lines_accepted": 3500, - "total_active_users": 15, - "total_chat_acceptances": 45, - "total_chat_turns": 350, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 3000, - "acceptances_count": 2000, - "lines_suggested": 3000, - "lines_accepted": 1500, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 1000, - "acceptances_count": 500, - "lines_suggested": 2000, - "lines_accepted": 1000, - "active_users": 5 - }, - { - "language": "javascript", - "editor": "vscode", - "suggestions_count": 1000, - "acceptances_count": 500, - "lines_suggested": 2000, - "lines_accepted": 1000, - "active_users": 5 - } - ] - }, - { - "day": "2023-10-16", - "total_suggestions_count": 5200, - "total_acceptances_count": 5100, - "total_lines_suggested": 5300, - "total_lines_accepted": 5000, - "total_active_users": 15, - "total_chat_acceptances": 57, - "total_chat_turns": 455, - "total_active_chat_users": 12, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 3100, - "acceptances_count": 3000, - "lines_suggested": 3200, - "lines_accepted": 3100, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 1100, - "acceptances_count": 1000, - "lines_suggested": 1200, - "lines_accepted": 1100, - "active_users": 5 - }, - { - "language": "javascript", - "editor": "vscode", - "suggestions_count": 1000, - "acceptances_count": 900, - "lines_suggested": 1100, - "lines_accepted": 1000, - "active_users": 5 - } - ] - } - ] - }, "dependabot-alerts-for-organization": { "value": [ { @@ -275285,6 +274581,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -275376,6 +274673,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -275385,90 +274683,6 @@ } ] }, - "copilot-usage-metrics-org": { - "value": [ - { - "day": "2023-10-15", - "total_suggestions_count": 1000, - "total_acceptances_count": 800, - "total_lines_suggested": 1800, - "total_lines_accepted": 1200, - "total_active_users": 10, - "total_chat_acceptances": 32, - "total_chat_turns": 200, - "total_active_chat_users": 4, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 250, - "lines_suggested": 900, - "lines_accepted": 700, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 400, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 400, - "acceptances_count": 350, - "lines_suggested": 500, - "lines_accepted": 200, - "active_users": 3 - } - ] - }, - { - "day": "2023-10-16", - "total_suggestions_count": 800, - "total_acceptances_count": 600, - "total_lines_suggested": 1100, - "total_lines_accepted": 700, - "total_active_users": 12, - "total_chat_acceptances": 57, - "total_chat_turns": 426, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 600, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 150, - "lines_suggested": 300, - "lines_accepted": 250, - "active_users": 6 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 200, - "acceptances_count": 150, - "lines_suggested": 200, - "lines_accepted": 150, - "active_users": 3 - } - ] - } - ] - }, "public-events-items": { "value": [ { @@ -279199,6 +278413,322 @@ "plan_type": "business" } }, + "copilot-seats-list": { + "value": { + "total_seats": 2, + "seats": [ + { + "created_at": "2021-08-03T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": null, + "last_activity_at": "2021-10-14T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "plan_type": "business", + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assigning_team": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + }, + { + "created_at": "2021-09-23T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": "2021-11-01", + "last_activity_at": "2021-10-13T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "assignee": { + "login": "octokitten", + "id": 1, + "node_id": "MDQ76VNlcjE=", + "avatar_url": "https://github.com/images/error/octokitten_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octokitten", + "html_url": "https://github.com/octokitten", + "followers_url": "https://api.github.com/users/octokitten/followers", + "following_url": "https://api.github.com/users/octokitten/following{/other_user}", + "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", + "organizations_url": "https://api.github.com/users/octokitten/orgs", + "repos_url": "https://api.github.com/users/octokitten/repos", + "events_url": "https://api.github.com/users/octokitten/events{/privacy}", + "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": 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-org": { + "value": [ + { + "day": "2023-10-15", + "total_suggestions_count": 1000, + "total_acceptances_count": 800, + "total_lines_suggested": 1800, + "total_lines_accepted": 1200, + "total_active_users": 10, + "total_chat_acceptances": 32, + "total_chat_turns": 200, + "total_active_chat_users": 4, + "breakdown": [ + { + "language": "python", + "editor": "vscode", + "suggestions_count": 300, + "acceptances_count": 250, + "lines_suggested": 900, + "lines_accepted": 700, + "active_users": 5 + }, + { + "language": "python", + "editor": "jetbrains", + "suggestions_count": 300, + "acceptances_count": 200, + "lines_suggested": 400, + "lines_accepted": 300, + "active_users": 2 + }, + { + "language": "ruby", + "editor": "vscode", + "suggestions_count": 400, + "acceptances_count": 350, + "lines_suggested": 500, + "lines_accepted": 200, + "active_users": 3 + } + ] + }, + { + "day": "2023-10-16", + "total_suggestions_count": 800, + "total_acceptances_count": 600, + "total_lines_suggested": 1100, + "total_lines_accepted": 700, + "total_active_users": 12, + "total_chat_acceptances": 57, + "total_chat_turns": 426, + "total_active_chat_users": 8, + "breakdown": [ + { + "language": "python", + "editor": "vscode", + "suggestions_count": 300, + "acceptances_count": 200, + "lines_suggested": 600, + "lines_accepted": 300, + "active_users": 2 + }, + { + "language": "python", + "editor": "jetbrains", + "suggestions_count": 300, + "acceptances_count": 150, + "lines_suggested": 300, + "lines_accepted": 250, + "active_users": 6 + }, + { + "language": "ruby", + "editor": "vscode", + "suggestions_count": 200, + "acceptances_count": 150, + "lines_suggested": 200, + "lines_accepted": 150, + "active_users": 3 + } + ] + } + ] + }, "organization-dependabot-secret-paginated": { "value": { "total_count": 3, @@ -283043,6 +282573,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -295803,6 +295339,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -295827,6 +295364,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -295854,6 +295392,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -295899,6 +295438,7 @@ "push_protection_bypassed_by": null, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": "Example comment", @@ -302868,24 +302408,6 @@ "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.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, "gist-id": { "name": "gist_id", "description": "The unique identifier of the gist.", @@ -303339,6 +302861,15 @@ "type": "string" } }, + "team-slug": { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "role-id": { "name": "role_id", "description": "The unique identifier of the role.", @@ -304346,26 +303877,6 @@ } } }, - "internal_error": { - "description": "Internal Error", - "content": { - "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": { @@ -304447,6 +303958,16 @@ } } }, + "internal_error": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "conflict": { "description": "Conflict", "content": { @@ -304548,6 +304069,16 @@ "no_content": { "description": "A header with no content is returned." }, + "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" + } + } + } + }, "package_es_list_error": { "description": "The value of `per_page` multiplied by `page` cannot be greater than 10000." }, diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index beb1a9836..08bc536b3 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -1433,225 +1433,6 @@ paths: enabledForGitHubApps: true category: emojis subcategory: emojis - "/enterprises/{enterprise}/copilot/billing/seats": - get: - summary: List all Copilot seat assignments for an enterprise - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. - - Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. - - For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. - Each seat object contains information about the assigned user's most recent Copilot activity. Users must have - telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." - - Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. - - Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/list-copilot-seats-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise - parameters: - - "$ref": "#/components/parameters/enterprise" - - "$ref": "#/components/parameters/page" - - name: per_page - description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 50 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - total_seats: - type: integer - description: The total number of Copilot seats the enterprise - is being billed for. Users with access through multiple organizations - or enterprise teams are only counted once. - seats: - type: array - items: - "$ref": "#/components/schemas/copilot-seat-details" - examples: - default: - "$ref": "#/components/examples/copilot-seats-list" - headers: - Link: - "$ref": "#/components/headers/link" - '500': - "$ref": "#/components/responses/internal_error" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - 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 - 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 all users across organizations with access to Copilot within your enterprise, 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. - - The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. - - Only owners and billing managers can view Copilot usage 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/usage-metrics-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-enterprise-members - 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" - examples: - default: - "$ref": "#/components/examples/copilot-usage-metrics-enterprise" - '500': - "$ref": "#/components/responses/internal_error" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise @@ -1763,163 +1544,6 @@ 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: |- - > [!NOTE] - > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." - - 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 - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." - - 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 an enterprise 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 enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. - - Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage 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/usage-metrics-for-enterprise-team - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team - parameters: - - "$ref": "#/components/parameters/enterprise" - - "$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" - examples: - default: - "$ref": "#/components/examples/copilot-usage-metrics-org" - '500': - "$ref": "#/components/responses/internal_error" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage "/events": get: summary: List public events @@ -6762,6 +6386,8 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: default: "$ref": "#/components/examples/list-attestations" @@ -13106,50 +12732,7 @@ paths: content: application/json: schema: - type: object - properties: - value_type: - type: string - enum: - - string - - single_select - - multi_select - - true_false - description: The type of the value for the property - examples: - - single_select - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - description: Default value of the property - type: - - 'null' - - string - - array - description: - type: - - string - - 'null' - description: Short description of the property - allowed_values: - type: - - array - - 'null' - items: - type: string - maxLength: 75 - maxItems: 200 - description: |- - An ordered list of the allowed values of the property. - The property can have up to 200 allowed values. - required: - - value_type + "$ref": "#/components/schemas/custom-property-set-payload" examples: default: value: @@ -13785,6 +13368,7 @@ paths: - branch - tag - push + - repository default: branch enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" @@ -14001,6 +13585,7 @@ paths: - branch - tag - push + - repository enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -20879,6 +20464,8 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: default: "$ref": "#/components/examples/list-attestations" @@ -47940,6 +47527,8 @@ paths: "$ref": "#/components/schemas/sigstore-bundle-0" repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -68925,720 +68514,6 @@ components: - html_url - key - name - organization-simple: - title: Organization Simple - description: A GitHub organization. - type: object - properties: - login: - type: string - examples: - - github - id: - type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github - repos_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/events - hooks_url: - type: string - examples: - - https://api.github.com/orgs/github/hooks - issues_url: - type: string - examples: - - https://api.github.com/orgs/github/issues - members_url: - type: string - examples: - - https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - examples: - - https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - examples: - - https://github.com/images/error/octocat_happy.gif - description: - type: - - string - - 'null' - examples: - - A great organization - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - team-simple: - title: Team Simple - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - id: - description: Unique identifier of the team - type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDQ6VGVhbTE= - url: - description: URL for the team - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/1 - members_url: - type: string - examples: - - https://api.github.com/organizations/1/team/1/members{/member} - name: - description: Name of the team - type: string - examples: - - Justice League - description: - description: Description of the team - type: - - string - - 'null' - examples: - - A great team. - permission: - description: Permission that the team will have for its repositories - type: string - examples: - - admin - privacy: - description: The level of privacy this team should have - type: string - examples: - - closed - notification_setting: - description: The notification setting the team has set - type: string - examples: - - notifications_enabled - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/rails/teams/core - repositories_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/1/repos - slug: - type: string - examples: - - justice-league - ldap_dn: - description: Distinguished Name (DN) that team maps to within LDAP environment - type: string - examples: - - uid=example,ou=users,dc=github,dc=com - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - id: - type: integer - node_id: - type: string - name: - type: string - slug: - type: string - description: - type: - - string - - 'null' - privacy: - type: string - notification_setting: - type: string - permission: - type: string - permissions: - type: object - properties: - pull: - type: boolean - triage: - type: boolean - push: - type: boolean - maintain: - type: boolean - admin: - type: boolean - required: - - pull - - triage - - push - - maintain - - admin - url: - type: string - format: uri - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/rails/teams/core - members_url: - type: string - repositories_url: - type: string - format: uri - parent: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/team-simple" - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - - parent - enterprise-team: - title: Enterprise Team - description: Group of enterprise owners and/or members - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - slug: - type: string - url: - type: string - format: uri - sync_to_organizations: - type: string - examples: - - disabled | all - group_id: - type: - - string - - 'null' - examples: - - 62ab9291-fae2-468e-974b-7e45096d5021 - html_url: - type: string - format: uri - examples: - - https://github.com/enterprises/dc/teams/justice-league - members_url: - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - id - - url - - members_url - - sync_to_organizations - - name - - html_url - - slug - - created_at - - updated_at - copilot-seat-details: - title: Copilot Business Seat Detail - description: Information about a Copilot Business seat assignment for a user, - team, or organization. - type: object - properties: - assignee: - "$ref": "#/components/schemas/simple-user" - organization: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/organization-simple" - assigning_team: - description: The team through which the assignee is granted access to GitHub - Copilot, if applicable. - oneOf: - - "$ref": "#/components/schemas/team" - - "$ref": "#/components/schemas/enterprise-team" - type: - - 'null' - - object - pending_cancellation_date: - type: - - string - - 'null' - format: date - description: The pending cancellation date for the seat, in `YYYY-MM-DD` - format. This will be null unless the assignee's Copilot access has been - canceled during the current billing cycle. If the seat has been cancelled, - this corresponds to the start of the organization's next billing cycle. - last_activity_at: - type: - - string - - 'null' - format: date-time - description: Timestamp of user's last GitHub Copilot activity, in ISO 8601 - format. - last_activity_editor: - type: - - string - - 'null' - description: Last editor that was used by the user for a GitHub Copilot - completion. - created_at: - type: string - format: date-time - description: Timestamp of when the assignee was last granted access to GitHub - Copilot, in ISO 8601 format. - updated_at: - type: string - format: date-time - deprecated: true - description: "**Closing down notice:** This field is no longer relevant - and is closing down. Use the `created_at` field to determine when the - assignee was last granted access to GitHub Copilot. Timestamp of when - the assignee's GitHub Copilot access was last updated, in ISO 8601 format." - plan_type: - type: string - description: The Copilot plan of the organization, or the parent enterprise, - when applicable. - enum: - - business - - enterprise - - unknown - required: - - assignee - - created_at - additionalProperties: false - copilot-ide-code-completions: - type: - - object - - 'null' - description: Usage metrics for Copilot editor code completions in the IDE. - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code suggestion, - across all active editors. Includes both full and partial acceptances. - languages: - type: array - description: Code completion metrics for active languages. - items: - type: object - description: Usage metrics for a given language for the given editor for - Copilot code completions. - properties: - name: - type: string - description: Name of the language used for Copilot code completion - suggestions. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code - completion suggestion for the given language. Includes both full - and partial acceptances. - editors: - type: array - items: - type: object - description: Copilot code completion metrics for active editors. - additionalProperties: true - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code - completion suggestion for the given editor. Includes both full and - partial acceptances. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot code completion - suggestions. If the default model is used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom model. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot - code completion suggestion for the given editor, for the given - language and model. Includes both full and partial acceptances. - languages: - type: array - description: Code completion metrics for active languages, for - the given editor. - items: - type: object - description: Usage metrics for a given language for the given - editor for Copilot code completions. - properties: - name: - type: string - description: Name of the language used for Copilot code - completion suggestions, for the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted at least one - Copilot code completion suggestion for the given editor, - for the given language. Includes both full and partial - acceptances. - total_code_suggestions: - type: integer - description: The number of Copilot code suggestions generated - for the given editor, for the given language. - total_code_acceptances: - type: integer - description: The number of Copilot code suggestions accepted - for the given editor, for the given language. Includes - both full and partial acceptances. - total_code_lines_suggested: - type: integer - description: The number of lines of code suggested by - Copilot code completions for the given editor, for the - given language. - total_code_lines_accepted: - type: integer - description: The number of lines of code accepted from - Copilot code suggestions for the given editor, for the - given language. - copilot-ide-chat: - type: - - object - - 'null' - description: Usage metrics for Copilot Chat in the IDE. - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat in the IDE. - editors: - type: array - items: - type: object - description: Copilot Chat metrics, for active editors. - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: The number of users who prompted Copilot Chat in the - specified editor. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot code completion - suggestions. If the default model is used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom model. - total_engaged_users: - type: integer - description: The number of users who prompted Copilot Chat in - the given editor and model. - total_chats: - type: integer - description: The total number of chats initiated by users in - the given editor and model. - total_chat_insertion_events: - type: integer - description: The number of times users accepted a code suggestion - from Copilot Chat using the 'Insert Code' UI element, for - the given editor. - total_chat_copy_events: - type: integer - description: The number of times users copied a code suggestion - from Copilot Chat using the keyboard, or the 'Copy' UI element, - for the given editor. - copilot-dotcom-chat: - type: - - object - - 'null' - description: Usage metrics for Copilot Chat in github.com - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat on github.com - at least once. - models: - type: array - description: List of model metrics for a custom models and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot code completion suggestions. - If the default model is used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom model (if applicable). - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat on github.com - at least once for each model. - total_chats: - type: integer - description: Total number of chats initiated by users on github.com. - copilot-dotcom-pull-requests: - type: - - object - - 'null' - description: Usage metrics for Copilot for pull requests. - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: The number of users who used Copilot for Pull Requests on github.com - to generate a pull request summary at least once. - repositories: - type: array - description: Repositories in which users used Copilot for Pull Requests - to generate pull request summaries - items: - type: object - properties: - name: - type: string - description: Repository name - total_engaged_users: - type: integer - description: The number of users who generated pull request summaries - using Copilot for Pull Requests in the given repository. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot code completion - suggestions. If the default model is used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom model. - total_pr_summaries_created: - type: integer - description: The number of pull request summaries generated - using Copilot for Pull Requests in the given repository. - total_engaged_users: - type: integer - description: The number of users who generated pull request - summaries using Copilot for Pull Requests in the given repository - and model. - copilot-usage-metrics-day: - title: Copilot Usage Metrics - description: Copilot usage metrics for a given day. - type: object - properties: - date: - type: string - format: date - description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` - format. - total_active_users: - type: integer - description: The total number of Copilot users with activity belonging to - any Copilot feature, globally, for the given day. Includes passive activity - such as receiving a code suggestion, as well as engagement activity such - as accepting a code suggestion or prompting chat. Does not include authentication - events. Is not limited to the individual features detailed on the endpoint. - total_engaged_users: - type: integer - description: The total number of Copilot users who engaged with any Copilot - feature, for the given day. Examples include but are not limited to accepting - a code suggestion, prompting Copilot chat, or triggering a PR Summary. - Does not include authentication events. Is not limited to the individual - features detailed on the endpoint. - copilot_ide_code_completions: - "$ref": "#/components/schemas/copilot-ide-code-completions" - copilot_ide_chat: - "$ref": "#/components/schemas/copilot-ide-chat" - copilot_dotcom_chat: - "$ref": "#/components/schemas/copilot-dotcom-chat" - copilot_dotcom_pull_requests: - "$ref": "#/components/schemas/copilot-dotcom-pull-requests" - required: - - date - additionalProperties: true - copilot-usage-metrics: - title: Copilot Usage Metrics - description: Summary of Copilot usage. - type: object - properties: - day: - type: string - format: date - description: The date for which the usage metrics are reported, in `YYYY-MM-DD` - format. - total_suggestions_count: - type: integer - description: The total number of Copilot code completion suggestions shown - to users. - total_acceptances_count: - type: integer - description: The total number of Copilot code completion suggestions accepted - by users. - total_lines_suggested: - type: integer - description: The total number of lines of code completions suggested by - Copilot. - total_lines_accepted: - type: integer - description: The total number of lines of code completions accepted by users. - total_active_users: - type: integer - description: The total number of users who were shown Copilot code completion - suggestions during the day specified. - total_chat_acceptances: - type: integer - description: The total instances of users who accepted code suggested by - Copilot Chat in the IDE (panel and inline). - total_chat_turns: - type: integer - description: The total number of chat turns (prompt and response pairs) - sent between users and Copilot Chat in the IDE. - total_active_chat_users: - type: integer - description: The total number of users who interacted with Copilot Chat - in the IDE during the day specified. - breakdown: - type: - - array - - 'null' - description: Breakdown of Copilot code completions usage by language and - editor - items: - type: object - description: Breakdown of Copilot usage by editor for this language - additionalProperties: true - properties: - language: - type: string - description: The language in which Copilot suggestions were shown - to users in the specified editor. - editor: - type: string - description: The editor in which Copilot suggestions were shown to - users for the specified language. - suggestions_count: - type: integer - description: The number of Copilot suggestions shown to users in the - editor specified during the day specified. - acceptances_count: - type: integer - description: The number of Copilot suggestions accepted by users in - the editor specified during the day specified. - lines_suggested: - type: integer - description: The number of lines of code suggested by Copilot in the - editor specified during the day specified. - lines_accepted: - type: integer - description: The number of lines of code accepted by users in the - editor specified during the day specified. - active_users: - type: integer - description: The number of users who were shown Copilot completion - suggestions in the editor specified during the day specified. - required: - - day - - breakdown - additionalProperties: false alert-number: type: integer description: The security alert number. @@ -70403,6 +69278,11 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. push_protection_bypass_request_comment: type: - string @@ -72644,6 +71524,77 @@ components: - reason - url - subscribed + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description billing-usage-report: type: object properties: @@ -74456,6 +73407,649 @@ components: - public_code_suggestions - seat_management_setting additionalProperties: true + team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1 + members_url: + type: string + examples: + - https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + examples: + - Justice League + description: + description: Description of the team + type: + - string + - 'null' + examples: + - A great team. + permission: + description: Permission that the team will have for its repositories + type: string + examples: + - admin + privacy: + description: The level of privacy this team should have + type: string + examples: + - closed + notification_setting: + description: The notification setting the team has set + type: string + examples: + - notifications_enabled + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1/repos + slug: + type: string + examples: + - justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + type: string + examples: + - uid=example,ou=users,dc=github,dc=com + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + team: + title: Team + description: Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/team-simple" + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + enterprise-team: + title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + examples: + - disabled | all + group_id: + type: + - string + - 'null' + examples: + - 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: + type: string + format: uri + examples: + - https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - sync_to_organizations + - name + - html_url + - slug + - created_at + - updated_at + copilot-seat-details: + title: Copilot Business Seat Detail + description: Information about a Copilot Business seat assignment for a user, + team, or organization. + type: object + properties: + assignee: + "$ref": "#/components/schemas/simple-user" + organization: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/organization-simple" + assigning_team: + description: The team through which the assignee is granted access to GitHub + Copilot, if applicable. + oneOf: + - "$ref": "#/components/schemas/team" + - "$ref": "#/components/schemas/enterprise-team" + type: + - 'null' + - object + pending_cancellation_date: + type: + - string + - 'null' + format: date + description: The pending cancellation date for the seat, in `YYYY-MM-DD` + format. This will be null unless the assignee's Copilot access has been + canceled during the current billing cycle. If the seat has been cancelled, + this corresponds to the start of the organization's next billing cycle. + last_activity_at: + type: + - string + - 'null' + format: date-time + description: Timestamp of user's last GitHub Copilot activity, in ISO 8601 + format. + last_activity_editor: + type: + - string + - 'null' + description: Last editor that was used by the user for a GitHub Copilot + completion. + created_at: + type: string + format: date-time + description: Timestamp of when the assignee was last granted access to GitHub + Copilot, in ISO 8601 format. + updated_at: + type: string + format: date-time + deprecated: true + description: "**Closing down notice:** This field is no longer relevant + and is closing down. Use the `created_at` field to determine when the + assignee was last granted access to GitHub Copilot. Timestamp of when + the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + plan_type: + type: string + description: The Copilot plan of the organization, or the parent enterprise, + when applicable. + enum: + - business + - enterprise + - unknown + required: + - assignee + - created_at + additionalProperties: false + copilot-ide-code-completions: + type: + - object + - 'null' + description: Usage metrics for Copilot editor code completions in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code suggestion, + across all active editors. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the given editor for + Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given language. Includes both full + and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given editor. Includes both full and + partial acceptances. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code completion + suggestions. If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code completion suggestion for the given editor, for the given + language and model. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages, for + the given editor. + items: + type: object + description: Usage metrics for a given language for the given + editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code + completion suggestions, for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one + Copilot code completion suggestion for the given editor, + for the given language. Includes both full and partial + acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code suggestions generated + for the given editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code suggestions accepted + for the given editor, for the given language. Includes + both full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code suggested by + Copilot code completions for the given editor, for the + given language. + total_code_lines_accepted: + type: integer + description: The number of lines of code accepted from + Copilot code suggestions for the given editor, for the + given language. + copilot-ide-chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in the + specified editor. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code completion + suggestions. If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in + the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated by users in + the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted a code suggestion + from Copilot Chat using the 'Insert Code' UI element, for + the given editor. + total_chat_copy_events: + type: integer + description: The number of times users copied a code suggestion + from Copilot Chat using the keyboard, or the 'Copy' UI element, + for the given editor. + copilot-dotcom-chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in github.com + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once. + models: + type: array + description: List of model metrics for a custom models and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code completion suggestions. + If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model (if applicable). + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users on github.com. + copilot-dotcom-pull-requests: + type: + - object + - 'null' + description: Usage metrics for Copilot for pull requests. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull Requests on github.com + to generate a pull request summary at least once. + repositories: + type: array + description: Repositories in which users used Copilot for Pull Requests + to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull request summaries + using Copilot for Pull Requests in the given repository. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code completion + suggestions. If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries generated + using Copilot for Pull Requests in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated pull request + summaries using Copilot for Pull Requests in the given repository + and model. + copilot-usage-metrics-day: + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` + format. + total_active_users: + type: integer + description: The total number of Copilot users with activity belonging to + any Copilot feature, globally, for the given day. Includes passive activity + such as receiving a code suggestion, as well as engagement activity such + as accepting a code suggestion or prompting chat. Does not include authentication + events. Is not limited to the individual features detailed on the endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with any Copilot + feature, for the given day. Examples include but are not limited to accepting + a code suggestion, prompting Copilot chat, or triggering a PR Summary. + Does not include authentication events. Is not limited to the individual + features detailed on the endpoint. + copilot_ide_code_completions: + "$ref": "#/components/schemas/copilot-ide-code-completions" + copilot_ide_chat: + "$ref": "#/components/schemas/copilot-ide-chat" + copilot_dotcom_chat: + "$ref": "#/components/schemas/copilot-dotcom-chat" + copilot_dotcom_pull_requests: + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + required: + - date + additionalProperties: true + copilot-usage-metrics: + title: Copilot Usage Metrics + description: Summary of Copilot usage. + type: object + properties: + day: + type: string + format: date + description: The date for which the usage metrics are reported, in `YYYY-MM-DD` + format. + total_suggestions_count: + type: integer + description: The total number of Copilot code completion suggestions shown + to users. + total_acceptances_count: + type: integer + description: The total number of Copilot code completion suggestions accepted + by users. + total_lines_suggested: + type: integer + description: The total number of lines of code completions suggested by + Copilot. + total_lines_accepted: + type: integer + description: The total number of lines of code completions accepted by users. + total_active_users: + type: integer + description: The total number of users who were shown Copilot code completion + suggestions during the day specified. + total_chat_acceptances: + type: integer + description: The total instances of users who accepted code suggested by + Copilot Chat in the IDE (panel and inline). + total_chat_turns: + type: integer + description: The total number of chat turns (prompt and response pairs) + sent between users and Copilot Chat in the IDE. + total_active_chat_users: + type: integer + description: The total number of users who interacted with Copilot Chat + in the IDE during the day specified. + breakdown: + type: + - array + - 'null' + description: Breakdown of Copilot code completions usage by language and + editor + items: + type: object + description: Breakdown of Copilot usage by editor for this language + additionalProperties: true + properties: + language: + type: string + description: The language in which Copilot suggestions were shown + to users in the specified editor. + editor: + type: string + description: The editor in which Copilot suggestions were shown to + users for the specified language. + suggestions_count: + type: integer + description: The number of Copilot suggestions shown to users in the + editor specified during the day specified. + acceptances_count: + type: integer + description: The number of Copilot suggestions accepted by users in + the editor specified during the day specified. + lines_suggested: + type: integer + description: The number of lines of code suggested by Copilot in the + editor specified during the day specified. + lines_accepted: + type: integer + description: The number of lines of code accepted by users in the + editor specified during the day specified. + active_users: + type: integer + description: The number of users who were shown Copilot completion + suggestions in the editor specified during the day specified. + required: + - day + - breakdown + additionalProperties: false organization-dependabot-secret: title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. @@ -75731,6 +75325,53 @@ components: required: - property_name - value_type + custom-property-set-payload: + title: Custom Property Set Payload + description: Custom property set payload + type: object + properties: + value_type: + type: string + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + required: + - value_type custom-property-value: title: Custom Property Value description: Custom property name and associated value @@ -76521,6 +76162,7 @@ components: Conditions for an organization ruleset. The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. The push rulesets conditions object does not require the `ref_name` property. + For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. oneOf: - type: object title: repository_name_and_ref_name @@ -76738,6 +76380,13 @@ components: parameters: type: object properties: + allowed_merge_methods: + type: array + description: When merging pull requests, you can allow any combination + of merge commits, squashing, or rebasing. At least one option must + be enabled. + items: + type: string dismiss_stale_reviews_on_push: type: boolean description: New, reviewable commits pushed will dismiss previous pull @@ -77243,12 +76892,14 @@ components: - branch - tag - push + - repository source_type: type: string description: The type of the source of the ruleset enum: - Repository - Organization + - Enterprise source: type: string description: The name of the source @@ -79267,6 +78918,8 @@ components: "$ref": "#/components/schemas/rate-limit" dependency_snapshots: "$ref": "#/components/schemas/rate-limit" + code_scanning_autofix: + "$ref": "#/components/schemas/rate-limit" required: - core - search @@ -89329,6 +88982,11 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. push_protection_bypass_request_comment: type: - string @@ -101909,6 +101567,11 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. push_protection_bypass_request_comment: type: - string @@ -202202,236 +201865,6 @@ components: zombie_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8 zombie_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8 zzz: https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8 - copilot-seats-list: - value: - total_seats: 2 - seats: - - created_at: '2021-08-03T18:00:00-06:00' - updated_at: '2021-09-23T15:00:00-06:00' - pending_cancellation_date: - last_activity_at: '2021-10-14T00:53:32-06:00' - last_activity_editor: vscode/1.77.3/copilot/1.86.82 - plan_type: business - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assigning_team: - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - - created_at: '2021-09-23T18:00:00-06:00' - updated_at: '2021-09-23T15:00:00-06:00' - pending_cancellation_date: '2021-11-01' - last_activity_at: '2021-10-13T00:53:32-06:00' - last_activity_editor: vscode/1.77.3/copilot/1.86.82 - assignee: - login: octokitten - id: 1 - node_id: MDQ76VNlcjE= - avatar_url: https://github.com/images/error/octokitten_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octokitten - html_url: https://github.com/octokitten - followers_url: https://api.github.com/users/octokitten/followers - following_url: https://api.github.com/users/octokitten/following{/other_user} - gists_url: https://api.github.com/users/octokitten/gists{/gist_id} - starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octokitten/subscriptions - organizations_url: https://api.github.com/users/octokitten/orgs - repos_url: https://api.github.com/users/octokitten/repos - events_url: https://api.github.com/users/octokitten/events{/privacy} - 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' - total_suggestions_count: 5000 - total_acceptances_count: 3000 - total_lines_suggested: 7000 - total_lines_accepted: 3500 - total_active_users: 15 - total_chat_acceptances: 45 - total_chat_turns: 350 - total_active_chat_users: 8 - breakdown: - - language: python - editor: vscode - suggestions_count: 3000 - acceptances_count: 2000 - lines_suggested: 3000 - lines_accepted: 1500 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 1000 - acceptances_count: 500 - lines_suggested: 2000 - lines_accepted: 1000 - active_users: 5 - - language: javascript - editor: vscode - suggestions_count: 1000 - acceptances_count: 500 - lines_suggested: 2000 - lines_accepted: 1000 - active_users: 5 - - day: '2023-10-16' - total_suggestions_count: 5200 - total_acceptances_count: 5100 - total_lines_suggested: 5300 - total_lines_accepted: 5000 - total_active_users: 15 - total_chat_acceptances: 57 - total_chat_turns: 455 - total_active_chat_users: 12 - breakdown: - - language: python - editor: vscode - suggestions_count: 3100 - acceptances_count: 3000 - lines_suggested: 3200 - lines_accepted: 3100 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 1100 - acceptances_count: 1000 - lines_suggested: 1200 - lines_accepted: 1100 - active_users: 5 - - language: javascript - editor: vscode - suggestions_count: 1000 - acceptances_count: 900 - lines_suggested: 1100 - lines_accepted: 1000 - active_users: 5 dependabot-alerts-for-organization: value: - number: 2 @@ -202880,6 +202313,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true + push_protection_bypass_request_reviewer_comment: Example response push_protection_bypass_request_comment: Example comment push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment @@ -202967,76 +202401,13 @@ components: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: validity: unknown publicly_leaked: false multi_repo: false - copilot-usage-metrics-org: - value: - - day: '2023-10-15' - total_suggestions_count: 1000 - total_acceptances_count: 800 - total_lines_suggested: 1800 - total_lines_accepted: 1200 - total_active_users: 10 - total_chat_acceptances: 32 - total_chat_turns: 200 - total_active_chat_users: 4 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 250 - lines_suggested: 900 - lines_accepted: 700 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 400 - lines_accepted: 300 - active_users: 2 - - language: ruby - editor: vscode - suggestions_count: 400 - acceptances_count: 350 - lines_suggested: 500 - lines_accepted: 200 - active_users: 3 - - day: '2023-10-16' - total_suggestions_count: 800 - total_acceptances_count: 600 - total_lines_suggested: 1100 - total_lines_accepted: 700 - total_active_users: 12 - total_chat_acceptances: 57 - total_chat_turns: 426 - total_active_chat_users: 8 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 600 - lines_accepted: 300 - active_users: 2 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 150 - lines_suggested: 300 - lines_accepted: 250 - active_users: 6 - - language: ruby - editor: vscode - suggestions_count: 200 - acceptances_count: 150 - lines_suggested: 200 - lines_accepted: 150 - active_users: 3 public-events-items: value: - id: '22249084947' @@ -206272,6 +205643,236 @@ components: cli: enabled public_code_suggestions: block plan_type: business + copilot-seats-list: + value: + total_seats: 2 + seats: + - created_at: '2021-08-03T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: + last_activity_at: '2021-10-14T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + plan_type: business + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assigning_team: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + - created_at: '2021-09-23T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: '2021-11-01' + last_activity_at: '2021-10-13T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + assignee: + login: octokitten + id: 1 + node_id: MDQ76VNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + 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-org: + value: + - day: '2023-10-15' + total_suggestions_count: 1000 + total_acceptances_count: 800 + total_lines_suggested: 1800 + total_lines_accepted: 1200 + total_active_users: 10 + total_chat_acceptances: 32 + total_chat_turns: 200 + total_active_chat_users: 4 + breakdown: + - language: python + editor: vscode + suggestions_count: 300 + acceptances_count: 250 + lines_suggested: 900 + lines_accepted: 700 + active_users: 5 + - language: python + editor: jetbrains + suggestions_count: 300 + acceptances_count: 200 + lines_suggested: 400 + lines_accepted: 300 + active_users: 2 + - language: ruby + editor: vscode + suggestions_count: 400 + acceptances_count: 350 + lines_suggested: 500 + lines_accepted: 200 + active_users: 3 + - day: '2023-10-16' + total_suggestions_count: 800 + total_acceptances_count: 600 + total_lines_suggested: 1100 + total_lines_accepted: 700 + total_active_users: 12 + total_chat_acceptances: 57 + total_chat_turns: 426 + total_active_chat_users: 8 + breakdown: + - language: python + editor: vscode + suggestions_count: 300 + acceptances_count: 200 + lines_suggested: 600 + lines_accepted: 300 + active_users: 2 + - language: python + editor: jetbrains + suggestions_count: 300 + acceptances_count: 150 + lines_suggested: 300 + lines_accepted: 250 + active_users: 6 + - language: ruby + editor: vscode + suggestions_count: 200 + acceptances_count: 150 + lines_suggested: 200 + lines_accepted: 150 + active_users: 3 organization-dependabot-secret-paginated: value: total_count: 3 @@ -209604,6 +209205,11 @@ components: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -220550,6 +220156,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true + push_protection_bypass_request_reviewer_comment: Example response push_protection_bypass_request_comment: Example comment push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment @@ -220572,6 +220179,7 @@ components: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -220596,6 +220204,7 @@ components: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -220638,6 +220247,7 @@ components: push_protection_bypassed_by: push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: Example comment @@ -226703,20 +226313,6 @@ 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. - in: path - required: true - schema: - type: string gist-id: name: gist_id description: The unique identifier of the gist. @@ -227098,6 +226694,13 @@ components: required: true schema: type: string + team-slug: + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string role-id: name: role_id description: The unique identifier of the role. @@ -227940,19 +227543,6 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" - internal_error: - description: Internal Error - content: - 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: @@ -228003,6 +227593,12 @@ components: examples: default: "$ref": "#/components/examples/billing-usage-report" + internal_error: + description: Internal Error + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" conflict: description: Conflict content: @@ -228067,6 +227663,13 @@ components: "$ref": "#/components/examples/runner-labels-readonly" no_content: description: A header with no content is returned. + 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" package_es_list_error: description: The value of `per_page` multiplied by `page` cannot be greater than 10000. diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index f1cd7c771..e7c7c2b1e 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -2086,263 +2086,6 @@ } } }, - "/enterprises/{enterprise}/copilot/billing/seats": { - "get": { - "summary": "List all Copilot seat assignments for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/list-copilot-seats-for-enterprise", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise" - }, - "parameters": [ - { - "$ref": "#/components/parameters/enterprise" - }, - { - "$ref": "#/components/parameters/page" - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 50 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "total_seats": { - "type": "integer", - "description": "The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once." - }, - "seats": { - "type": "array", - "items": { - "$ref": "#/components/schemas/copilot-seat-details" - } - } - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/copilot-seats-list" - } - } - } - }, - "headers": { - "Link": { - "$ref": "#/components/headers/link" - } - } - }, - "500": { - "$ref": "#/components/responses/internal_error" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "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.\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", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage 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\nThe time zone in the response is in UTC time, that means that the cutoff time for the \"day\" is UTC time.\n\nOnly owners and billing managers can view Copilot usage 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/usage-metrics-for-enterprise", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-enterprise-members" - }, - "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" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/copilot-usage-metrics-enterprise" - } - } - } - } - }, - "500": { - "$ref": "#/components/responses/internal_error" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage" - } - } - }, "/enterprises/{enterprise}/dependabot/alerts": { "get": { "summary": "List Dependabot alerts for an enterprise", @@ -2528,186 +2271,6 @@ } } }, - "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { - "get": { - "summary": "Get Copilot metrics for an enterprise team", - "description": "> [!NOTE]\n> This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nUse 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", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage 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, as evaluated at the end of that day.\n\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage 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/usage-metrics-for-enterprise-team", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team" - }, - "parameters": [ - { - "$ref": "#/components/parameters/enterprise" - }, - { - "$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" - } - }, - "examples": { - "default": { - "$ref": "#/components/examples/copilot-usage-metrics-org" - } - } - } - } - }, - "500": { - "$ref": "#/components/responses/internal_error" - }, - "401": { - "$ref": "#/components/responses/requires_authentication" - }, - "403": { - "$ref": "#/components/responses/forbidden" - }, - "404": { - "$ref": "#/components/responses/not_found" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage" - } - } - }, "/events": { "get": { "summary": "List public events", @@ -9296,6 +8859,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -18081,67 +17647,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - } - }, - "required": [ - "value_type" - ] + "$ref": "#/components/schemas/custom-property-set-payload" }, "examples": { "default": { @@ -18954,7 +18460,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ], "default": "branch" }, @@ -19283,7 +18790,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "enforcement": { @@ -28903,6 +28411,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -66151,6 +65662,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -95335,885 +94849,6 @@ "name" ] }, - "organization-simple": { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "team-simple": { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - }, - "team": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/team-simple" - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - }, - "enterprise-team": { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "sync_to_organizations": { - "type": "string", - "examples": [ - "disabled | all" - ] - }, - "group_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "62ab9291-fae2-468e-974b-7e45096d5021" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/dc/teams/justice-league" - ] - }, - "members_url": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "url", - "members_url", - "sync_to_organizations", - "name", - "html_url", - "slug", - "created_at", - "updated_at" - ] - }, - "copilot-seat-details": { - "title": "Copilot Business Seat Detail", - "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", - "type": "object", - "properties": { - "assignee": { - "$ref": "#/components/schemas/simple-user" - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/organization-simple" - } - ] - }, - "assigning_team": { - "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", - "oneOf": [ - { - "$ref": "#/components/schemas/team" - }, - { - "$ref": "#/components/schemas/enterprise-team" - } - ], - "type": [ - "null", - "object" - ] - }, - "pending_cancellation_date": { - "type": [ - "string", - "null" - ], - "format": "date", - "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." - }, - "last_activity_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." - }, - "last_activity_editor": { - "type": [ - "string", - "null" - ], - "description": "Last editor that was used by the user for a GitHub Copilot completion." - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "deprecated": true, - "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." - }, - "plan_type": { - "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise", - "unknown" - ] - } - }, - "required": [ - "assignee", - "created_at" - ], - "additionalProperties": false - }, - "copilot-ide-code-completions": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot-ide-chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot-dotcom-chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in github.com", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." - }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model (if applicable)." - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot-dotcom-pull-requests": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot for pull requests.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." - }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } - } - } - } - } - } - }, - "copilot-usage-metrics-day": { - "title": "Copilot Usage Metrics", - "description": "Copilot usage metrics for a given day.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "total_engaged_users": { - "type": "integer", - "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "copilot_ide_code_completions": { - "$ref": "#/components/schemas/copilot-ide-code-completions" - }, - "copilot_ide_chat": { - "$ref": "#/components/schemas/copilot-ide-chat" - }, - "copilot_dotcom_chat": { - "$ref": "#/components/schemas/copilot-dotcom-chat" - }, - "copilot_dotcom_pull_requests": { - "$ref": "#/components/schemas/copilot-dotcom-pull-requests" - } - }, - "required": [ - "date" - ], - "additionalProperties": true - }, - "copilot-usage-metrics": { - "title": "Copilot Usage Metrics", - "description": "Summary of Copilot usage.", - "type": "object", - "properties": { - "day": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." - }, - "total_suggestions_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions shown to users." - }, - "total_acceptances_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions accepted by users." - }, - "total_lines_suggested": { - "type": "integer", - "description": "The total number of lines of code completions suggested by Copilot." - }, - "total_lines_accepted": { - "type": "integer", - "description": "The total number of lines of code completions accepted by users." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." - }, - "total_chat_acceptances": { - "type": "integer", - "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." - }, - "total_chat_turns": { - "type": "integer", - "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." - }, - "total_active_chat_users": { - "type": "integer", - "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." - }, - "breakdown": { - "type": [ - "array", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "items": { - "type": "object", - "description": "Breakdown of Copilot usage by editor for this language", - "additionalProperties": true, - "properties": { - "language": { - "type": "string", - "description": "The language in which Copilot suggestions were shown to users in the specified editor." - }, - "editor": { - "type": "string", - "description": "The editor in which Copilot suggestions were shown to users for the specified language." - }, - "suggestions_count": { - "type": "integer", - "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." - }, - "acceptances_count": { - "type": "integer", - "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." - }, - "lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." - }, - "lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted by users in the editor specified during the day specified." - }, - "active_users": { - "type": "integer", - "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." - } - } - } - } - }, - "required": [ - "day", - "breakdown" - ], - "additionalProperties": false - }, "alert-number": { "type": "integer", "description": "The security alert number.", @@ -97182,6 +95817,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -100326,6 +98968,105 @@ "subscribed" ] }, + "organization-simple": { + "title": "Organization Simple", + "description": "A GitHub organization.", + "type": "object", + "properties": { + "login": { + "type": "string", + "examples": [ + "github" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDEyOk9yZ2FuaXphdGlvbjE=" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/repos" + ] + }, + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/orgs/github/events" + ] + }, + "hooks_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/hooks" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/issues" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/members{/member}" + ] + }, + "public_members_url": { + "type": "string", + "examples": [ + "https://api.github.com/orgs/github/public_members{/member}" + ] + }, + "avatar_url": { + "type": "string", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "A great organization" + ] + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, "billing-usage-report": { "type": "object", "properties": { @@ -102654,6 +101395,786 @@ ], "additionalProperties": true }, + "team-simple": { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VGVhbTE=" + ] + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1" + ] + }, + "members_url": { + "type": "string", + "examples": [ + "https://api.github.com/organizations/1/team/1/members{/member}" + ] + }, + "name": { + "description": "Name of the team", + "type": "string", + "examples": [ + "Justice League" + ] + }, + "description": { + "description": "Description of the team", + "type": [ + "string", + "null" + ], + "examples": [ + "A great team." + ] + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "examples": [ + "admin" + ] + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "examples": [ + "closed" + ] + }, + "notification_setting": { + "description": "The notification setting the team has set", + "type": "string", + "examples": [ + "notifications_enabled" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "repositories_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/organizations/1/team/1/repos" + ] + }, + "slug": { + "type": "string", + "examples": [ + "justice-league" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "type": "string", + "examples": [ + "uid=example,ou=users,dc=github,dc=com" + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + }, + "team": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": [ + "string", + "null" + ] + }, + "privacy": { + "type": "string" + }, + "notification_setting": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "pull", + "triage", + "push", + "maintain", + "admin" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/orgs/rails/teams/core" + ] + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/team-simple" + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "parent" + ] + }, + "enterprise-team": { + "title": "Enterprise Team", + "description": "Group of enterprise owners and/or members", + "type": "object", + "properties": { + "id": { + "type": "integer", + "format": "int64" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "sync_to_organizations": { + "type": "string", + "examples": [ + "disabled | all" + ] + }, + "group_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "62ab9291-fae2-468e-974b-7e45096d5021" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/enterprises/dc/teams/justice-league" + ] + }, + "members_url": { + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "id", + "url", + "members_url", + "sync_to_organizations", + "name", + "html_url", + "slug", + "created_at", + "updated_at" + ] + }, + "copilot-seat-details": { + "title": "Copilot Business Seat Detail", + "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", + "type": "object", + "properties": { + "assignee": { + "$ref": "#/components/schemas/simple-user" + }, + "organization": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/organization-simple" + } + ] + }, + "assigning_team": { + "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", + "oneOf": [ + { + "$ref": "#/components/schemas/team" + }, + { + "$ref": "#/components/schemas/enterprise-team" + } + ], + "type": [ + "null", + "object" + ] + }, + "pending_cancellation_date": { + "type": [ + "string", + "null" + ], + "format": "date", + "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." + }, + "last_activity_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." + }, + "last_activity_editor": { + "type": [ + "string", + "null" + ], + "description": "Last editor that was used by the user for a GitHub Copilot completion." + }, + "created_at": { + "type": "string", + "format": "date-time", + "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." + }, + "updated_at": { + "type": "string", + "format": "date-time", + "deprecated": true, + "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + }, + "plan_type": { + "type": "string", + "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", + "enum": [ + "business", + "enterprise", + "unknown" + ] + } + }, + "required": [ + "assignee", + "created_at" + ], + "additionalProperties": false + }, + "copilot-ide-code-completions": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot editor code completions in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." + } + } + } + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot code completion metrics for active editors.", + "additionalProperties": true, + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." + }, + "languages": { + "type": "array", + "description": "Code completion metrics for active languages, for the given editor.", + "items": { + "type": "object", + "description": "Usage metrics for a given language for the given editor for Copilot code completions.", + "properties": { + "name": { + "type": "string", + "description": "Name of the language used for Copilot code completion suggestions, for the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_suggestions": { + "type": "integer", + "description": "The number of Copilot code suggestions generated for the given editor, for the given language." + }, + "total_code_acceptances": { + "type": "integer", + "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." + }, + "total_code_lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." + }, + "total_code_lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." + } + } + } + } + } + } + } + } + } + } + } + }, + "copilot-ide-chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in the IDE.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat in the IDE." + }, + "editors": { + "type": "array", + "items": { + "type": "object", + "description": "Copilot Chat metrics, for active editors.", + "properties": { + "name": { + "type": "string", + "description": "Name of the given editor." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the specified editor." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who prompted Copilot Chat in the given editor and model." + }, + "total_chats": { + "type": "integer", + "description": "The total number of chats initiated by users in the given editor and model." + }, + "total_chat_insertion_events": { + "type": "integer", + "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." + }, + "total_chat_copy_events": { + "type": "integer", + "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." + } + } + } + } + } + } + } + } + }, + "copilot-dotcom-chat": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot Chat in github.com", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once." + }, + "models": { + "type": "array", + "description": "List of model metrics for a custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model (if applicable)." + }, + "total_engaged_users": { + "type": "integer", + "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." + }, + "total_chats": { + "type": "integer", + "description": "Total number of chats initiated by users on github.com." + } + } + } + } + } + }, + "copilot-dotcom-pull-requests": { + "type": [ + "object", + "null" + ], + "description": "Usage metrics for Copilot for pull requests.", + "additionalProperties": true, + "properties": { + "total_engaged_users": { + "type": "integer", + "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." + }, + "repositories": { + "type": "array", + "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Repository name" + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." + }, + "models": { + "type": "array", + "description": "List of model metrics for custom models and the default model.", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." + }, + "is_custom_model": { + "type": "boolean", + "description": "Indicates whether a model is custom or default." + }, + "custom_model_training_date": { + "type": [ + "string", + "null" + ], + "description": "The training date for the custom model." + }, + "total_pr_summaries_created": { + "type": "integer", + "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." + }, + "total_engaged_users": { + "type": "integer", + "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." + } + } + } + } + } + } + } + } + }, + "copilot-usage-metrics-day": { + "title": "Copilot Usage Metrics", + "description": "Copilot usage metrics for a given day.", + "type": "object", + "properties": { + "date": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "total_engaged_users": { + "type": "integer", + "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." + }, + "copilot_ide_code_completions": { + "$ref": "#/components/schemas/copilot-ide-code-completions" + }, + "copilot_ide_chat": { + "$ref": "#/components/schemas/copilot-ide-chat" + }, + "copilot_dotcom_chat": { + "$ref": "#/components/schemas/copilot-dotcom-chat" + }, + "copilot_dotcom_pull_requests": { + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + } + }, + "required": [ + "date" + ], + "additionalProperties": true + }, + "copilot-usage-metrics": { + "title": "Copilot Usage Metrics", + "description": "Summary of Copilot usage.", + "type": "object", + "properties": { + "day": { + "type": "string", + "format": "date", + "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." + }, + "total_suggestions_count": { + "type": "integer", + "description": "The total number of Copilot code completion suggestions shown to users." + }, + "total_acceptances_count": { + "type": "integer", + "description": "The total number of Copilot code completion suggestions accepted by users." + }, + "total_lines_suggested": { + "type": "integer", + "description": "The total number of lines of code completions suggested by Copilot." + }, + "total_lines_accepted": { + "type": "integer", + "description": "The total number of lines of code completions accepted by users." + }, + "total_active_users": { + "type": "integer", + "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." + }, + "total_chat_acceptances": { + "type": "integer", + "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." + }, + "total_chat_turns": { + "type": "integer", + "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." + }, + "total_active_chat_users": { + "type": "integer", + "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." + }, + "breakdown": { + "type": [ + "array", + "null" + ], + "description": "Breakdown of Copilot code completions usage by language and editor", + "items": { + "type": "object", + "description": "Breakdown of Copilot usage by editor for this language", + "additionalProperties": true, + "properties": { + "language": { + "type": "string", + "description": "The language in which Copilot suggestions were shown to users in the specified editor." + }, + "editor": { + "type": "string", + "description": "The editor in which Copilot suggestions were shown to users for the specified language." + }, + "suggestions_count": { + "type": "integer", + "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." + }, + "acceptances_count": { + "type": "integer", + "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." + }, + "lines_suggested": { + "type": "integer", + "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." + }, + "lines_accepted": { + "type": "integer", + "description": "The number of lines of code accepted by users in the editor specified during the day specified." + }, + "active_users": { + "type": "integer", + "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." + } + } + } + } + }, + "required": [ + "day", + "breakdown" + ], + "additionalProperties": false + }, "organization-dependabot-secret": { "title": "Dependabot Secret for an Organization", "description": "Secrets for GitHub Dependabot for an organization.", @@ -104385,6 +103906,71 @@ "value_type" ] }, + "custom-property-set-payload": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + }, + "required": [ + "value_type" + ] + }, "custom-property-value": { "title": "Custom Property Value", "description": "Custom property name and associated value", @@ -105439,7 +105025,7 @@ "org-ruleset-conditions": { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -105726,6 +105312,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -106421,7 +106014,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -106429,7 +106023,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -109204,6 +108799,9 @@ }, "dependency_snapshots": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -123408,6 +123006,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -140397,6 +140002,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -274438,322 +274050,6 @@ "zzz": "https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8" } }, - "copilot-seats-list": { - "value": { - "total_seats": 2, - "seats": [ - { - "created_at": "2021-08-03T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": null, - "last_activity_at": "2021-10-14T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "plan_type": "business", - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "assigning_team": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - }, - { - "created_at": "2021-09-23T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": "2021-11-01", - "last_activity_at": "2021-10-13T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "assignee": { - "login": "octokitten", - "id": 1, - "node_id": "MDQ76VNlcjE=", - "avatar_url": "https://github.com/images/error/octokitten_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octokitten", - "html_url": "https://github.com/octokitten", - "followers_url": "https://api.github.com/users/octokitten/followers", - "following_url": "https://api.github.com/users/octokitten/following{/other_user}", - "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", - "organizations_url": "https://api.github.com/users/octokitten/orgs", - "repos_url": "https://api.github.com/users/octokitten/repos", - "events_url": "https://api.github.com/users/octokitten/events{/privacy}", - "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": 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": [ - { - "day": "2023-10-15", - "total_suggestions_count": 5000, - "total_acceptances_count": 3000, - "total_lines_suggested": 7000, - "total_lines_accepted": 3500, - "total_active_users": 15, - "total_chat_acceptances": 45, - "total_chat_turns": 350, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 3000, - "acceptances_count": 2000, - "lines_suggested": 3000, - "lines_accepted": 1500, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 1000, - "acceptances_count": 500, - "lines_suggested": 2000, - "lines_accepted": 1000, - "active_users": 5 - }, - { - "language": "javascript", - "editor": "vscode", - "suggestions_count": 1000, - "acceptances_count": 500, - "lines_suggested": 2000, - "lines_accepted": 1000, - "active_users": 5 - } - ] - }, - { - "day": "2023-10-16", - "total_suggestions_count": 5200, - "total_acceptances_count": 5100, - "total_lines_suggested": 5300, - "total_lines_accepted": 5000, - "total_active_users": 15, - "total_chat_acceptances": 57, - "total_chat_turns": 455, - "total_active_chat_users": 12, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 3100, - "acceptances_count": 3000, - "lines_suggested": 3200, - "lines_accepted": 3100, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 1100, - "acceptances_count": 1000, - "lines_suggested": 1200, - "lines_accepted": 1100, - "active_users": 5 - }, - { - "language": "javascript", - "editor": "vscode", - "suggestions_count": 1000, - "acceptances_count": 900, - "lines_suggested": 1100, - "lines_accepted": 1000, - "active_users": 5 - } - ] - } - ] - }, "dependabot-alerts-for-organization": { "value": [ { @@ -275285,6 +274581,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -275376,6 +274673,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -275385,90 +274683,6 @@ } ] }, - "copilot-usage-metrics-org": { - "value": [ - { - "day": "2023-10-15", - "total_suggestions_count": 1000, - "total_acceptances_count": 800, - "total_lines_suggested": 1800, - "total_lines_accepted": 1200, - "total_active_users": 10, - "total_chat_acceptances": 32, - "total_chat_turns": 200, - "total_active_chat_users": 4, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 250, - "lines_suggested": 900, - "lines_accepted": 700, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 400, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 400, - "acceptances_count": 350, - "lines_suggested": 500, - "lines_accepted": 200, - "active_users": 3 - } - ] - }, - { - "day": "2023-10-16", - "total_suggestions_count": 800, - "total_acceptances_count": 600, - "total_lines_suggested": 1100, - "total_lines_accepted": 700, - "total_active_users": 12, - "total_chat_acceptances": 57, - "total_chat_turns": 426, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 600, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 150, - "lines_suggested": 300, - "lines_accepted": 250, - "active_users": 6 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 200, - "acceptances_count": 150, - "lines_suggested": 200, - "lines_accepted": 150, - "active_users": 3 - } - ] - } - ] - }, "public-events-items": { "value": [ { @@ -279199,6 +278413,322 @@ "plan_type": "business" } }, + "copilot-seats-list": { + "value": { + "total_seats": 2, + "seats": [ + { + "created_at": "2021-08-03T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": null, + "last_activity_at": "2021-10-14T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "plan_type": "business", + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "assigning_team": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "notification_setting": "notifications_enabled", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null + } + }, + { + "created_at": "2021-09-23T18:00:00-06:00", + "updated_at": "2021-09-23T15:00:00-06:00", + "pending_cancellation_date": "2021-11-01", + "last_activity_at": "2021-10-13T00:53:32-06:00", + "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", + "assignee": { + "login": "octokitten", + "id": 1, + "node_id": "MDQ76VNlcjE=", + "avatar_url": "https://github.com/images/error/octokitten_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octokitten", + "html_url": "https://github.com/octokitten", + "followers_url": "https://api.github.com/users/octokitten/followers", + "following_url": "https://api.github.com/users/octokitten/following{/other_user}", + "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", + "organizations_url": "https://api.github.com/users/octokitten/orgs", + "repos_url": "https://api.github.com/users/octokitten/repos", + "events_url": "https://api.github.com/users/octokitten/events{/privacy}", + "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": 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-org": { + "value": [ + { + "day": "2023-10-15", + "total_suggestions_count": 1000, + "total_acceptances_count": 800, + "total_lines_suggested": 1800, + "total_lines_accepted": 1200, + "total_active_users": 10, + "total_chat_acceptances": 32, + "total_chat_turns": 200, + "total_active_chat_users": 4, + "breakdown": [ + { + "language": "python", + "editor": "vscode", + "suggestions_count": 300, + "acceptances_count": 250, + "lines_suggested": 900, + "lines_accepted": 700, + "active_users": 5 + }, + { + "language": "python", + "editor": "jetbrains", + "suggestions_count": 300, + "acceptances_count": 200, + "lines_suggested": 400, + "lines_accepted": 300, + "active_users": 2 + }, + { + "language": "ruby", + "editor": "vscode", + "suggestions_count": 400, + "acceptances_count": 350, + "lines_suggested": 500, + "lines_accepted": 200, + "active_users": 3 + } + ] + }, + { + "day": "2023-10-16", + "total_suggestions_count": 800, + "total_acceptances_count": 600, + "total_lines_suggested": 1100, + "total_lines_accepted": 700, + "total_active_users": 12, + "total_chat_acceptances": 57, + "total_chat_turns": 426, + "total_active_chat_users": 8, + "breakdown": [ + { + "language": "python", + "editor": "vscode", + "suggestions_count": 300, + "acceptances_count": 200, + "lines_suggested": 600, + "lines_accepted": 300, + "active_users": 2 + }, + { + "language": "python", + "editor": "jetbrains", + "suggestions_count": 300, + "acceptances_count": 150, + "lines_suggested": 300, + "lines_accepted": 250, + "active_users": 6 + }, + { + "language": "ruby", + "editor": "vscode", + "suggestions_count": 200, + "acceptances_count": 150, + "lines_suggested": 200, + "lines_accepted": 150, + "active_users": 3 + } + ] + } + ] + }, "organization-dependabot-secret-paginated": { "value": { "total_count": 3, @@ -283043,6 +282573,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -295803,6 +295339,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -295827,6 +295364,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -295854,6 +295392,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -295899,6 +295438,7 @@ "push_protection_bypassed_by": null, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": "Example comment", @@ -302868,24 +302408,6 @@ "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.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, "gist-id": { "name": "gist_id", "description": "The unique identifier of the gist.", @@ -303339,6 +302861,15 @@ "type": "string" } }, + "team-slug": { + "name": "team_slug", + "description": "The slug of the team name.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, "role-id": { "name": "role_id", "description": "The unique identifier of the role.", @@ -304346,26 +303877,6 @@ } } }, - "internal_error": { - "description": "Internal Error", - "content": { - "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": { @@ -304447,6 +303958,16 @@ } } }, + "internal_error": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + } + } + } + }, "conflict": { "description": "Conflict", "content": { @@ -304548,6 +304069,16 @@ "no_content": { "description": "A header with no content is returned." }, + "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" + } + } + } + }, "package_es_list_error": { "description": "The value of `per_page` multiplied by `page` cannot be greater than 10000." }, diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index beb1a9836..08bc536b3 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -1433,225 +1433,6 @@ paths: enabledForGitHubApps: true category: emojis subcategory: emojis - "/enterprises/{enterprise}/copilot/billing/seats": - get: - summary: List all Copilot seat assignments for an enterprise - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. - - Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. - - For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. - Each seat object contains information about the assigned user's most recent Copilot activity. Users must have - telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." - - Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. - - Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/list-copilot-seats-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise - parameters: - - "$ref": "#/components/parameters/enterprise" - - "$ref": "#/components/parameters/page" - - name: per_page - description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 50 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - total_seats: - type: integer - description: The total number of Copilot seats the enterprise - is being billed for. Users with access through multiple organizations - or enterprise teams are only counted once. - seats: - type: array - items: - "$ref": "#/components/schemas/copilot-seat-details" - examples: - default: - "$ref": "#/components/examples/copilot-seats-list" - headers: - Link: - "$ref": "#/components/headers/link" - '500': - "$ref": "#/components/responses/internal_error" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - 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 - 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 all users across organizations with access to Copilot within your enterprise, 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. - - The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. - - Only owners and billing managers can view Copilot usage 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/usage-metrics-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-enterprise-members - 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" - examples: - default: - "$ref": "#/components/examples/copilot-usage-metrics-enterprise" - '500': - "$ref": "#/components/responses/internal_error" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise @@ -1763,163 +1544,6 @@ 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: |- - > [!NOTE] - > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." - - 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 - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." - - 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 an enterprise 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 enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. - - Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage 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/usage-metrics-for-enterprise-team - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team - parameters: - - "$ref": "#/components/parameters/enterprise" - - "$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" - examples: - default: - "$ref": "#/components/examples/copilot-usage-metrics-org" - '500': - "$ref": "#/components/responses/internal_error" - '401': - "$ref": "#/components/responses/requires_authentication" - '403': - "$ref": "#/components/responses/forbidden" - '404': - "$ref": "#/components/responses/not_found" - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage "/events": get: summary: List public events @@ -6762,6 +6386,8 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: default: "$ref": "#/components/examples/list-attestations" @@ -13106,50 +12732,7 @@ paths: content: application/json: schema: - type: object - properties: - value_type: - type: string - enum: - - string - - single_select - - multi_select - - true_false - description: The type of the value for the property - examples: - - single_select - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - description: Default value of the property - type: - - 'null' - - string - - array - description: - type: - - string - - 'null' - description: Short description of the property - allowed_values: - type: - - array - - 'null' - items: - type: string - maxLength: 75 - maxItems: 200 - description: |- - An ordered list of the allowed values of the property. - The property can have up to 200 allowed values. - required: - - value_type + "$ref": "#/components/schemas/custom-property-set-payload" examples: default: value: @@ -13785,6 +13368,7 @@ paths: - branch - tag - push + - repository default: branch enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" @@ -14001,6 +13585,7 @@ paths: - branch - tag - push + - repository enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -20879,6 +20464,8 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: default: "$ref": "#/components/examples/list-attestations" @@ -47940,6 +47527,8 @@ paths: "$ref": "#/components/schemas/sigstore-bundle-0" repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -68925,720 +68514,6 @@ components: - html_url - key - name - organization-simple: - title: Organization Simple - description: A GitHub organization. - type: object - properties: - login: - type: string - examples: - - github - id: - type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github - repos_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/events - hooks_url: - type: string - examples: - - https://api.github.com/orgs/github/hooks - issues_url: - type: string - examples: - - https://api.github.com/orgs/github/issues - members_url: - type: string - examples: - - https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - examples: - - https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - examples: - - https://github.com/images/error/octocat_happy.gif - description: - type: - - string - - 'null' - examples: - - A great organization - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - team-simple: - title: Team Simple - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - id: - description: Unique identifier of the team - type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDQ6VGVhbTE= - url: - description: URL for the team - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/1 - members_url: - type: string - examples: - - https://api.github.com/organizations/1/team/1/members{/member} - name: - description: Name of the team - type: string - examples: - - Justice League - description: - description: Description of the team - type: - - string - - 'null' - examples: - - A great team. - permission: - description: Permission that the team will have for its repositories - type: string - examples: - - admin - privacy: - description: The level of privacy this team should have - type: string - examples: - - closed - notification_setting: - description: The notification setting the team has set - type: string - examples: - - notifications_enabled - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/rails/teams/core - repositories_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/1/repos - slug: - type: string - examples: - - justice-league - ldap_dn: - description: Distinguished Name (DN) that team maps to within LDAP environment - type: string - examples: - - uid=example,ou=users,dc=github,dc=com - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - team: - title: Team - description: Groups of organization members that gives permissions on specified - repositories. - type: object - properties: - id: - type: integer - node_id: - type: string - name: - type: string - slug: - type: string - description: - type: - - string - - 'null' - privacy: - type: string - notification_setting: - type: string - permission: - type: string - permissions: - type: object - properties: - pull: - type: boolean - triage: - type: boolean - push: - type: boolean - maintain: - type: boolean - admin: - type: boolean - required: - - pull - - triage - - push - - maintain - - admin - url: - type: string - format: uri - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/rails/teams/core - members_url: - type: string - repositories_url: - type: string - format: uri - parent: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/team-simple" - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - - parent - enterprise-team: - title: Enterprise Team - description: Group of enterprise owners and/or members - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - slug: - type: string - url: - type: string - format: uri - sync_to_organizations: - type: string - examples: - - disabled | all - group_id: - type: - - string - - 'null' - examples: - - 62ab9291-fae2-468e-974b-7e45096d5021 - html_url: - type: string - format: uri - examples: - - https://github.com/enterprises/dc/teams/justice-league - members_url: - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - id - - url - - members_url - - sync_to_organizations - - name - - html_url - - slug - - created_at - - updated_at - copilot-seat-details: - title: Copilot Business Seat Detail - description: Information about a Copilot Business seat assignment for a user, - team, or organization. - type: object - properties: - assignee: - "$ref": "#/components/schemas/simple-user" - organization: - anyOf: - - type: 'null' - - "$ref": "#/components/schemas/organization-simple" - assigning_team: - description: The team through which the assignee is granted access to GitHub - Copilot, if applicable. - oneOf: - - "$ref": "#/components/schemas/team" - - "$ref": "#/components/schemas/enterprise-team" - type: - - 'null' - - object - pending_cancellation_date: - type: - - string - - 'null' - format: date - description: The pending cancellation date for the seat, in `YYYY-MM-DD` - format. This will be null unless the assignee's Copilot access has been - canceled during the current billing cycle. If the seat has been cancelled, - this corresponds to the start of the organization's next billing cycle. - last_activity_at: - type: - - string - - 'null' - format: date-time - description: Timestamp of user's last GitHub Copilot activity, in ISO 8601 - format. - last_activity_editor: - type: - - string - - 'null' - description: Last editor that was used by the user for a GitHub Copilot - completion. - created_at: - type: string - format: date-time - description: Timestamp of when the assignee was last granted access to GitHub - Copilot, in ISO 8601 format. - updated_at: - type: string - format: date-time - deprecated: true - description: "**Closing down notice:** This field is no longer relevant - and is closing down. Use the `created_at` field to determine when the - assignee was last granted access to GitHub Copilot. Timestamp of when - the assignee's GitHub Copilot access was last updated, in ISO 8601 format." - plan_type: - type: string - description: The Copilot plan of the organization, or the parent enterprise, - when applicable. - enum: - - business - - enterprise - - unknown - required: - - assignee - - created_at - additionalProperties: false - copilot-ide-code-completions: - type: - - object - - 'null' - description: Usage metrics for Copilot editor code completions in the IDE. - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code suggestion, - across all active editors. Includes both full and partial acceptances. - languages: - type: array - description: Code completion metrics for active languages. - items: - type: object - description: Usage metrics for a given language for the given editor for - Copilot code completions. - properties: - name: - type: string - description: Name of the language used for Copilot code completion - suggestions. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code - completion suggestion for the given language. Includes both full - and partial acceptances. - editors: - type: array - items: - type: object - description: Copilot code completion metrics for active editors. - additionalProperties: true - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot code - completion suggestion for the given editor. Includes both full and - partial acceptances. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot code completion - suggestions. If the default model is used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom model. - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot - code completion suggestion for the given editor, for the given - language and model. Includes both full and partial acceptances. - languages: - type: array - description: Code completion metrics for active languages, for - the given editor. - items: - type: object - description: Usage metrics for a given language for the given - editor for Copilot code completions. - properties: - name: - type: string - description: Name of the language used for Copilot code - completion suggestions, for the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted at least one - Copilot code completion suggestion for the given editor, - for the given language. Includes both full and partial - acceptances. - total_code_suggestions: - type: integer - description: The number of Copilot code suggestions generated - for the given editor, for the given language. - total_code_acceptances: - type: integer - description: The number of Copilot code suggestions accepted - for the given editor, for the given language. Includes - both full and partial acceptances. - total_code_lines_suggested: - type: integer - description: The number of lines of code suggested by - Copilot code completions for the given editor, for the - given language. - total_code_lines_accepted: - type: integer - description: The number of lines of code accepted from - Copilot code suggestions for the given editor, for the - given language. - copilot-ide-chat: - type: - - object - - 'null' - description: Usage metrics for Copilot Chat in the IDE. - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat in the IDE. - editors: - type: array - items: - type: object - description: Copilot Chat metrics, for active editors. - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: The number of users who prompted Copilot Chat in the - specified editor. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot code completion - suggestions. If the default model is used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom model. - total_engaged_users: - type: integer - description: The number of users who prompted Copilot Chat in - the given editor and model. - total_chats: - type: integer - description: The total number of chats initiated by users in - the given editor and model. - total_chat_insertion_events: - type: integer - description: The number of times users accepted a code suggestion - from Copilot Chat using the 'Insert Code' UI element, for - the given editor. - total_chat_copy_events: - type: integer - description: The number of times users copied a code suggestion - from Copilot Chat using the keyboard, or the 'Copy' UI element, - for the given editor. - copilot-dotcom-chat: - type: - - object - - 'null' - description: Usage metrics for Copilot Chat in github.com - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat on github.com - at least once. - models: - type: array - description: List of model metrics for a custom models and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot code completion suggestions. - If the default model is used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom model (if applicable). - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot Chat on github.com - at least once for each model. - total_chats: - type: integer - description: Total number of chats initiated by users on github.com. - copilot-dotcom-pull-requests: - type: - - object - - 'null' - description: Usage metrics for Copilot for pull requests. - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: The number of users who used Copilot for Pull Requests on github.com - to generate a pull request summary at least once. - repositories: - type: array - description: Repositories in which users used Copilot for Pull Requests - to generate pull request summaries - items: - type: object - properties: - name: - type: string - description: Repository name - total_engaged_users: - type: integer - description: The number of users who generated pull request summaries - using Copilot for Pull Requests in the given repository. - models: - type: array - description: List of model metrics for custom models and the default - model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot code completion - suggestions. If the default model is used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom model. - total_pr_summaries_created: - type: integer - description: The number of pull request summaries generated - using Copilot for Pull Requests in the given repository. - total_engaged_users: - type: integer - description: The number of users who generated pull request - summaries using Copilot for Pull Requests in the given repository - and model. - copilot-usage-metrics-day: - title: Copilot Usage Metrics - description: Copilot usage metrics for a given day. - type: object - properties: - date: - type: string - format: date - description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` - format. - total_active_users: - type: integer - description: The total number of Copilot users with activity belonging to - any Copilot feature, globally, for the given day. Includes passive activity - such as receiving a code suggestion, as well as engagement activity such - as accepting a code suggestion or prompting chat. Does not include authentication - events. Is not limited to the individual features detailed on the endpoint. - total_engaged_users: - type: integer - description: The total number of Copilot users who engaged with any Copilot - feature, for the given day. Examples include but are not limited to accepting - a code suggestion, prompting Copilot chat, or triggering a PR Summary. - Does not include authentication events. Is not limited to the individual - features detailed on the endpoint. - copilot_ide_code_completions: - "$ref": "#/components/schemas/copilot-ide-code-completions" - copilot_ide_chat: - "$ref": "#/components/schemas/copilot-ide-chat" - copilot_dotcom_chat: - "$ref": "#/components/schemas/copilot-dotcom-chat" - copilot_dotcom_pull_requests: - "$ref": "#/components/schemas/copilot-dotcom-pull-requests" - required: - - date - additionalProperties: true - copilot-usage-metrics: - title: Copilot Usage Metrics - description: Summary of Copilot usage. - type: object - properties: - day: - type: string - format: date - description: The date for which the usage metrics are reported, in `YYYY-MM-DD` - format. - total_suggestions_count: - type: integer - description: The total number of Copilot code completion suggestions shown - to users. - total_acceptances_count: - type: integer - description: The total number of Copilot code completion suggestions accepted - by users. - total_lines_suggested: - type: integer - description: The total number of lines of code completions suggested by - Copilot. - total_lines_accepted: - type: integer - description: The total number of lines of code completions accepted by users. - total_active_users: - type: integer - description: The total number of users who were shown Copilot code completion - suggestions during the day specified. - total_chat_acceptances: - type: integer - description: The total instances of users who accepted code suggested by - Copilot Chat in the IDE (panel and inline). - total_chat_turns: - type: integer - description: The total number of chat turns (prompt and response pairs) - sent between users and Copilot Chat in the IDE. - total_active_chat_users: - type: integer - description: The total number of users who interacted with Copilot Chat - in the IDE during the day specified. - breakdown: - type: - - array - - 'null' - description: Breakdown of Copilot code completions usage by language and - editor - items: - type: object - description: Breakdown of Copilot usage by editor for this language - additionalProperties: true - properties: - language: - type: string - description: The language in which Copilot suggestions were shown - to users in the specified editor. - editor: - type: string - description: The editor in which Copilot suggestions were shown to - users for the specified language. - suggestions_count: - type: integer - description: The number of Copilot suggestions shown to users in the - editor specified during the day specified. - acceptances_count: - type: integer - description: The number of Copilot suggestions accepted by users in - the editor specified during the day specified. - lines_suggested: - type: integer - description: The number of lines of code suggested by Copilot in the - editor specified during the day specified. - lines_accepted: - type: integer - description: The number of lines of code accepted by users in the - editor specified during the day specified. - active_users: - type: integer - description: The number of users who were shown Copilot completion - suggestions in the editor specified during the day specified. - required: - - day - - breakdown - additionalProperties: false alert-number: type: integer description: The security alert number. @@ -70403,6 +69278,11 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. push_protection_bypass_request_comment: type: - string @@ -72644,6 +71524,77 @@ components: - reason - url - subscribed + organization-simple: + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description billing-usage-report: type: object properties: @@ -74456,6 +73407,649 @@ components: - public_code_suggestions - seat_management_setting additionalProperties: true + team-simple: + title: Team Simple + description: Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1 + members_url: + type: string + examples: + - https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + examples: + - Justice League + description: + description: Description of the team + type: + - string + - 'null' + examples: + - A great team. + permission: + description: Permission that the team will have for its repositories + type: string + examples: + - admin + privacy: + description: The level of privacy this team should have + type: string + examples: + - closed + notification_setting: + description: The notification setting the team has set + type: string + examples: + - notifications_enabled + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1/repos + slug: + type: string + examples: + - justice-league + ldap_dn: + description: Distinguished Name (DN) that team maps to within LDAP environment + type: string + examples: + - uid=example,ou=users,dc=github,dc=com + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + team: + title: Team + description: Groups of organization members that gives permissions on specified + repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/team-simple" + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + enterprise-team: + title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + examples: + - disabled | all + group_id: + type: + - string + - 'null' + examples: + - 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: + type: string + format: uri + examples: + - https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - sync_to_organizations + - name + - html_url + - slug + - created_at + - updated_at + copilot-seat-details: + title: Copilot Business Seat Detail + description: Information about a Copilot Business seat assignment for a user, + team, or organization. + type: object + properties: + assignee: + "$ref": "#/components/schemas/simple-user" + organization: + anyOf: + - type: 'null' + - "$ref": "#/components/schemas/organization-simple" + assigning_team: + description: The team through which the assignee is granted access to GitHub + Copilot, if applicable. + oneOf: + - "$ref": "#/components/schemas/team" + - "$ref": "#/components/schemas/enterprise-team" + type: + - 'null' + - object + pending_cancellation_date: + type: + - string + - 'null' + format: date + description: The pending cancellation date for the seat, in `YYYY-MM-DD` + format. This will be null unless the assignee's Copilot access has been + canceled during the current billing cycle. If the seat has been cancelled, + this corresponds to the start of the organization's next billing cycle. + last_activity_at: + type: + - string + - 'null' + format: date-time + description: Timestamp of user's last GitHub Copilot activity, in ISO 8601 + format. + last_activity_editor: + type: + - string + - 'null' + description: Last editor that was used by the user for a GitHub Copilot + completion. + created_at: + type: string + format: date-time + description: Timestamp of when the assignee was last granted access to GitHub + Copilot, in ISO 8601 format. + updated_at: + type: string + format: date-time + deprecated: true + description: "**Closing down notice:** This field is no longer relevant + and is closing down. Use the `created_at` field to determine when the + assignee was last granted access to GitHub Copilot. Timestamp of when + the assignee's GitHub Copilot access was last updated, in ISO 8601 format." + plan_type: + type: string + description: The Copilot plan of the organization, or the parent enterprise, + when applicable. + enum: + - business + - enterprise + - unknown + required: + - assignee + - created_at + additionalProperties: false + copilot-ide-code-completions: + type: + - object + - 'null' + description: Usage metrics for Copilot editor code completions in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code suggestion, + across all active editors. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the given editor for + Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code completion + suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given language. Includes both full + and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot code + completion suggestion for the given editor. Includes both full and + partial acceptances. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code completion + suggestions. If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code completion suggestion for the given editor, for the given + language and model. Includes both full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages, for + the given editor. + items: + type: object + description: Usage metrics for a given language for the given + editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot code + completion suggestions, for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least one + Copilot code completion suggestion for the given editor, + for the given language. Includes both full and partial + acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code suggestions generated + for the given editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code suggestions accepted + for the given editor, for the given language. Includes + both full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code suggested by + Copilot code completions for the given editor, for the + given language. + total_code_lines_accepted: + type: integer + description: The number of lines of code accepted from + Copilot code suggestions for the given editor, for the + given language. + copilot-ide-chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in the + specified editor. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code completion + suggestions. If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot Chat in + the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated by users in + the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted a code suggestion + from Copilot Chat using the 'Insert Code' UI element, for + the given editor. + total_chat_copy_events: + type: integer + description: The number of times users copied a code suggestion + from Copilot Chat using the keyboard, or the 'Copy' UI element, + for the given editor. + copilot-dotcom-chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in github.com + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once. + models: + type: array + description: List of model metrics for a custom models and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code completion suggestions. + If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model (if applicable). + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot Chat on github.com + at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users on github.com. + copilot-dotcom-pull-requests: + type: + - object + - 'null' + description: Usage metrics for Copilot for pull requests. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull Requests on github.com + to generate a pull request summary at least once. + repositories: + type: array + description: Repositories in which users used Copilot for Pull Requests + to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull request summaries + using Copilot for Pull Requests in the given repository. + models: + type: array + description: List of model metrics for custom models and the default + model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code completion + suggestions. If the default model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries generated + using Copilot for Pull Requests in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated pull request + summaries using Copilot for Pull Requests in the given repository + and model. + copilot-usage-metrics-day: + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, in `YYYY-MM-DD` + format. + total_active_users: + type: integer + description: The total number of Copilot users with activity belonging to + any Copilot feature, globally, for the given day. Includes passive activity + such as receiving a code suggestion, as well as engagement activity such + as accepting a code suggestion or prompting chat. Does not include authentication + events. Is not limited to the individual features detailed on the endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with any Copilot + feature, for the given day. Examples include but are not limited to accepting + a code suggestion, prompting Copilot chat, or triggering a PR Summary. + Does not include authentication events. Is not limited to the individual + features detailed on the endpoint. + copilot_ide_code_completions: + "$ref": "#/components/schemas/copilot-ide-code-completions" + copilot_ide_chat: + "$ref": "#/components/schemas/copilot-ide-chat" + copilot_dotcom_chat: + "$ref": "#/components/schemas/copilot-dotcom-chat" + copilot_dotcom_pull_requests: + "$ref": "#/components/schemas/copilot-dotcom-pull-requests" + required: + - date + additionalProperties: true + copilot-usage-metrics: + title: Copilot Usage Metrics + description: Summary of Copilot usage. + type: object + properties: + day: + type: string + format: date + description: The date for which the usage metrics are reported, in `YYYY-MM-DD` + format. + total_suggestions_count: + type: integer + description: The total number of Copilot code completion suggestions shown + to users. + total_acceptances_count: + type: integer + description: The total number of Copilot code completion suggestions accepted + by users. + total_lines_suggested: + type: integer + description: The total number of lines of code completions suggested by + Copilot. + total_lines_accepted: + type: integer + description: The total number of lines of code completions accepted by users. + total_active_users: + type: integer + description: The total number of users who were shown Copilot code completion + suggestions during the day specified. + total_chat_acceptances: + type: integer + description: The total instances of users who accepted code suggested by + Copilot Chat in the IDE (panel and inline). + total_chat_turns: + type: integer + description: The total number of chat turns (prompt and response pairs) + sent between users and Copilot Chat in the IDE. + total_active_chat_users: + type: integer + description: The total number of users who interacted with Copilot Chat + in the IDE during the day specified. + breakdown: + type: + - array + - 'null' + description: Breakdown of Copilot code completions usage by language and + editor + items: + type: object + description: Breakdown of Copilot usage by editor for this language + additionalProperties: true + properties: + language: + type: string + description: The language in which Copilot suggestions were shown + to users in the specified editor. + editor: + type: string + description: The editor in which Copilot suggestions were shown to + users for the specified language. + suggestions_count: + type: integer + description: The number of Copilot suggestions shown to users in the + editor specified during the day specified. + acceptances_count: + type: integer + description: The number of Copilot suggestions accepted by users in + the editor specified during the day specified. + lines_suggested: + type: integer + description: The number of lines of code suggested by Copilot in the + editor specified during the day specified. + lines_accepted: + type: integer + description: The number of lines of code accepted by users in the + editor specified during the day specified. + active_users: + type: integer + description: The number of users who were shown Copilot completion + suggestions in the editor specified during the day specified. + required: + - day + - breakdown + additionalProperties: false organization-dependabot-secret: title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. @@ -75731,6 +75325,53 @@ components: required: - property_name - value_type + custom-property-set-payload: + title: Custom Property Set Payload + description: Custom property set payload + type: object + properties: + value_type: + type: string + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + required: + - value_type custom-property-value: title: Custom Property Value description: Custom property name and associated value @@ -76521,6 +76162,7 @@ components: Conditions for an organization ruleset. The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. The push rulesets conditions object does not require the `ref_name` property. + For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. oneOf: - type: object title: repository_name_and_ref_name @@ -76738,6 +76380,13 @@ components: parameters: type: object properties: + allowed_merge_methods: + type: array + description: When merging pull requests, you can allow any combination + of merge commits, squashing, or rebasing. At least one option must + be enabled. + items: + type: string dismiss_stale_reviews_on_push: type: boolean description: New, reviewable commits pushed will dismiss previous pull @@ -77243,12 +76892,14 @@ components: - branch - tag - push + - repository source_type: type: string description: The type of the source of the ruleset enum: - Repository - Organization + - Enterprise source: type: string description: The name of the source @@ -79267,6 +78918,8 @@ components: "$ref": "#/components/schemas/rate-limit" dependency_snapshots: "$ref": "#/components/schemas/rate-limit" + code_scanning_autofix: + "$ref": "#/components/schemas/rate-limit" required: - core - search @@ -89329,6 +88982,11 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. push_protection_bypass_request_comment: type: - string @@ -101909,6 +101567,11 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. push_protection_bypass_request_comment: type: - string @@ -202202,236 +201865,6 @@ components: zombie_man: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2642.png?v8 zombie_woman: https://github.githubassets.com/images/icons/emoji/unicode/1f9df-2640.png?v8 zzz: https://github.githubassets.com/images/icons/emoji/unicode/1f4a4.png?v8 - copilot-seats-list: - value: - total_seats: 2 - seats: - - created_at: '2021-08-03T18:00:00-06:00' - updated_at: '2021-09-23T15:00:00-06:00' - pending_cancellation_date: - last_activity_at: '2021-10-14T00:53:32-06:00' - last_activity_editor: vscode/1.77.3/copilot/1.86.82 - plan_type: business - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assigning_team: - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - - created_at: '2021-09-23T18:00:00-06:00' - updated_at: '2021-09-23T15:00:00-06:00' - pending_cancellation_date: '2021-11-01' - last_activity_at: '2021-10-13T00:53:32-06:00' - last_activity_editor: vscode/1.77.3/copilot/1.86.82 - assignee: - login: octokitten - id: 1 - node_id: MDQ76VNlcjE= - avatar_url: https://github.com/images/error/octokitten_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octokitten - html_url: https://github.com/octokitten - followers_url: https://api.github.com/users/octokitten/followers - following_url: https://api.github.com/users/octokitten/following{/other_user} - gists_url: https://api.github.com/users/octokitten/gists{/gist_id} - starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octokitten/subscriptions - organizations_url: https://api.github.com/users/octokitten/orgs - repos_url: https://api.github.com/users/octokitten/repos - events_url: https://api.github.com/users/octokitten/events{/privacy} - 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' - total_suggestions_count: 5000 - total_acceptances_count: 3000 - total_lines_suggested: 7000 - total_lines_accepted: 3500 - total_active_users: 15 - total_chat_acceptances: 45 - total_chat_turns: 350 - total_active_chat_users: 8 - breakdown: - - language: python - editor: vscode - suggestions_count: 3000 - acceptances_count: 2000 - lines_suggested: 3000 - lines_accepted: 1500 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 1000 - acceptances_count: 500 - lines_suggested: 2000 - lines_accepted: 1000 - active_users: 5 - - language: javascript - editor: vscode - suggestions_count: 1000 - acceptances_count: 500 - lines_suggested: 2000 - lines_accepted: 1000 - active_users: 5 - - day: '2023-10-16' - total_suggestions_count: 5200 - total_acceptances_count: 5100 - total_lines_suggested: 5300 - total_lines_accepted: 5000 - total_active_users: 15 - total_chat_acceptances: 57 - total_chat_turns: 455 - total_active_chat_users: 12 - breakdown: - - language: python - editor: vscode - suggestions_count: 3100 - acceptances_count: 3000 - lines_suggested: 3200 - lines_accepted: 3100 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 1100 - acceptances_count: 1000 - lines_suggested: 1200 - lines_accepted: 1100 - active_users: 5 - - language: javascript - editor: vscode - suggestions_count: 1000 - acceptances_count: 900 - lines_suggested: 1100 - lines_accepted: 1000 - active_users: 5 dependabot-alerts-for-organization: value: - number: 2 @@ -202880,6 +202313,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true + push_protection_bypass_request_reviewer_comment: Example response push_protection_bypass_request_comment: Example comment push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment @@ -202967,76 +202401,13 @@ components: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: validity: unknown publicly_leaked: false multi_repo: false - copilot-usage-metrics-org: - value: - - day: '2023-10-15' - total_suggestions_count: 1000 - total_acceptances_count: 800 - total_lines_suggested: 1800 - total_lines_accepted: 1200 - total_active_users: 10 - total_chat_acceptances: 32 - total_chat_turns: 200 - total_active_chat_users: 4 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 250 - lines_suggested: 900 - lines_accepted: 700 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 400 - lines_accepted: 300 - active_users: 2 - - language: ruby - editor: vscode - suggestions_count: 400 - acceptances_count: 350 - lines_suggested: 500 - lines_accepted: 200 - active_users: 3 - - day: '2023-10-16' - total_suggestions_count: 800 - total_acceptances_count: 600 - total_lines_suggested: 1100 - total_lines_accepted: 700 - total_active_users: 12 - total_chat_acceptances: 57 - total_chat_turns: 426 - total_active_chat_users: 8 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 600 - lines_accepted: 300 - active_users: 2 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 150 - lines_suggested: 300 - lines_accepted: 250 - active_users: 6 - - language: ruby - editor: vscode - suggestions_count: 200 - acceptances_count: 150 - lines_suggested: 200 - lines_accepted: 150 - active_users: 3 public-events-items: value: - id: '22249084947' @@ -206272,6 +205643,236 @@ components: cli: enabled public_code_suggestions: block plan_type: business + copilot-seats-list: + value: + total_seats: 2 + seats: + - created_at: '2021-08-03T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: + last_activity_at: '2021-10-14T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + plan_type: business + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assigning_team: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + - created_at: '2021-09-23T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: '2021-11-01' + last_activity_at: '2021-10-13T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + assignee: + login: octokitten + id: 1 + node_id: MDQ76VNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + 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-org: + value: + - day: '2023-10-15' + total_suggestions_count: 1000 + total_acceptances_count: 800 + total_lines_suggested: 1800 + total_lines_accepted: 1200 + total_active_users: 10 + total_chat_acceptances: 32 + total_chat_turns: 200 + total_active_chat_users: 4 + breakdown: + - language: python + editor: vscode + suggestions_count: 300 + acceptances_count: 250 + lines_suggested: 900 + lines_accepted: 700 + active_users: 5 + - language: python + editor: jetbrains + suggestions_count: 300 + acceptances_count: 200 + lines_suggested: 400 + lines_accepted: 300 + active_users: 2 + - language: ruby + editor: vscode + suggestions_count: 400 + acceptances_count: 350 + lines_suggested: 500 + lines_accepted: 200 + active_users: 3 + - day: '2023-10-16' + total_suggestions_count: 800 + total_acceptances_count: 600 + total_lines_suggested: 1100 + total_lines_accepted: 700 + total_active_users: 12 + total_chat_acceptances: 57 + total_chat_turns: 426 + total_active_chat_users: 8 + breakdown: + - language: python + editor: vscode + suggestions_count: 300 + acceptances_count: 200 + lines_suggested: 600 + lines_accepted: 300 + active_users: 2 + - language: python + editor: jetbrains + suggestions_count: 300 + acceptances_count: 150 + lines_suggested: 300 + lines_accepted: 250 + active_users: 6 + - language: ruby + editor: vscode + suggestions_count: 200 + acceptances_count: 150 + lines_suggested: 200 + lines_accepted: 150 + active_users: 3 organization-dependabot-secret-paginated: value: total_count: 3 @@ -209604,6 +209205,11 @@ components: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -220550,6 +220156,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true + push_protection_bypass_request_reviewer_comment: Example response push_protection_bypass_request_comment: Example comment push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment @@ -220572,6 +220179,7 @@ components: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -220596,6 +220204,7 @@ components: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -220638,6 +220247,7 @@ components: push_protection_bypassed_by: push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: Example comment @@ -226703,20 +226313,6 @@ 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. - in: path - required: true - schema: - type: string gist-id: name: gist_id description: The unique identifier of the gist. @@ -227098,6 +226694,13 @@ components: required: true schema: type: string + team-slug: + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string role-id: name: role_id description: The unique identifier of the role. @@ -227940,19 +227543,6 @@ components: application/json: schema: "$ref": "#/components/schemas/basic-error" - internal_error: - description: Internal Error - content: - 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: @@ -228003,6 +227593,12 @@ components: examples: default: "$ref": "#/components/examples/billing-usage-report" + internal_error: + description: Internal Error + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" conflict: description: Conflict content: @@ -228067,6 +227663,13 @@ components: "$ref": "#/components/examples/runner-labels-readonly" no_content: description: A header with no content is returned. + 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" package_es_list_error: description: The value of `per_page` multiplied by `page` cannot be greater than 10000. diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index ceb51d774..7c85add84 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -17808,1896 +17808,6 @@ } } }, - "/enterprises/{enterprise}/copilot/billing/seats": { - "get": { - "summary": "List all Copilot seat assignments for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/list-copilot-seats-for-enterprise", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-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": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 50 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "total_seats": { - "type": "integer", - "description": "The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once." - }, - "seats": { - "type": "array", - "items": { - "title": "Copilot Business Seat Detail", - "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", - "type": "object", - "properties": { - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - } - ] - }, - "assigning_team": { - "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", - "oneOf": [ - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - }, - { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "sync_to_organizations": { - "type": "string", - "examples": [ - "disabled | all" - ] - }, - "group_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "62ab9291-fae2-468e-974b-7e45096d5021" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/dc/teams/justice-league" - ] - }, - "members_url": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "url", - "members_url", - "sync_to_organizations", - "name", - "html_url", - "slug", - "created_at", - "updated_at" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "pending_cancellation_date": { - "type": [ - "string", - "null" - ], - "format": "date", - "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." - }, - "last_activity_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." - }, - "last_activity_editor": { - "type": [ - "string", - "null" - ], - "description": "Last editor that was used by the user for a GitHub Copilot completion." - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "deprecated": true, - "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." - }, - "plan_type": { - "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise", - "unknown" - ] - } - }, - "required": [ - "assignee", - "created_at" - ], - "additionalProperties": false - } - } - } - }, - "examples": { - "default": { - "value": { - "total_seats": 2, - "seats": [ - { - "created_at": "2021-08-03T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": null, - "last_activity_at": "2021-10-14T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "plan_type": "business", - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "assigning_team": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - }, - { - "created_at": "2021-09-23T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": "2021-11-01", - "last_activity_at": "2021-10-13T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "assignee": { - "login": "octokitten", - "id": 1, - "node_id": "MDQ76VNlcjE=", - "avatar_url": "https://github.com/images/error/octokitten_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octokitten", - "html_url": "https://github.com/octokitten", - "followers_url": "https://api.github.com/users/octokitten/followers", - "following_url": "https://api.github.com/users/octokitten/following{/other_user}", - "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", - "organizations_url": "https://api.github.com/users/octokitten/orgs", - "repos_url": "https://api.github.com/users/octokitten/repos", - "events_url": "https://api.github.com/users/octokitten/events{/privacy}", - "received_events_url": "https://api.github.com/users/octokitten/received_events", - "type": "User", - "site_admin": false - } - } - ] - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "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.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly enterprise owners and billing managers can view Copilot metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/copilot-metrics-for-enterprise", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "until", - "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 28 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Copilot Usage Metrics", - "description": "Copilot usage metrics for a given day.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "total_engaged_users": { - "type": "integer", - "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "copilot_ide_code_completions": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot_ide_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot_dotcom_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in github.com", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." - }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model (if applicable)." - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot_dotcom_pull_requests": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot for pull requests.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." - }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } - } - } - } - } - } - } - }, - "required": [ - "date" - ], - "additionalProperties": true - } - }, - "examples": { - "default": { - "value": [ - { - "date": "2024-06-24", - "total_active_users": 24, - "total_engaged_users": 20, - "copilot_ide_code_completions": { - "total_engaged_users": 20, - "languages": [ - { - "name": "python", - "total_engaged_users": 10 - }, - { - "name": "ruby", - "total_engaged_users": 10 - } - ], - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 13, - "languages": [ - { - "name": "python", - "total_engaged_users": 6, - "total_code_suggestions": 249, - "total_code_acceptances": 123, - "total_code_lines_suggested": 225, - "total_code_lines_accepted": 135 - }, - { - "name": "ruby", - "total_engaged_users": 7, - "total_code_suggestions": 496, - "total_code_acceptances": 253, - "total_code_lines_suggested": 520, - "total_code_lines_accepted": 270 - } - ] - } - ] - }, - { - "name": "neovim", - "total_engaged_users": 7, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "languages": [ - { - "name": "typescript", - "total_engaged_users": 3, - "total_code_suggestions": 112, - "total_code_acceptances": 56, - "total_code_lines_suggested": 143, - "total_code_lines_accepted": 61 - }, - { - "name": "go", - "total_engaged_users": 4, - "total_code_suggestions": 132, - "total_code_acceptances": 67, - "total_code_lines_suggested": 154, - "total_code_lines_accepted": 72 - } - ] - } - ] - } - ] - }, - "copilot_ide_chat": { - "total_engaged_users": 13, - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 12, - "total_chats": 45, - "total_chat_insertion_events": 12, - "total_chat_copy_events": 16 - }, - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_engaged_users": 1, - "total_chats": 10, - "total_chat_insertion_events": 11, - "total_chat_copy_events": 3 - } - ] - } - ] - }, - "copilot_dotcom_chat": { - "total_engaged_users": 14, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 14, - "total_chats": 38 - } - ] - }, - "copilot_dotcom_pull_requests": { - "total_engaged_users": 12, - "repositories": [ - { - "name": "demo/repo1", - "total_engaged_users": 8, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_pr_summaries_created": 6, - "total_engaged_users": 8 - } - ] - }, - { - "name": "demo/repo2", - "total_engaged_users": 4, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_pr_summaries_created": 10, - "total_engaged_users": 4 - } - ] - } - ] - } - } - ] - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-metrics" - } - } - }, - "/enterprises/{enterprise}/copilot/usage": { - "get": { - "summary": "Get a summary of Copilot usage for enterprise members", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage 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\nThe time zone in the response is in UTC time, that means that the cutoff time for the \"day\" is UTC time.\n\nOnly owners and billing managers can view Copilot usage 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/usage-metrics-for-enterprise", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-enterprise-members" - }, - "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": "Summary of Copilot usage.", - "type": "object", - "properties": { - "day": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." - }, - "total_suggestions_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions shown to users." - }, - "total_acceptances_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions accepted by users." - }, - "total_lines_suggested": { - "type": "integer", - "description": "The total number of lines of code completions suggested by Copilot." - }, - "total_lines_accepted": { - "type": "integer", - "description": "The total number of lines of code completions accepted by users." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." - }, - "total_chat_acceptances": { - "type": "integer", - "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." - }, - "total_chat_turns": { - "type": "integer", - "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." - }, - "total_active_chat_users": { - "type": "integer", - "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." - }, - "breakdown": { - "type": [ - "array", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "items": { - "type": "object", - "description": "Breakdown of Copilot usage by editor for this language", - "additionalProperties": true, - "properties": { - "language": { - "type": "string", - "description": "The language in which Copilot suggestions were shown to users in the specified editor." - }, - "editor": { - "type": "string", - "description": "The editor in which Copilot suggestions were shown to users for the specified language." - }, - "suggestions_count": { - "type": "integer", - "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." - }, - "acceptances_count": { - "type": "integer", - "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." - }, - "lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." - }, - "lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted by users in the editor specified during the day specified." - }, - "active_users": { - "type": "integer", - "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." - } - } - } - } - }, - "required": [ - "day", - "breakdown" - ], - "additionalProperties": false - } - }, - "examples": { - "default": { - "value": [ - { - "day": "2023-10-15", - "total_suggestions_count": 5000, - "total_acceptances_count": 3000, - "total_lines_suggested": 7000, - "total_lines_accepted": 3500, - "total_active_users": 15, - "total_chat_acceptances": 45, - "total_chat_turns": 350, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 3000, - "acceptances_count": 2000, - "lines_suggested": 3000, - "lines_accepted": 1500, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 1000, - "acceptances_count": 500, - "lines_suggested": 2000, - "lines_accepted": 1000, - "active_users": 5 - }, - { - "language": "javascript", - "editor": "vscode", - "suggestions_count": 1000, - "acceptances_count": 500, - "lines_suggested": 2000, - "lines_accepted": 1000, - "active_users": 5 - } - ] - }, - { - "day": "2023-10-16", - "total_suggestions_count": 5200, - "total_acceptances_count": 5100, - "total_lines_suggested": 5300, - "total_lines_accepted": 5000, - "total_active_users": 15, - "total_chat_acceptances": 57, - "total_chat_turns": 455, - "total_active_chat_users": 12, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 3100, - "acceptances_count": 3000, - "lines_suggested": 3200, - "lines_accepted": 3100, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 1100, - "acceptances_count": 1000, - "lines_suggested": 1200, - "lines_accepted": 1100, - "active_users": 5 - }, - { - "language": "javascript", - "editor": "vscode", - "suggestions_count": 1000, - "acceptances_count": 900, - "lines_suggested": 1100, - "lines_accepted": 1000, - "active_users": 5 - } - ] - } - ] - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage" - } - } - }, "/enterprises/{enterprise}/dependabot/alerts": { "get": { "summary": "List Dependabot alerts for an enterprise", @@ -22948,6 +21058,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -23140,6 +21257,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -23231,6 +21349,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -23308,1040 +21427,6 @@ } } }, - "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { - "get": { - "summary": "Get Copilot metrics for an enterprise team", - "description": "> [!NOTE]\n> This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nUse this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/copilot-metrics-for-enterprise-team", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the enterprise team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "until", - "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 28 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Copilot Usage Metrics", - "description": "Copilot usage metrics for a given day.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "total_engaged_users": { - "type": "integer", - "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "copilot_ide_code_completions": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot_ide_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot_dotcom_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in github.com", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." - }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model (if applicable)." - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot_dotcom_pull_requests": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot for pull requests.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." - }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } - } - } - } - } - } - } - }, - "required": [ - "date" - ], - "additionalProperties": true - } - }, - "examples": { - "default": { - "value": [ - { - "date": "2024-06-24", - "total_active_users": 24, - "total_engaged_users": 20, - "copilot_ide_code_completions": { - "total_engaged_users": 20, - "languages": [ - { - "name": "python", - "total_engaged_users": 10 - }, - { - "name": "ruby", - "total_engaged_users": 10 - } - ], - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 13, - "languages": [ - { - "name": "python", - "total_engaged_users": 6, - "total_code_suggestions": 249, - "total_code_acceptances": 123, - "total_code_lines_suggested": 225, - "total_code_lines_accepted": 135 - }, - { - "name": "ruby", - "total_engaged_users": 7, - "total_code_suggestions": 496, - "total_code_acceptances": 253, - "total_code_lines_suggested": 520, - "total_code_lines_accepted": 270 - } - ] - } - ] - }, - { - "name": "neovim", - "total_engaged_users": 7, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "languages": [ - { - "name": "typescript", - "total_engaged_users": 3, - "total_code_suggestions": 112, - "total_code_acceptances": 56, - "total_code_lines_suggested": 143, - "total_code_lines_accepted": 61 - }, - { - "name": "go", - "total_engaged_users": 4, - "total_code_suggestions": 132, - "total_code_acceptances": 67, - "total_code_lines_suggested": 154, - "total_code_lines_accepted": 72 - } - ] - } - ] - } - ] - }, - "copilot_ide_chat": { - "total_engaged_users": 13, - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 12, - "total_chats": 45, - "total_chat_insertion_events": 12, - "total_chat_copy_events": 16 - }, - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_engaged_users": 1, - "total_chats": 10, - "total_chat_insertion_events": 11, - "total_chat_copy_events": 3 - } - ] - } - ] - }, - "copilot_dotcom_chat": { - "total_engaged_users": 14, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 14, - "total_chats": 38 - } - ] - }, - "copilot_dotcom_pull_requests": { - "total_engaged_users": 12, - "repositories": [ - { - "name": "demo/repo1", - "total_engaged_users": 8, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_pr_summaries_created": 6, - "total_engaged_users": 8 - } - ] - }, - { - "name": "demo/repo2", - "total_engaged_users": 4, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_pr_summaries_created": 10, - "total_engaged_users": 4 - } - ] - } - ] - } - } - ] - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-metrics" - } - } - }, - "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { - "get": { - "summary": "Get a summary of Copilot usage for an enterprise team", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage 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, as evaluated at the end of that day.\n\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage 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/usage-metrics-for-enterprise-team", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-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 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": "Summary of Copilot usage.", - "type": "object", - "properties": { - "day": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." - }, - "total_suggestions_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions shown to users." - }, - "total_acceptances_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions accepted by users." - }, - "total_lines_suggested": { - "type": "integer", - "description": "The total number of lines of code completions suggested by Copilot." - }, - "total_lines_accepted": { - "type": "integer", - "description": "The total number of lines of code completions accepted by users." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." - }, - "total_chat_acceptances": { - "type": "integer", - "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." - }, - "total_chat_turns": { - "type": "integer", - "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." - }, - "total_active_chat_users": { - "type": "integer", - "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." - }, - "breakdown": { - "type": [ - "array", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "items": { - "type": "object", - "description": "Breakdown of Copilot usage by editor for this language", - "additionalProperties": true, - "properties": { - "language": { - "type": "string", - "description": "The language in which Copilot suggestions were shown to users in the specified editor." - }, - "editor": { - "type": "string", - "description": "The editor in which Copilot suggestions were shown to users for the specified language." - }, - "suggestions_count": { - "type": "integer", - "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." - }, - "acceptances_count": { - "type": "integer", - "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." - }, - "lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." - }, - "lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted by users in the editor specified during the day specified." - }, - "active_users": { - "type": "integer", - "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." - } - } - } - } - }, - "required": [ - "day", - "breakdown" - ], - "additionalProperties": false - } - }, - "examples": { - "default": { - "value": [ - { - "day": "2023-10-15", - "total_suggestions_count": 1000, - "total_acceptances_count": 800, - "total_lines_suggested": 1800, - "total_lines_accepted": 1200, - "total_active_users": 10, - "total_chat_acceptances": 32, - "total_chat_turns": 200, - "total_active_chat_users": 4, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 250, - "lines_suggested": 900, - "lines_accepted": 700, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 400, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 400, - "acceptances_count": 350, - "lines_suggested": 500, - "lines_accepted": 200, - "active_users": 3 - } - ] - }, - { - "day": "2023-10-16", - "total_suggestions_count": 800, - "total_acceptances_count": 600, - "total_lines_suggested": 1100, - "total_lines_accepted": 700, - "total_active_users": 12, - "total_chat_acceptances": 57, - "total_chat_turns": 426, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 600, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 150, - "lines_suggested": 300, - "lines_accepted": 250, - "active_users": 6 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 200, - "acceptances_count": 150, - "lines_suggested": 200, - "lines_accepted": 150, - "active_users": 3 - } - ] - } - ] - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage" - } - } - }, "/events": { "get": { "summary": "List public events", @@ -69581,6 +66666,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -128134,6 +125222,8 @@ "content": { "application/json": { "schema": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", "type": "object", "properties": { "value_type": { @@ -135439,7 +132529,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -135447,7 +132538,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -135573,7 +132665,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -136044,6 +133136,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -136788,7 +133887,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ], "default": "branch" }, @@ -136845,7 +133945,7 @@ "conditions": { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -137311,6 +134411,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -137984,7 +135091,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -137992,7 +135100,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -138118,7 +135227,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -138589,6 +135698,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -139920,7 +137036,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -139928,7 +137045,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -140054,7 +137172,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -140525,6 +137643,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -141295,7 +138420,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "enforcement": { @@ -141351,7 +138477,7 @@ "conditions": { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -141817,6 +138943,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -142486,7 +139619,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -142494,7 +139628,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -142620,7 +139755,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -143091,6 +140226,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -145233,6 +142375,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -145425,6 +142574,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -145516,6 +142666,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -170088,7 +167239,31 @@ "used" ] }, - "code_scanning_upload": { + "code_scanning_upload": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "actions_runner_registration": { "title": "Rate Limit", "type": "object", "properties": { @@ -170112,7 +167287,7 @@ "used" ] }, - "actions_runner_registration": { + "scim": { "title": "Rate Limit", "type": "object", "properties": { @@ -170136,7 +167311,7 @@ "used" ] }, - "scim": { + "dependency_snapshots": { "title": "Rate Limit", "type": "object", "properties": { @@ -170160,7 +167335,7 @@ "used" ] }, - "dependency_snapshots": { + "code_scanning_autofix": { "title": "Rate Limit", "type": "object", "properties": { @@ -170283,6 +167458,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -205781,6 +202962,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -462023,6 +459207,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -462895,7 +460086,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -462903,7 +460095,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -463029,7 +460222,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -463500,6 +460693,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -464558,6 +461758,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -465221,7 +462428,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -465229,7 +462437,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -465355,7 +462564,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -465826,6 +463035,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -467176,7 +464392,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -467184,7 +464401,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -467310,7 +464528,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -467781,6 +464999,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -468854,6 +466079,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -469513,7 +466745,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -469521,7 +466754,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -469647,7 +466881,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -470118,6 +467352,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -471724,6 +468965,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -471842,6 +469090,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -471866,6 +469115,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -472410,188 +469660,195 @@ } ] }, - "push_protection_bypassed_at": { + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "push_protection_bypass_request_reviewer_comment": { "type": [ "string", "null" ], - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "push_protection_bypass_request_reviewer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] + "description": "An optional comment when reviewing a push protection bypass." }, "push_protection_bypass_request_comment": { "type": [ @@ -472652,6 +469909,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -473431,6 +470689,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -473509,6 +470774,7 @@ "push_protection_bypassed_by": null, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": "Example comment", @@ -589419,6 +586685,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -1208464,7 +1205733,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1208472,7 +1205742,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1208598,7 +1205869,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -1209069,6 +1206340,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1211670,7 +1208948,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1211678,7 +1208957,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1211804,7 +1209084,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -1212275,6 +1209555,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1214876,7 +1212163,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1214884,7 +1212172,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1215010,7 +1212299,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -1215481,6 +1212770,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1216465,6 +1213761,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1217277,6 +1214580,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1218092,6 +1215402,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1232386,6 +1229703,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1235027,6 +1232351,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1238102,6 +1235433,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1240743,6 +1238081,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1243384,6 +1240729,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1246025,6 +1243377,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 2cff46e55..3e24f41de 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -428,7 +428,7 @@ paths: The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. schema: type: string - - &41 + - &38 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For @@ -437,7 +437,7 @@ paths: required: false schema: type: string - - &42 + - &39 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For @@ -446,7 +446,7 @@ paths: required: false schema: type: string - - &40 + - &37 name: direction description: The direction to sort the results by. in: query @@ -685,7 +685,7 @@ paths: required: - vector_string - score - cvss_severities: &44 + cvss_severities: &41 type: - object - 'null' @@ -888,7 +888,7 @@ paths: - subscriptions_url - type - url - type: &226 + type: &220 type: string description: The type of credit the user is receiving. enum: @@ -1021,7 +1021,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &93 + schema: &87 title: Validation Error Simple description: Validation Error Simple type: object @@ -1054,7 +1054,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &529 + - &528 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1585,7 +1585,7 @@ paths: schema: type: integer default: 30 - - &151 + - &144 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 @@ -1601,7 +1601,7 @@ paths: application/json: schema: type: array - items: &152 + items: &145 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1694,7 +1694,7 @@ paths: - installation_id - repository_id examples: - default: &153 + default: &146 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1757,7 +1757,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &92 + schema: &86 title: Validation Error description: Validation Error type: object @@ -1829,7 +1829,7 @@ paths: description: Response content: application/json: - schema: &154 + schema: &147 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1964,7 +1964,7 @@ paths: - request - response examples: - default: &155 + default: &148 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2024,7 +2024,7 @@ paths: parameters: - *16 responses: - '202': &94 + '202': &88 description: Accepted content: application/json: @@ -2233,7 +2233,7 @@ paths: parameters: - *17 - *18 - - &62 + - &57 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) @@ -2778,7 +2778,7 @@ paths: suspended_at: suspended_by: headers: - Link: &37 + Link: &50 example: ; rel="next", ; rel="last" schema: @@ -2968,7 +2968,7 @@ paths: - selected repositories: type: array - items: &57 + items: &52 title: Repository description: A repository on GitHub. type: object @@ -2995,7 +2995,7 @@ paths: license: anyOf: - type: 'null' - - &73 + - &68 title: License Simple description: License Simple type: object @@ -7219,1189 +7219,6 @@ paths: enabledForGitHubApps: true category: emojis subcategory: emojis - "/enterprises/{enterprise}/copilot/billing/seats": - get: - summary: List all Copilot seat assignments for an enterprise - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. - - Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. - - For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. - Each seat object contains information about the assigned user's most recent Copilot activity. Users must have - telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." - - Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. - - Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/list-copilot-seats-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise - parameters: - - &38 - 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 - - *18 - - name: per_page - description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 50 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - total_seats: - type: integer - description: The total number of Copilot seats the enterprise - is being billed for. Users with access through multiple organizations - or enterprise teams are only counted once. - seats: - type: array - items: &134 - title: Copilot Business Seat Detail - description: Information about a Copilot Business seat assignment - for a user, team, or organization. - type: object - properties: - assignee: *4 - organization: - anyOf: - - type: 'null' - - &88 - title: Organization Simple - description: A GitHub organization. - type: object - properties: - login: - type: string - examples: - - github - id: - type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github - repos_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/events - hooks_url: - type: string - examples: - - https://api.github.com/orgs/github/hooks - issues_url: - type: string - examples: - - https://api.github.com/orgs/github/issues - members_url: - type: string - examples: - - https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - examples: - - https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - examples: - - https://github.com/images/error/octocat_happy.gif - description: - type: - - string - - 'null' - examples: - - A great organization - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - assigning_team: - description: The team through which the assignee is granted - access to GitHub Copilot, if applicable. - oneOf: - - &173 - title: Team - description: Groups of organization members that gives - permissions on specified repositories. - type: object - properties: - id: - type: integer - node_id: - type: string - name: - type: string - slug: - type: string - description: - type: - - string - - 'null' - privacy: - type: string - notification_setting: - type: string - permission: - type: string - permissions: - type: object - properties: - pull: - type: boolean - triage: - type: boolean - push: - type: boolean - maintain: - type: boolean - admin: - type: boolean - required: - - pull - - triage - - push - - maintain - - admin - url: - type: string - format: uri - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/rails/teams/core - members_url: - type: string - repositories_url: - type: string - format: uri - parent: - anyOf: - - type: 'null' - - &187 - title: Team Simple - description: Groups of organization members that - gives permissions on specified repositories. - type: object - properties: - id: - description: Unique identifier of the team - type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDQ6VGVhbTE= - url: - description: URL for the team - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/1 - members_url: - type: string - examples: - - https://api.github.com/organizations/1/team/1/members{/member} - name: - description: Name of the team - type: string - examples: - - Justice League - description: - description: Description of the team - type: - - string - - 'null' - examples: - - A great team. - permission: - description: Permission that the team will have - for its repositories - type: string - examples: - - admin - privacy: - description: The level of privacy this team - should have - type: string - examples: - - closed - notification_setting: - description: The notification setting the team - has set - type: string - examples: - - notifications_enabled - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/rails/teams/core - repositories_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/1/repos - slug: - type: string - examples: - - justice-league - ldap_dn: - description: Distinguished Name (DN) that team - maps to within LDAP environment - type: string - examples: - - uid=example,ou=users,dc=github,dc=com - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - - parent - - title: Enterprise Team - description: Group of enterprise owners and/or members - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - slug: - type: string - url: - type: string - format: uri - sync_to_organizations: - type: string - examples: - - disabled | all - group_id: - type: - - string - - 'null' - examples: - - 62ab9291-fae2-468e-974b-7e45096d5021 - html_url: - type: string - format: uri - examples: - - https://github.com/enterprises/dc/teams/justice-league - members_url: - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - id - - url - - members_url - - sync_to_organizations - - name - - html_url - - slug - - created_at - - updated_at - type: - - 'null' - - object - pending_cancellation_date: - type: - - string - - 'null' - format: date - description: The pending cancellation date for the seat, - in `YYYY-MM-DD` format. This will be null unless the assignee's - Copilot access has been canceled during the current billing - cycle. If the seat has been cancelled, this corresponds - to the start of the organization's next billing cycle. - last_activity_at: - type: - - string - - 'null' - format: date-time - description: Timestamp of user's last GitHub Copilot activity, - in ISO 8601 format. - last_activity_editor: - type: - - string - - 'null' - description: Last editor that was used by the user for a - GitHub Copilot completion. - created_at: - type: string - format: date-time - description: Timestamp of when the assignee was last granted - access to GitHub Copilot, in ISO 8601 format. - updated_at: - type: string - format: date-time - deprecated: true - description: "**Closing down notice:** This field is no - longer relevant and is closing down. Use the `created_at` - field to determine when the assignee was last granted - access to GitHub Copilot. Timestamp of when the assignee's - GitHub Copilot access was last updated, in ISO 8601 format." - plan_type: - type: string - description: The Copilot plan of the organization, or the - parent enterprise, when applicable. - enum: - - business - - enterprise - - unknown - required: - - assignee - - created_at - additionalProperties: false - examples: - default: &135 - value: - total_seats: 2 - seats: - - created_at: '2021-08-03T18:00:00-06:00' - updated_at: '2021-09-23T15:00:00-06:00' - pending_cancellation_date: - last_activity_at: '2021-10-14T00:53:32-06:00' - last_activity_editor: vscode/1.77.3/copilot/1.86.82 - plan_type: business - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assigning_team: - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - - created_at: '2021-09-23T18:00:00-06:00' - updated_at: '2021-09-23T15:00:00-06:00' - pending_cancellation_date: '2021-11-01' - last_activity_at: '2021-10-13T00:53:32-06:00' - last_activity_editor: vscode/1.77.3/copilot/1.86.82 - assignee: - login: octokitten - id: 1 - node_id: MDQ76VNlcjE= - avatar_url: https://github.com/images/error/octokitten_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octokitten - html_url: https://github.com/octokitten - followers_url: https://api.github.com/users/octokitten/followers - following_url: https://api.github.com/users/octokitten/following{/other_user} - gists_url: https://api.github.com/users/octokitten/gists{/gist_id} - starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octokitten/subscriptions - organizations_url: https://api.github.com/users/octokitten/orgs - repos_url: https://api.github.com/users/octokitten/repos - events_url: https://api.github.com/users/octokitten/events{/privacy} - received_events_url: https://api.github.com/users/octokitten/received_events - type: User - site_admin: false - headers: - Link: *37 - '500': &39 - description: Internal Error - content: - application/json: - schema: *3 - '401': *23 - '403': *27 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-user-management - "/enterprises/{enterprise}/copilot/metrics": - get: - summary: Get Copilot metrics for an enterprise - description: |- - Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - - The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - they must have telemetry enabled in their IDE. - - To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - Only enterprise owners and billing managers can view Copilot metrics for the enterprise. - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/copilot-metrics-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise - parameters: - - *38 - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - *18 - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &52 - title: Copilot Usage Metrics - description: Copilot usage metrics for a given day. - type: object - properties: - date: - type: string - format: date - description: The date for which the usage metrics are aggregated, - in `YYYY-MM-DD` format. - total_active_users: - type: integer - description: The total number of Copilot users with activity - belonging to any Copilot feature, globally, for the given - day. Includes passive activity such as receiving a code suggestion, - as well as engagement activity such as accepting a code suggestion - or prompting chat. Does not include authentication events. - Is not limited to the individual features detailed on the - endpoint. - total_engaged_users: - type: integer - description: The total number of Copilot users who engaged with - any Copilot feature, for the given day. Examples include but - are not limited to accepting a code suggestion, prompting - Copilot chat, or triggering a PR Summary. Does not include - authentication events. Is not limited to the individual features - detailed on the endpoint. - copilot_ide_code_completions: - type: - - object - - 'null' - description: Usage metrics for Copilot editor code completions - in the IDE. - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot - code suggestion, across all active editors. Includes both - full and partial acceptances. - languages: - type: array - description: Code completion metrics for active languages. - items: - type: object - description: Usage metrics for a given language for the - given editor for Copilot code completions. - properties: - name: - type: string - description: Name of the language used for Copilot - code completion suggestions. - total_engaged_users: - type: integer - description: Number of users who accepted at least - one Copilot code completion suggestion for the given - language. Includes both full and partial acceptances. - editors: - type: array - items: - type: object - description: Copilot code completion metrics for active - editors. - additionalProperties: true - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted at least - one Copilot code completion suggestion for the given - editor. Includes both full and partial acceptances. - models: - type: array - description: List of model metrics for custom models - and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot - code completion suggestions. If the default - model is used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom - or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom - model. - total_engaged_users: - type: integer - description: Number of users who accepted at - least one Copilot code completion suggestion - for the given editor, for the given language - and model. Includes both full and partial - acceptances. - languages: - type: array - description: Code completion metrics for active - languages, for the given editor. - items: - type: object - description: Usage metrics for a given language - for the given editor for Copilot code completions. - properties: - name: - type: string - description: Name of the language used - for Copilot code completion suggestions, - for the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted - at least one Copilot code completion - suggestion for the given editor, for - the given language. Includes both full - and partial acceptances. - total_code_suggestions: - type: integer - description: The number of Copilot code - suggestions generated for the given - editor, for the given language. - total_code_acceptances: - type: integer - description: The number of Copilot code - suggestions accepted for the given editor, - for the given language. Includes both - full and partial acceptances. - total_code_lines_suggested: - type: integer - description: The number of lines of code - suggested by Copilot code completions - for the given editor, for the given - language. - total_code_lines_accepted: - type: integer - description: The number of lines of code - accepted from Copilot code suggestions - for the given editor, for the given - language. - copilot_ide_chat: - type: - - object - - 'null' - description: Usage metrics for Copilot Chat in the IDE. - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot - Chat in the IDE. - editors: - type: array - items: - type: object - description: Copilot Chat metrics, for active editors. - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: The number of users who prompted Copilot - Chat in the specified editor. - models: - type: array - description: List of model metrics for custom models - and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot - code completion suggestions. If the default - model is used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom - or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom - model. - total_engaged_users: - type: integer - description: The number of users who prompted - Copilot Chat in the given editor and model. - total_chats: - type: integer - description: The total number of chats initiated - by users in the given editor and model. - total_chat_insertion_events: - type: integer - description: The number of times users accepted - a code suggestion from Copilot Chat using - the 'Insert Code' UI element, for the given - editor. - total_chat_copy_events: - type: integer - description: The number of times users copied - a code suggestion from Copilot Chat using - the keyboard, or the 'Copy' UI element, for - the given editor. - copilot_dotcom_chat: - type: - - object - - 'null' - description: Usage metrics for Copilot Chat in github.com - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot - Chat on github.com at least once. - models: - type: array - description: List of model metrics for a custom models and - the default model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot code - completion suggestions. If the default model is - used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or - default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom model - (if applicable). - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot - Chat on github.com at least once for each model. - total_chats: - type: integer - description: Total number of chats initiated by users - on github.com. - copilot_dotcom_pull_requests: - type: - - object - - 'null' - description: Usage metrics for Copilot for pull requests. - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: The number of users who used Copilot for Pull - Requests on github.com to generate a pull request summary - at least once. - repositories: - type: array - description: Repositories in which users used Copilot for - Pull Requests to generate pull request summaries - items: - type: object - properties: - name: - type: string - description: Repository name - total_engaged_users: - type: integer - description: The number of users who generated pull - request summaries using Copilot for Pull Requests - in the given repository. - models: - type: array - description: List of model metrics for custom models - and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot - code completion suggestions. If the default - model is used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom - or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom - model. - total_pr_summaries_created: - type: integer - description: The number of pull request summaries - generated using Copilot for Pull Requests - in the given repository. - total_engaged_users: - type: integer - description: The number of users who generated - pull request summaries using Copilot for Pull - Requests in the given repository and model. - required: - - date - additionalProperties: true - examples: - default: &53 - value: - - date: '2024-06-24' - total_active_users: 24 - total_engaged_users: 20 - copilot_ide_code_completions: - total_engaged_users: 20 - languages: - - name: python - total_engaged_users: 10 - - name: ruby - total_engaged_users: 10 - editors: - - name: vscode - total_engaged_users: 13 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 13 - languages: - - name: python - total_engaged_users: 6 - total_code_suggestions: 249 - total_code_acceptances: 123 - total_code_lines_suggested: 225 - total_code_lines_accepted: 135 - - name: ruby - total_engaged_users: 7 - total_code_suggestions: 496 - total_code_acceptances: 253 - total_code_lines_suggested: 520 - total_code_lines_accepted: 270 - - name: neovim - total_engaged_users: 7 - models: - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - languages: - - name: typescript - total_engaged_users: 3 - total_code_suggestions: 112 - total_code_acceptances: 56 - total_code_lines_suggested: 143 - total_code_lines_accepted: 61 - - name: go - total_engaged_users: 4 - total_code_suggestions: 132 - total_code_acceptances: 67 - total_code_lines_suggested: 154 - total_code_lines_accepted: 72 - copilot_ide_chat: - total_engaged_users: 13 - editors: - - name: vscode - total_engaged_users: 13 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 12 - total_chats: 45 - total_chat_insertion_events: 12 - total_chat_copy_events: 16 - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - total_engaged_users: 1 - total_chats: 10 - total_chat_insertion_events: 11 - total_chat_copy_events: 3 - copilot_dotcom_chat: - total_engaged_users: 14 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 14 - total_chats: 38 - copilot_dotcom_pull_requests: - total_engaged_users: 12 - repositories: - - name: demo/repo1 - total_engaged_users: 8 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_pr_summaries_created: 6 - total_engaged_users: 8 - - name: demo/repo2 - total_engaged_users: 4 - models: - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - total_pr_summaries_created: 10 - total_engaged_users: 4 - '500': *39 - '403': *27 - '404': *6 - '422': &54 - description: Copilot Usage Merics API setting is disabled at the organization - or enterprise level. - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-metrics - "/enterprises/{enterprise}/copilot/usage": - get: - summary: Get a summary of Copilot usage for enterprise members - 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 all users across organizations with access to Copilot within your enterprise, 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. - - The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. - - Only owners and billing managers can view Copilot usage 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/usage-metrics-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-enterprise-members - parameters: - - *38 - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - *18 - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &55 - title: Copilot Usage Metrics - description: Summary of Copilot usage. - type: object - properties: - day: - type: string - format: date - description: The date for which the usage metrics are reported, - in `YYYY-MM-DD` format. - total_suggestions_count: - type: integer - description: The total number of Copilot code completion suggestions - shown to users. - total_acceptances_count: - type: integer - description: The total number of Copilot code completion suggestions - accepted by users. - total_lines_suggested: - type: integer - description: The total number of lines of code completions suggested - by Copilot. - total_lines_accepted: - type: integer - description: The total number of lines of code completions accepted - by users. - total_active_users: - type: integer - description: The total number of users who were shown Copilot - code completion suggestions during the day specified. - total_chat_acceptances: - type: integer - description: The total instances of users who accepted code - suggested by Copilot Chat in the IDE (panel and inline). - total_chat_turns: - type: integer - description: The total number of chat turns (prompt and response - pairs) sent between users and Copilot Chat in the IDE. - total_active_chat_users: - type: integer - description: The total number of users who interacted with Copilot - Chat in the IDE during the day specified. - breakdown: - type: - - array - - 'null' - description: Breakdown of Copilot code completions usage by - language and editor - items: - type: object - description: Breakdown of Copilot usage by editor for this - language - additionalProperties: true - properties: - language: - type: string - description: The language in which Copilot suggestions - were shown to users in the specified editor. - editor: - type: string - description: The editor in which Copilot suggestions were - shown to users for the specified language. - suggestions_count: - type: integer - description: The number of Copilot suggestions shown to - users in the editor specified during the day specified. - acceptances_count: - type: integer - description: The number of Copilot suggestions accepted - by users in the editor specified during the day specified. - lines_suggested: - type: integer - description: The number of lines of code suggested by - Copilot in the editor specified during the day specified. - lines_accepted: - type: integer - description: The number of lines of code accepted by users - in the editor specified during the day specified. - active_users: - type: integer - description: The number of users who were shown Copilot - completion suggestions in the editor specified during - the day specified. - required: - - day - - breakdown - additionalProperties: false - examples: - default: - value: - - day: '2023-10-15' - total_suggestions_count: 5000 - total_acceptances_count: 3000 - total_lines_suggested: 7000 - total_lines_accepted: 3500 - total_active_users: 15 - total_chat_acceptances: 45 - total_chat_turns: 350 - total_active_chat_users: 8 - breakdown: - - language: python - editor: vscode - suggestions_count: 3000 - acceptances_count: 2000 - lines_suggested: 3000 - lines_accepted: 1500 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 1000 - acceptances_count: 500 - lines_suggested: 2000 - lines_accepted: 1000 - active_users: 5 - - language: javascript - editor: vscode - suggestions_count: 1000 - acceptances_count: 500 - lines_suggested: 2000 - lines_accepted: 1000 - active_users: 5 - - day: '2023-10-16' - total_suggestions_count: 5200 - total_acceptances_count: 5100 - total_lines_suggested: 5300 - total_lines_accepted: 5000 - total_active_users: 15 - total_chat_acceptances: 57 - total_chat_turns: 455 - total_active_chat_users: 12 - breakdown: - - language: python - editor: vscode - suggestions_count: 3100 - acceptances_count: 3000 - lines_suggested: 3200 - lines_accepted: 3100 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 1100 - acceptances_count: 1000 - lines_suggested: 1200 - lines_accepted: 1100 - active_users: 5 - - language: javascript - editor: vscode - suggestions_count: 1000 - acceptances_count: 900 - lines_suggested: 1100 - lines_accepted: 1000 - active_users: 5 - '500': *39 - '401': *23 - '403': *27 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise @@ -8420,8 +7237,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - - *38 - - &137 + - &43 + 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 + - &130 name: state in: query description: |- @@ -8430,7 +7254,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &138 + - &131 name: severity in: query description: |- @@ -8439,7 +7263,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &139 + - &132 name: ecosystem in: query description: |- @@ -8448,14 +7272,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &140 + - &133 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 - - &141 + - &134 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -8465,7 +7289,7 @@ paths: enum: - development - runtime - - &142 + - &135 name: sort in: query description: |- @@ -8478,10 +7302,10 @@ paths: - created - updated default: created - - *40 - - *41 - - *42 - - &143 + - *37 + - *38 + - *39 + - &136 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -8494,7 +7318,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &144 + - &137 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -8514,11 +7338,11 @@ paths: application/json: schema: type: array - items: &145 + items: &138 type: object description: A Dependabot alert. properties: - number: &46 + number: &44 type: integer description: The security alert number. readOnly: true @@ -8536,7 +7360,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: &43 + package: &40 type: object description: Details for the vulnerable package. readOnly: true @@ -8569,7 +7393,7 @@ paths: - development - runtime - - security_advisory: &383 + security_advisory: &382 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -8600,13 +7424,13 @@ paths: description: Vulnerable version range information for the advisory. readOnly: true - items: &45 + items: &42 type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: - package: *43 + package: *40 severity: type: string description: The severity of the vulnerability. @@ -8674,7 +7498,7 @@ paths: - score - vector_string additionalProperties: false - cvss_severities: *44 + cvss_severities: *41 cwes: type: array description: Details for the advisory pertaining to Common @@ -8774,30 +7598,30 @@ paths: - updated_at - withdrawn_at additionalProperties: false - security_vulnerability: *45 - url: &49 + security_vulnerability: *42 + url: &47 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &50 + html_url: &48 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &47 + created_at: &45 type: string description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &48 + updated_at: &46 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: &123 + dismissed_at: &117 type: - string - 'null' @@ -8828,7 +7652,7 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: &122 + fixed_at: &116 type: - string - 'null' @@ -8836,7 +7660,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &384 + auto_dismissed_at: &383 type: - string - 'null' @@ -8844,7 +7668,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - repository: &51 + repository: &49 title: Simple Repository description: A GitHub repository. type: object @@ -9184,7 +8008,7 @@ paths: - repository additionalProperties: false examples: - default: &146 + default: &139 value: - number: 2 state: dismissed @@ -9527,8 +8351,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - - *38 - - &217 + - *43 + - &211 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -9539,7 +8363,7 @@ paths: enum: - open - resolved - - &218 + - &212 name: secret_type in: query description: |- @@ -9549,7 +8373,7 @@ paths: required: false schema: type: string - - &219 + - &213 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -9558,7 +8382,7 @@ paths: required: false schema: type: string - - &220 + - &214 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. @@ -9570,11 +8394,11 @@ paths: - created - updated default: created - - *40 + - *37 - *17 - - *41 - - *42 - - &221 + - *38 + - *39 + - &215 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -9583,7 +8407,7 @@ paths: required: false schema: type: string - - &222 + - &216 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -9592,7 +8416,7 @@ paths: schema: type: boolean default: false - - &223 + - &217 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -9608,30 +8432,30 @@ paths: application/json: schema: type: array - items: &224 + items: &218 type: object properties: - number: *46 - created_at: *47 + number: *44 + created_at: *45 updated_at: anyOf: - type: 'null' - - *48 - url: *49 - html_url: *50 + - *46 + url: *47 + html_url: *48 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &521 + state: &520 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: &522 + resolution: &521 type: - string - 'null' @@ -9665,7 +8489,7 @@ paths: secret: type: string description: The secret that was detected. - repository: *51 + repository: *49 push_protection_bypassed: type: - boolean @@ -9687,6 +8511,12 @@ paths: anyOf: - type: 'null' - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. push_protection_bypass_request_comment: type: - string @@ -9724,7 +8554,7 @@ paths: description: Whether the detected secret was found in multiple repositories in the same organization or enterprise. examples: - default: &225 + default: &219 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -9861,6 +8691,7 @@ paths: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true + push_protection_bypass_request_reviewer_comment: Example response push_protection_bypass_request_comment: Example comment push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment @@ -9948,6 +8779,7 @@ paths: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -9955,9 +8787,9 @@ paths: publicly_leaked: false multi_repo: false headers: - Link: *37 + Link: *50 '404': *6 - '503': &60 + '503': &55 description: Service unavailable content: application/json: @@ -9975,225 +8807,6 @@ 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: |- - > [!NOTE] - > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." - - Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - - The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - they must have telemetry enabled in their IDE. - - > [!NOTE] - > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. - - To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/copilot-metrics-for-enterprise-team - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team - parameters: - - *38 - - name: team_slug - description: The slug of the enterprise team name. - in: path - required: true - schema: - type: string - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - *18 - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *52 - examples: - default: *53 - '500': *39 - '403': *27 - '404': *6 - '422': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-metrics - "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": - get: - summary: Get a summary of Copilot usage for an enterprise team - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." - - 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 an enterprise 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 enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. - - Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage 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/usage-metrics-for-enterprise-team - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team - parameters: - - *38 - - &184 - 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 - - *18 - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *55 - examples: - default: &136 - value: - - day: '2023-10-15' - total_suggestions_count: 1000 - total_acceptances_count: 800 - total_lines_suggested: 1800 - total_lines_accepted: 1200 - total_active_users: 10 - total_chat_acceptances: 32 - total_chat_turns: 200 - total_active_chat_users: 4 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 250 - lines_suggested: 900 - lines_accepted: 700 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 400 - lines_accepted: 300 - active_users: 2 - - language: ruby - editor: vscode - suggestions_count: 400 - acceptances_count: 350 - lines_suggested: 500 - lines_accepted: 200 - active_users: 3 - - day: '2023-10-16' - total_suggestions_count: 800 - total_acceptances_count: 600 - total_lines_suggested: 1100 - total_lines_accepted: 700 - total_active_users: 12 - total_chat_acceptances: 57 - total_chat_turns: 426 - total_active_chat_users: 8 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 600 - lines_accepted: 300 - active_users: 2 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 150 - lines_suggested: 300 - lines_accepted: 250 - active_users: 6 - - language: ruby - editor: vscode - suggestions_count: 200 - acceptances_count: 150 - lines_suggested: 200 - lines_accepted: 150 - active_users: 3 - '500': *39 - '401': *23 - '403': *27 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage "/events": get: summary: List public events @@ -10216,7 +8829,7 @@ paths: application/json: schema: type: array - items: &83 + items: &78 title: Event description: Event type: object @@ -10227,7 +8840,7 @@ paths: type: - string - 'null' - actor: &56 + actor: &51 title: Actor description: Actor type: object @@ -10268,13 +8881,13 @@ paths: - id - name - url - org: *56 + org: *51 payload: type: object properties: action: type: string - issue: &72 + issue: &67 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -10394,7 +9007,7 @@ paths: milestone: anyOf: - type: 'null' - - &371 + - &370 title: Milestone description: A collection of related issues and pull requests. @@ -10566,12 +9179,12 @@ paths: timeline_url: type: string format: uri - repository: *57 + repository: *52 performed_via_github_app: anyOf: - type: 'null' - *5 - author_association: &58 + author_association: &53 title: author_association type: string description: How the author is associated with the repository. @@ -10586,7 +9199,7 @@ paths: - OWNER examples: - OWNER - reactions: &59 + reactions: &54 title: Reaction Rollup type: object properties: @@ -10658,7 +9271,7 @@ paths: - author_association - created_at - updated_at - comment: &430 + comment: &429 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -10708,12 +9321,12 @@ paths: issue_url: type: string format: uri - author_association: *58 + author_association: *53 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *59 + reactions: *54 required: - id - node_id @@ -10810,7 +9423,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *35 '403': *27 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -10900,7 +9513,7 @@ paths: _links: type: object properties: - timeline: &61 + timeline: &56 title: Link With Type description: Hypermedia Link with Type type: object @@ -10912,17 +9525,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: *56 + security_advisories: *56 + current_user: *56 + current_user_public: *56 + current_user_actor: *56 + current_user_organization: *56 current_user_organizations: type: array - items: *61 - repository_discussions: *61 - repository_discussions_category: *61 + items: *56 + repository_discussions: *56 + repository_discussions_category: *56 required: - timeline - user @@ -10984,7 +9597,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *62 + - *57 - *17 - *18 responses: @@ -10994,7 +9607,7 @@ paths: application/json: schema: type: array - items: &63 + items: &58 title: Base Gist description: Base Gist type: object @@ -11089,7 +9702,7 @@ paths: - created_at - updated_at examples: - default: &64 + default: &59 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -11134,7 +9747,7 @@ paths: site_admin: false truncated: false headers: - Link: *37 + Link: *50 '304': *35 '403': *27 x-github: @@ -11213,7 +9826,7 @@ paths: description: Response content: application/json: - schema: &65 + schema: &60 title: Gist Simple description: Gist Simple type: object @@ -11231,7 +9844,7 @@ paths: url: type: string format: uri - user: &552 + user: &551 title: Public User description: Public User type: object @@ -11601,7 +10214,7 @@ paths: truncated: type: boolean examples: - default: &66 + default: &61 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -11704,7 +10317,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *62 + - *57 - *17 - *18 responses: @@ -11714,11 +10327,11 @@ paths: application/json: schema: type: array - items: *63 + items: *58 examples: - default: *64 + default: *59 headers: - Link: *37 + Link: *50 '422': *15 '304': *35 '403': *27 @@ -11738,7 +10351,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *62 + - *57 - *17 - *18 responses: @@ -11748,11 +10361,11 @@ paths: application/json: schema: type: array - items: *63 + items: *58 examples: - default: *64 + default: *59 headers: - Link: *37 + Link: *50 '401': *23 '304': *35 '403': *27 @@ -11778,7 +10391,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &67 + - &62 name: gist_id description: The unique identifier of the gist. in: path @@ -11790,10 +10403,10 @@ paths: description: Response content: application/json: - schema: *65 + schema: *60 examples: - default: *66 - '403': &70 + default: *61 + '403': &65 description: Forbidden Gist content: application/json: @@ -11842,7 +10455,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *67 + - *62 requestBody: required: true content: @@ -11906,9 +10519,9 @@ paths: description: Response content: application/json: - schema: *65 + schema: *60 examples: - updateGist: *66 + updateGist: *61 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -12066,7 +10679,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *67 + - *62 responses: '204': description: Response @@ -12095,7 +10708,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *67 + - *62 - *17 - *18 responses: @@ -12105,7 +10718,7 @@ paths: application/json: schema: type: array - items: &68 + items: &63 title: Gist Comment description: A comment made to a gist. type: object @@ -12143,7 +10756,7 @@ paths: format: date-time examples: - '2011-04-18T23:23:56Z' - author_association: *58 + author_association: *53 required: - url - id @@ -12183,7 +10796,7 @@ paths: updated_at: '2011-04-18T23:23:56Z' author_association: COLLABORATOR headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -12208,7 +10821,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *67 + - *62 requestBody: required: true content: @@ -12234,9 +10847,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *63 examples: - default: &69 + default: &64 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -12294,8 +10907,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *67 - - &71 + - *62 + - &66 name: comment_id description: The unique identifier of the comment. in: path @@ -12308,12 +10921,12 @@ paths: description: Response content: application/json: - schema: *68 + schema: *63 examples: - default: *69 + default: *64 '304': *35 '404': *6 - '403': *70 + '403': *65 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12335,8 +10948,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *67 - - *71 + - *62 + - *66 requestBody: required: true content: @@ -12362,9 +10975,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *63 examples: - default: *69 + default: *64 '404': *6 x-github: githubCloudOnly: false @@ -12381,8 +10994,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *67 - - *71 + - *62 + - *66 responses: '204': description: Response @@ -12405,7 +11018,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *67 + - *62 - *17 - *18 responses: @@ -12506,7 +11119,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *67 + - *62 - *17 - *18 responses: @@ -12516,7 +11129,7 @@ paths: application/json: schema: type: array - items: *65 + items: *60 examples: default: value: @@ -12562,7 +11175,7 @@ paths: type: User site_admin: false headers: - Link: *37 + Link: *50 '404': *6 '304': *35 '403': *27 @@ -12581,13 +11194,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *67 + - *62 responses: '201': description: Response content: application/json: - schema: *63 + schema: *58 examples: default: value: @@ -12658,7 +11271,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *67 + - *62 responses: '204': description: Response if gist is starred @@ -12688,7 +11301,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *67 + - *62 responses: '204': description: Response @@ -12710,7 +11323,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *67 + - *62 responses: '204': description: Response @@ -12739,7 +11352,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *67 + - *62 - name: sha in: path required: true @@ -12750,9 +11363,9 @@ paths: description: Response content: application/json: - schema: *65 + schema: *60 examples: - default: *66 + default: *61 '422': *15 '404': *6 '403': *27 @@ -12913,7 +11526,7 @@ paths: type: integer repositories: type: array - items: *57 + items: *52 repository_selection: type: string examples: @@ -13037,7 +11650,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *37 + Link: *50 '403': *27 '304': *35 '401': *23 @@ -13121,7 +11734,7 @@ paths: - closed - all default: open - - &174 + - &167 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -13139,8 +11752,8 @@ paths: - updated - comments default: created - - *40 - - *62 + - *37 + - *57 - name: collab in: query required: false @@ -13170,9 +11783,9 @@ paths: application/json: schema: type: array - items: *72 + items: *67 examples: - default: &175 + default: &168 value: - id: 1 node_id: MDU6SXNzdWUx @@ -13417,7 +12030,7 @@ paths: watchers: 1 author_association: COLLABORATOR headers: - Link: *37 + Link: *50 '422': *15 '304': *35 '404': *6 @@ -13452,7 +12065,7 @@ paths: application/json: schema: type: array - items: *73 + items: *68 examples: default: value: @@ -13749,7 +12362,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &74 + X-CommonMarker-Version: &69 example: 0.17.4 schema: type: string @@ -13804,7 +12417,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *74 + X-CommonMarker-Version: *69 content: text/html: schema: @@ -13833,7 +12446,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &77 + - &72 name: account_id description: account_id parameter in: path @@ -13845,7 +12458,7 @@ paths: description: Response content: application/json: - schema: &76 + schema: &71 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -13879,7 +12492,7 @@ paths: - 'null' id: type: integer - plan: &75 + plan: &70 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -13982,7 +12595,7 @@ paths: - 'null' updated_at: type: string - plan: *75 + plan: *70 required: - url - id @@ -13990,7 +12603,7 @@ paths: - login - marketplace_purchase examples: - default: &78 + default: &73 value: url: https://api.github.com/orgs/github type: Organization @@ -14075,9 +12688,9 @@ paths: application/json: schema: type: array - items: *75 + items: *70 examples: - default: &79 + default: &74 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -14095,7 +12708,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *37 + Link: *50 '404': *6 '401': *23 x-github: @@ -14117,14 +12730,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &80 + - &75 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &81 + - &76 name: sort description: The property to sort the results by. in: query @@ -14154,9 +12767,9 @@ paths: application/json: schema: type: array - items: *76 + items: *71 examples: - default: &82 + default: &77 value: - url: https://api.github.com/orgs/github type: Organization @@ -14207,7 +12820,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *37 + Link: *50 '404': *6 '422': *15 '401': *23 @@ -14230,15 +12843,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *77 + - *72 responses: '200': description: Response content: application/json: - schema: *76 + schema: *71 examples: - default: *78 + default: *73 '404': description: Not Found when the account has not purchased the listing '401': *23 @@ -14270,11 +12883,11 @@ paths: application/json: schema: type: array - items: *75 + items: *70 examples: - default: *79 + default: *74 headers: - Link: *37 + Link: *50 '401': *23 x-github: githubCloudOnly: false @@ -14295,8 +12908,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *80 - - *81 + - *75 + - *76 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -14316,11 +12929,11 @@ paths: application/json: schema: type: array - items: *76 + items: *71 examples: - default: *82 + default: *77 headers: - Link: *37 + Link: *50 '401': *23 x-github: githubCloudOnly: false @@ -14568,14 +13181,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &242 + - &241 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &243 + - &242 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -14592,7 +13205,7 @@ paths: application/json: schema: type: array - items: *83 + items: *78 examples: default: value: @@ -14646,7 +13259,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &254 + '301': &253 description: Moved permanently content: application/json: @@ -14668,7 +13281,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &459 + - &458 name: all description: If `true`, show notifications marked as read. in: query @@ -14676,7 +13289,7 @@ paths: schema: type: boolean default: false - - &460 + - &459 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -14685,8 +13298,8 @@ paths: schema: type: boolean default: false - - *62 - - &461 + - *57 + - &460 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: @@ -14711,14 +13324,14 @@ paths: application/json: schema: type: array - items: &84 + items: &79 title: Thread description: Thread type: object properties: id: type: string - repository: &108 + repository: &102 title: Minimal Repository description: Minimal Repository type: object @@ -15057,7 +13670,7 @@ paths: type: boolean examples: - false - security_and_analysis: &208 + security_and_analysis: &202 type: - object - 'null' @@ -15204,7 +13817,7 @@ paths: - url - subscription_url examples: - default: &462 + default: &461 value: - id: '1' repository: @@ -15286,7 +13899,7 @@ paths: url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -15370,7 +13983,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &85 + - &80 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 @@ -15384,7 +13997,7 @@ paths: description: Response content: application/json: - schema: *84 + schema: *79 examples: default: value: @@ -15486,7 +14099,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *85 + - *80 responses: '205': description: Reset Content @@ -15508,7 +14121,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *85 + - *80 responses: '204': description: No content @@ -15531,13 +14144,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *85 + - *80 responses: '200': description: Response content: application/json: - schema: &86 + schema: &81 title: Thread Subscription description: Thread Subscription type: object @@ -15581,7 +14194,7 @@ paths: - url - subscribed examples: - default: &87 + default: &82 value: subscribed: true ignored: false @@ -15612,7 +14225,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *85 + - *80 requestBody: required: false content: @@ -15633,9 +14246,9 @@ paths: description: Response content: application/json: - schema: *86 + schema: *81 examples: - default: *87 + default: *82 '304': *35 '403': *27 '401': *23 @@ -15658,7 +14271,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *85 + - *80 responses: '204': description: Response @@ -15753,9 +14366,79 @@ paths: application/json: schema: type: array - items: *88 + items: &129 + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description examples: - default: &569 + default: &568 value: - login: github id: 1 @@ -15794,7 +14477,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - &89 + - &83 name: org description: The organization name. The name is not case sensitive. in: path @@ -15904,8 +14587,12 @@ paths: repositoryName: github/example '400': *14 '403': *27 - '500': *39 - '503': *60 + '500': &127 + description: Internal Error + content: + application/json: + schema: *3 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15931,13 +14618,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &90 + schema: &84 title: Organization Full description: Organization Full type: object @@ -16292,7 +14979,7 @@ paths: - updated_at - archived_at examples: - default-response: &91 + default-response: &85 value: login: github id: 1 @@ -16383,7 +15070,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *89 + - *83 requestBody: required: false content: @@ -16600,18 +15287,18 @@ paths: description: Response content: application/json: - schema: *90 + schema: *84 examples: - default: *91 + default: *85 '422': description: Validation failed content: application/json: schema: oneOf: - - *92 - - *93 - '409': &128 + - *86 + - *87 + '409': &122 description: Conflict content: application/json: @@ -16638,9 +15325,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *89 + - *83 responses: - '202': *94 + '202': *88 '404': *6 '403': *27 x-github: @@ -16663,7 +15350,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response @@ -16689,7 +15376,7 @@ paths: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16710,7 +15397,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: - - *89 + - *83 - *17 - *18 responses: @@ -16728,7 +15415,7 @@ paths: type: integer repository_cache_usages: type: array - items: &259 + items: &258 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -16766,7 +15453,7 @@ paths: active_caches_size_in_bytes: 1022142 active_caches_count: 2 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16786,13 +15473,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: - - *89 + - *83 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &95 + schema: &89 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -16806,7 +15493,7 @@ paths: required: - include_claim_keys examples: - default: &96 + default: &90 value: include_claim_keys: - repo @@ -16828,20 +15515,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: - - *89 + - *83 requestBody: required: true content: application/json: - schema: *95 + schema: *89 examples: - default: *96 + default: *90 responses: '201': description: Empty response content: application/json: - schema: &117 + schema: &111 title: Empty Object description: An object without any properties. type: object @@ -16871,7 +15558,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response @@ -16880,7 +15567,7 @@ paths: schema: type: object properties: - enabled_repositories: &97 + enabled_repositories: &91 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -16893,7 +15580,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: &98 + allowed_actions: &92 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -16901,7 +15588,7 @@ paths: - all - local_only - selected - selected_actions_url: &265 + selected_actions_url: &264 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` @@ -16932,7 +15619,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *89 + - *83 responses: '204': description: Response @@ -16943,8 +15630,8 @@ paths: schema: type: object properties: - enabled_repositories: *97 - allowed_actions: *98 + enabled_repositories: *91 + allowed_actions: *92 required: - enabled_repositories examples: @@ -16971,7 +15658,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: - - *89 + - *83 - *17 - *18 responses: @@ -16989,9 +15676,9 @@ paths: type: number repositories: type: array - items: *57 + items: *52 examples: - default: &563 + default: &562 value: total_count: 1 repositories: @@ -17131,7 +15818,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: - - *89 + - *83 responses: '204': description: Response @@ -17175,8 +15862,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: - - *89 - - &99 + - *83 + - &93 name: repository_id description: The unique identifier of the repository. in: path @@ -17204,8 +15891,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: - - *89 - - *99 + - *83 + - *93 responses: '204': description: Response @@ -17228,13 +15915,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &100 + schema: &94 type: object properties: github_owned_allowed: @@ -17256,7 +15943,7 @@ paths: items: type: string examples: - default: &101 + default: &95 value: github_owned_allowed: true verified_allowed: false @@ -17281,7 +15968,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *89 + - *83 responses: '204': description: Response @@ -17289,9 +15976,9 @@ paths: required: false content: application/json: - schema: *100 + schema: *94 examples: - selected_actions: *101 + selected_actions: *95 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -17313,23 +16000,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &269 + schema: &268 type: object properties: - default_workflow_permissions: &102 + default_workflow_permissions: &96 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &103 + can_approve_pull_request_reviews: &97 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -17337,7 +16024,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &104 + default: &98 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -17362,7 +16049,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *89 + - *83 responses: '204': description: Success response @@ -17370,13 +16057,13 @@ paths: required: false content: application/json: - schema: &270 + schema: &269 type: object properties: - default_workflow_permissions: *102 - can_approve_pull_request_reviews: *103 + default_workflow_permissions: *96 + can_approve_pull_request_reviews: *97 examples: - default: *104 + default: *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17396,7 +16083,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: - - *89 + - *83 - *17 - *18 - name: visible_to_repository @@ -17421,7 +16108,7 @@ paths: type: number runner_groups: type: array - items: &105 + items: &99 type: object properties: id: @@ -17534,7 +16221,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: - - *89 + - *83 requestBody: required: true content: @@ -17604,9 +16291,9 @@ paths: description: Response content: application/json: - schema: *105 + schema: *99 examples: - default: &107 + default: &101 value: id: 2 name: octo-runner-group @@ -17641,8 +16328,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: - - *89 - - &106 + - *83 + - &100 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -17654,7 +16341,7 @@ paths: description: Response content: application/json: - schema: *105 + schema: *99 examples: default: value: @@ -17690,8 +16377,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: - - *89 - - *106 + - *83 + - *100 requestBody: required: true content: @@ -17742,9 +16429,9 @@ paths: description: Response content: application/json: - schema: *105 + schema: *99 examples: - default: *107 + default: *101 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -17763,8 +16450,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: - - *89 - - *106 + - *83 + - *100 responses: '204': description: Response @@ -17787,8 +16474,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: - - *89 - - *106 + - *83 + - *100 - *18 - *17 responses: @@ -17806,9 +16493,9 @@ paths: type: number repositories: type: array - items: *108 + items: *102 examples: - default: &555 + default: &554 value: total_count: 1 repositories: @@ -18060,8 +16747,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: - - *89 - - *106 + - *83 + - *100 requestBody: required: true content: @@ -18105,9 +16792,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: - - *89 - - *106 - - *99 + - *83 + - *100 + - *93 responses: '204': description: Response @@ -18129,9 +16816,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: - - *89 - - *106 - - *99 + - *83 + - *100 + - *93 responses: '204': description: Response @@ -18154,8 +16841,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: - - *89 - - *106 + - *83 + - *100 - *17 - *18 responses: @@ -18173,7 +16860,7 @@ paths: type: number runners: type: array - items: &110 + items: &104 title: Self hosted runners description: A self hosted runner type: object @@ -18207,7 +16894,7 @@ paths: type: boolean labels: type: array - items: &113 + items: &107 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -18235,7 +16922,7 @@ paths: - busy - labels examples: - default: &111 + default: &105 value: total_count: 2 runners: @@ -18273,7 +16960,7 @@ paths: name: no-gpu type: custom headers: - Link: *37 + Link: *50 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18292,8 +16979,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: - - *89 - - *106 + - *83 + - *100 requestBody: required: true content: @@ -18337,9 +17024,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: - - *89 - - *106 - - &109 + - *83 + - *100 + - &103 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -18367,9 +17054,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: - - *89 - - *106 - - *109 + - *83 + - *100 + - *103 responses: '204': description: Response @@ -18399,7 +17086,7 @@ paths: in: query schema: type: string - - *89 + - *83 - *17 - *18 responses: @@ -18417,11 +17104,11 @@ paths: type: integer runners: type: array - items: *110 + items: *104 examples: - default: *111 + default: *105 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18443,7 +17130,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response @@ -18451,7 +17138,7 @@ paths: application/json: schema: type: array - items: &271 + items: &270 title: Runner Application description: Runner Application type: object @@ -18476,7 +17163,7 @@ paths: - download_url - filename examples: - default: &272 + default: &271 value: - os: osx architecture: x64 @@ -18519,7 +17206,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: - - *89 + - *83 requestBody: required: true content: @@ -18562,7 +17249,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &273 + '201': &272 description: Response content: application/json: @@ -18572,7 +17259,7 @@ paths: - runner - encoded_jit_config properties: - runner: *110 + runner: *104 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -18628,13 +17315,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *89 + - *83 responses: '201': description: Response content: application/json: - schema: &112 + schema: &106 title: Authentication Token description: Authentication Token type: object @@ -18658,7 +17345,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *57 + items: *52 single_file: type: - string @@ -18676,7 +17363,7 @@ paths: - token - expires_at examples: - default: &274 + default: &273 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -18707,15 +17394,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *89 + - *83 responses: '201': description: Response content: application/json: - schema: *112 + schema: *106 examples: - default: &275 + default: &274 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -18740,16 +17427,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: - - *89 - - *109 + - *83 + - *103 responses: '200': description: Response content: application/json: - schema: *110 + schema: *104 examples: - default: &276 + default: &275 value: id: 23 name: MBP @@ -18789,8 +17476,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: - - *89 - - *109 + - *83 + - *103 responses: '204': description: Response @@ -18815,10 +17502,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: - - *89 - - *109 + - *83 + - *103 responses: - '200': &114 + '200': &108 description: Response content: application/json: @@ -18832,7 +17519,7 @@ paths: type: integer labels: type: array - items: *113 + items: *107 examples: default: value: @@ -18871,8 +17558,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: - - *89 - - *109 + - *83 + - *103 requestBody: required: true content: @@ -18896,7 +17583,7 @@ paths: - gpu - accelerated responses: - '200': *114 + '200': *108 '404': *6 '422': *7 x-github: @@ -18920,8 +17607,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: - - *89 - - *109 + - *83 + - *103 requestBody: required: true content: @@ -18946,7 +17633,7 @@ paths: - gpu - accelerated responses: - '200': *114 + '200': *108 '404': *6 '422': *7 x-github: @@ -18970,10 +17657,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: - - *89 - - *109 + - *83 + - *103 responses: - '200': &277 + '200': &276 description: Response content: application/json: @@ -18987,7 +17674,7 @@ paths: type: integer labels: type: array - items: *113 + items: *107 examples: default: value: @@ -19028,9 +17715,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: - - *89 - - *109 - - &278 + - *83 + - *103 + - &277 name: name description: The name of a self-hosted runner's custom label. in: path @@ -19038,7 +17725,7 @@ paths: schema: type: string responses: - '200': *114 + '200': *108 '404': *6 '422': *7 x-github: @@ -19063,7 +17750,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *89 + - *83 - *17 - *18 responses: @@ -19081,7 +17768,7 @@ paths: type: integer secrets: type: array - items: &115 + items: &109 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -19133,7 +17820,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19156,13 +17843,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &290 + schema: &289 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -19197,7 +17884,7 @@ paths: - key_id - key examples: - default: &291 + default: &290 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -19222,8 +17909,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *89 - - &116 + - *83 + - &110 name: secret_name description: The name of the secret. in: path @@ -19235,7 +17922,7 @@ paths: description: Response content: application/json: - schema: *115 + schema: *109 examples: default: value: @@ -19265,8 +17952,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 requestBody: required: true content: @@ -19321,7 +18008,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -19347,8 +18034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 responses: '204': description: Response @@ -19374,8 +18061,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - *18 - *17 responses: @@ -19393,9 +18080,9 @@ paths: type: integer repositories: type: array - items: *108 + items: *102 examples: - default: &120 + default: &114 value: total_count: 1 repositories: @@ -19487,8 +18174,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 requestBody: required: true content: @@ -19540,8 +18227,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - name: repository_id in: path required: true @@ -19574,8 +18261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - name: repository_id in: path required: true @@ -19607,8 +18294,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *89 - - &264 + - *83 + - &263 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)." @@ -19632,7 +18319,7 @@ paths: type: integer variables: type: array - items: &118 + items: &112 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -19701,7 +18388,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19722,7 +18409,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *89 + - *83 requestBody: required: true content: @@ -19770,7 +18457,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -19795,8 +18482,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *89 - - &119 + - *83 + - &113 name: name description: The name of the variable. in: path @@ -19808,7 +18495,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *112 examples: default: value: @@ -19838,8 +18525,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *89 - - *119 + - *83 + - *113 requestBody: required: true content: @@ -19901,8 +18588,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *89 - - *119 + - *83 + - *113 responses: '204': description: Response @@ -19928,8 +18615,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *89 - - *119 + - *83 + - *113 - *18 - *17 responses: @@ -19947,9 +18634,9 @@ paths: type: integer repositories: type: array - items: *108 + items: *102 examples: - default: *120 + default: *114 '409': description: Response when the visibility of the variable is not set to `selected` @@ -19975,8 +18662,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *89 - - *119 + - *83 + - *113 requestBody: required: true content: @@ -20025,8 +18712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *89 - - *119 + - *83 + - *113 - name: repository_id in: path required: true @@ -20060,8 +18747,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *89 - - *119 + - *83 + - *113 - name: repository_id in: path required: true @@ -20095,9 +18782,9 @@ paths: url: https://docs.github.com/rest/orgs/orgs#list-attestations parameters: - *17 - - *41 - - *42 - - *89 + - *38 + - *39 + - *83 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -20137,8 +18824,10 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: - default: &304 + default: &303 value: attestations: - bundle: @@ -20245,7 +18934,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *89 + - *83 - *17 - *18 responses: @@ -20257,7 +18946,7 @@ paths: type: array items: *4 examples: - default: &176 + default: &169 value: - login: octocat id: 1 @@ -20295,8 +18984,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *89 - - &121 + - *83 + - &115 name: username description: The handle for the GitHub user account. in: path @@ -20327,8 +19016,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response @@ -20348,8 +19037,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response @@ -20374,18 +19063,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *89 - - &329 + - *83 + - &328 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: &124 + schema: &118 type: string description: The name of the tool used to generate the code scanning analysis. - - &330 + - &329 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 @@ -20393,23 +19082,23 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &125 + schema: &119 type: - string - 'null' description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. - - *41 - - *42 + - *38 + - *39 - *18 - *17 - - *40 + - *37 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: &332 + schema: &331 type: string description: State of a code scanning alert. enum: @@ -20432,7 +19121,7 @@ paths: be returned. in: query required: false - schema: &333 + schema: &332 type: string description: Severity of a code scanning alert. enum: @@ -20453,18 +19142,18 @@ paths: items: type: object properties: - number: *46 - created_at: *47 - updated_at: *48 - url: *49 - html_url: *50 - instances_url: &334 + number: *44 + created_at: *45 + updated_at: *46 + url: *47 + html_url: *48 + instances_url: &333 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &126 + state: &120 type: - string - 'null' @@ -20474,13 +19163,13 @@ paths: - dismissed - fixed - - fixed_at: *122 + fixed_at: *116 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *123 - dismissed_reason: &335 + dismissed_at: *117 + dismissed_reason: &334 type: - string - 'null' @@ -20491,14 +19180,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &336 + dismissed_comment: &335 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &337 + rule: &336 type: object properties: id: @@ -20559,26 +19248,26 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &338 + tool: &337 type: object properties: - name: *124 + name: *118 version: type: - string - 'null' description: The version of the tool used to generate the code scanning analysis. - guid: *125 - most_recent_instance: &339 + guid: *119 + most_recent_instance: &338 type: object properties: - ref: &331 + ref: &330 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &345 + analysis_key: &344 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -20589,13 +19278,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &346 + category: &345 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: *126 + state: *120 commit_sha: type: string message: @@ -20636,7 +19325,7 @@ paths: - test - library - - repository: *51 + repository: *49 required: - number - created_at @@ -20881,9 +19570,9 @@ paths: trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks headers: - Link: *37 + Link: *50 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20905,7 +19594,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *89 + - *83 - name: target_type in: query description: The target type of the code security configuration @@ -20924,8 +19613,8 @@ paths: schema: type: integer default: 30 - - *41 - - *42 + - *38 + - *39 responses: '200': description: Response @@ -20933,7 +19622,7 @@ paths: application/json: schema: type: array - items: &127 + items: &121 type: object description: A code security configuration properties: @@ -21195,7 +19884,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *89 + - *83 requestBody: required: true content: @@ -21268,7 +19957,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &131 + code_scanning_default_setup_options: &125 type: - object - 'null' @@ -21387,9 +20076,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *127 + schema: *121 examples: - default: &129 + default: &123 value: id: 1325 target_type: organization @@ -21438,7 +20127,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *89 + - *83 responses: '200': description: Response @@ -21458,7 +20147,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *127 + configuration: *121 examples: default: value: @@ -21548,7 +20237,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *89 + - *83 requestBody: required: true content: @@ -21571,12 +20260,12 @@ paths: - 32 - 91 responses: - '204': &132 + '204': &126 description: A header with no content is returned. '400': *14 '403': *27 '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21598,8 +20287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *89 - - &130 + - *83 + - &124 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -21611,9 +20300,9 @@ paths: description: Response content: application/json: - schema: *127 + schema: *121 examples: - default: *129 + default: *123 '304': *35 '403': *27 '404': *6 @@ -21637,8 +20326,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *89 - - *130 + - *83 + - *124 requestBody: required: true content: @@ -21704,7 +20393,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *131 + code_scanning_default_setup_options: *125 secret_scanning: type: string description: The enablement status of secret scanning @@ -21791,7 +20480,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *127 + schema: *121 examples: default: value: @@ -21845,14 +20534,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *89 - - *130 + - *83 + - *124 responses: - '204': *132 + '204': *126 '400': *14 '403': *27 '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21876,8 +20565,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *89 - - *130 + - *83 + - *124 requestBody: required: true content: @@ -21916,7 +20605,7 @@ paths: - 32 - 91 responses: - '202': *94 + '202': *88 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21940,8 +20629,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: - - *89 - - *130 + - *83 + - *124 requestBody: required: true content: @@ -21981,12 +20670,12 @@ paths: - none - private_and_internal - public - configuration: *127 + configuration: *121 examples: default: value: default_for_new_repos: all - configuration: *129 + configuration: *123 '403': *27 '404': *6 x-github: @@ -22010,8 +20699,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *89 - - *130 + - *83 + - *124 - 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)." @@ -22020,8 +20709,8 @@ paths: schema: type: integer default: 30 - - *41 - - *42 + - *38 + - *39 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -22057,7 +20746,7 @@ paths: - failed - updating - removed_by_enterprise - repository: *51 + repository: *49 examples: default: summary: Example of code security configuration repositories @@ -22154,7 +20843,7 @@ paths: parameters: - *17 - *18 - - *89 + - *83 responses: '200': description: Response @@ -22170,7 +20859,7 @@ paths: type: integer codespaces: type: array - items: &177 + items: &170 type: object title: Codespace description: A codespace. @@ -22201,11 +20890,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *108 + repository: *102 machine: anyOf: - type: 'null' - - &359 + - &358 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -22492,7 +21181,7 @@ paths: - pulls_url - recent_folders examples: - default: &178 + default: &171 value: total_count: 3 codespaces: @@ -22902,7 +21591,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -22924,7 +21613,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *89 + - *83 deprecated: true requestBody: required: true @@ -22968,7 +21657,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22991,7 +21680,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *89 + - *83 deprecated: true requestBody: required: true @@ -23023,7 +21712,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23046,7 +21735,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *89 + - *83 requestBody: required: true content: @@ -23077,7 +21766,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23098,7 +21787,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *89 + - *83 - *17 - *18 responses: @@ -23116,7 +21805,7 @@ paths: type: integer secrets: type: array - items: &133 + items: &128 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -23157,7 +21846,7 @@ paths: - updated_at - visibility examples: - default: &360 + default: &359 value: total_count: 2 secrets: @@ -23170,7 +21859,7 @@ paths: updated_at: '2020-01-11T11:59:22Z' visibility: all headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23189,13 +21878,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &361 + schema: &360 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -23230,7 +21919,7 @@ paths: - key_id - key examples: - default: &362 + default: &361 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -23253,23 +21942,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 responses: '200': description: Response content: application/json: - schema: *133 + schema: *128 examples: - default: &364 + default: &363 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23289,8 +21978,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 requestBody: required: true content: @@ -23345,7 +22034,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -23371,8 +22060,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 responses: '204': description: Response @@ -23397,8 +22086,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - *18 - *17 responses: @@ -23416,9 +22105,9 @@ paths: type: integer repositories: type: array - items: *108 + items: *102 examples: - default: *120 + default: *114 '404': *6 x-github: githubCloudOnly: false @@ -23440,8 +22129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 requestBody: required: true content: @@ -23491,8 +22180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - name: repository_id in: path required: true @@ -23525,8 +22214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - name: repository_id in: path required: true @@ -23565,7 +22254,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: - - *89 + - *83 responses: '200': description: OK @@ -23676,7 +22365,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -23708,7 +22397,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: - - *89 + - *83 - *18 - name: per_page description: The number of results per page (max 100). For more information, @@ -23731,12 +22420,348 @@ paths: currently being billed. seats: type: array - items: *134 + items: &173 + title: Copilot Business Seat Detail + description: Information about a Copilot Business seat assignment + for a user, team, or organization. + type: object + properties: + assignee: *4 + organization: + anyOf: + - type: 'null' + - *129 + assigning_team: + description: The team through which the assignee is granted + access to GitHub Copilot, if applicable. + oneOf: + - &166 + title: Team + description: Groups of organization members that gives + permissions on specified repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + anyOf: + - type: 'null' + - &181 + title: Team Simple + description: Groups of organization members that + gives permissions on specified repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1 + members_url: + type: string + examples: + - https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + examples: + - Justice League + description: + description: Description of the team + type: + - string + - 'null' + examples: + - A great team. + permission: + description: Permission that the team will have + for its repositories + type: string + examples: + - admin + privacy: + description: The level of privacy this team + should have + type: string + examples: + - closed + notification_setting: + description: The notification setting the team + has set + type: string + examples: + - notifications_enabled + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1/repos + slug: + type: string + examples: + - justice-league + ldap_dn: + description: Distinguished Name (DN) that team + maps to within LDAP environment + type: string + examples: + - uid=example,ou=users,dc=github,dc=com + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + examples: + - disabled | all + group_id: + type: + - string + - 'null' + examples: + - 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: + type: string + format: uri + examples: + - https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - sync_to_organizations + - name + - html_url + - slug + - created_at + - updated_at + type: + - 'null' + - object + pending_cancellation_date: + type: + - string + - 'null' + format: date + description: The pending cancellation date for the seat, + in `YYYY-MM-DD` format. This will be null unless the assignee's + Copilot access has been canceled during the current billing + cycle. If the seat has been cancelled, this corresponds + to the start of the organization's next billing cycle. + last_activity_at: + type: + - string + - 'null' + format: date-time + description: Timestamp of user's last GitHub Copilot activity, + in ISO 8601 format. + last_activity_editor: + type: + - string + - 'null' + description: Last editor that was used by the user for a + GitHub Copilot completion. + created_at: + type: string + format: date-time + description: Timestamp of when the assignee was last granted + access to GitHub Copilot, in ISO 8601 format. + updated_at: + type: string + format: date-time + deprecated: true + description: "**Closing down notice:** This field is no + longer relevant and is closing down. Use the `created_at` + field to determine when the assignee was last granted + access to GitHub Copilot. Timestamp of when the assignee's + GitHub Copilot access was last updated, in ISO 8601 format." + plan_type: + type: string + description: The Copilot plan of the organization, or the + parent enterprise, when applicable. + enum: + - business + - enterprise + - unknown + required: + - assignee + - created_at + additionalProperties: false examples: - default: *135 + default: + value: + total_seats: 2 + seats: + - created_at: '2021-08-03T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: + last_activity_at: '2021-10-14T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + plan_type: business + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assigning_team: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + - created_at: '2021-09-23T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: '2021-11-01' + last_activity_at: '2021-10-13T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + assignee: + login: octokitten + id: 1 + node_id: MDQ76VNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + received_events_url: https://api.github.com/users/octokitten/received_events + type: User + site_admin: false headers: - Link: *37 - '500': *39 + Link: *50 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -23769,7 +22794,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: - - *89 + - *83 requestBody: content: application/json: @@ -23811,7 +22836,7 @@ paths: default: value: seats_created: 5 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -23847,7 +22872,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: - - *89 + - *83 requestBody: content: application/json: @@ -23889,7 +22914,7 @@ paths: default: value: seats_cancelled: 5 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -23927,7 +22952,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: - - *89 + - *83 requestBody: content: application/json: @@ -23968,7 +22993,7 @@ paths: default: value: seats_created: 5 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -24004,7 +23029,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: - - *89 + - *83 requestBody: content: application/json: @@ -24046,7 +23071,7 @@ paths: default: value: seats_cancelled: 5 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -24085,7 +23110,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *89 + - *83 - 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`). @@ -24117,13 +23142,430 @@ paths: application/json: schema: type: array - items: *52 + items: &221 + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, + in `YYYY-MM-DD` format. + total_active_users: + type: integer + description: The total number of Copilot users with activity + belonging to any Copilot feature, globally, for the given + day. Includes passive activity such as receiving a code suggestion, + as well as engagement activity such as accepting a code suggestion + or prompting chat. Does not include authentication events. + Is not limited to the individual features detailed on the + endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with + any Copilot feature, for the given day. Examples include but + are not limited to accepting a code suggestion, prompting + Copilot chat, or triggering a PR Summary. Does not include + authentication events. Is not limited to the individual features + detailed on the endpoint. + copilot_ide_code_completions: + type: + - object + - 'null' + description: Usage metrics for Copilot editor code completions + in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code suggestion, across all active editors. Includes both + full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the + given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least + one Copilot code completion suggestion for the given + language. Includes both full and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active + editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least + one Copilot code completion suggestion for the given + editor. Includes both full and partial acceptances. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot + code completion suggestions. If the default + model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_engaged_users: + type: integer + description: Number of users who accepted at + least one Copilot code completion suggestion + for the given editor, for the given language + and model. Includes both full and partial + acceptances. + languages: + type: array + description: Code completion metrics for active + languages, for the given editor. + items: + type: object + description: Usage metrics for a given language + for the given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used + for Copilot code completion suggestions, + for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted + at least one Copilot code completion + suggestion for the given editor, for + the given language. Includes both full + and partial acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code + suggestions generated for the given + editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code + suggestions accepted for the given editor, + for the given language. Includes both + full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code + suggested by Copilot code completions + for the given editor, for the given + language. + total_code_lines_accepted: + type: integer + description: The number of lines of code + accepted from Copilot code suggestions + for the given editor, for the given + language. + copilot_ide_chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot + Chat in the specified editor. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot + code completion suggestions. If the default + model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_engaged_users: + type: integer + description: The number of users who prompted + Copilot Chat in the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated + by users in the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted + a code suggestion from Copilot Chat using + the 'Insert Code' UI element, for the given + editor. + total_chat_copy_events: + type: integer + description: The number of times users copied + a code suggestion from Copilot Chat using + the keyboard, or the 'Copy' UI element, for + the given editor. + copilot_dotcom_chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in github.com + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat on github.com at least once. + models: + type: array + description: List of model metrics for a custom models and + the default model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code + completion suggestions. If the default model is + used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or + default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model + (if applicable). + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat on github.com at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users + on github.com. + copilot_dotcom_pull_requests: + type: + - object + - 'null' + description: Usage metrics for Copilot for pull requests. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull + Requests on github.com to generate a pull request summary + at least once. + repositories: + type: array + description: Repositories in which users used Copilot for + Pull Requests to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull + request summaries using Copilot for Pull Requests + in the given repository. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot + code completion suggestions. If the default + model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries + generated using Copilot for Pull Requests + in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated + pull request summaries using Copilot for Pull + Requests in the given repository and model. + required: + - date + additionalProperties: true examples: - default: *53 - '500': *39 + default: &222 + 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': *127 '403': *27 '404': *6 - '422': *54 + '422': &223 + 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 @@ -24154,7 +23596,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: - - *89 + - *83 - 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`). @@ -24186,10 +23628,159 @@ paths: application/json: schema: type: array - items: *55 + items: &224 + title: Copilot Usage Metrics + description: Summary of Copilot usage. + type: object + properties: + day: + type: string + format: date + description: The date for which the usage metrics are reported, + in `YYYY-MM-DD` format. + total_suggestions_count: + type: integer + description: The total number of Copilot code completion suggestions + shown to users. + total_acceptances_count: + type: integer + description: The total number of Copilot code completion suggestions + accepted by users. + total_lines_suggested: + type: integer + description: The total number of lines of code completions suggested + by Copilot. + total_lines_accepted: + type: integer + description: The total number of lines of code completions accepted + by users. + total_active_users: + type: integer + description: The total number of users who were shown Copilot + code completion suggestions during the day specified. + total_chat_acceptances: + type: integer + description: The total instances of users who accepted code + suggested by Copilot Chat in the IDE (panel and inline). + total_chat_turns: + type: integer + description: The total number of chat turns (prompt and response + pairs) sent between users and Copilot Chat in the IDE. + total_active_chat_users: + type: integer + description: The total number of users who interacted with Copilot + Chat in the IDE during the day specified. + breakdown: + type: + - array + - 'null' + description: Breakdown of Copilot code completions usage by + language and editor + items: + type: object + description: Breakdown of Copilot usage by editor for this + language + additionalProperties: true + properties: + language: + type: string + description: The language in which Copilot suggestions + were shown to users in the specified editor. + editor: + type: string + description: The editor in which Copilot suggestions were + shown to users for the specified language. + suggestions_count: + type: integer + description: The number of Copilot suggestions shown to + users in the editor specified during the day specified. + acceptances_count: + type: integer + description: The number of Copilot suggestions accepted + by users in the editor specified during the day specified. + lines_suggested: + type: integer + description: The number of lines of code suggested by + Copilot in the editor specified during the day specified. + lines_accepted: + type: integer + description: The number of lines of code accepted by users + in the editor specified during the day specified. + active_users: + type: integer + description: The number of users who were shown Copilot + completion suggestions in the editor specified during + the day specified. + required: + - day + - breakdown + additionalProperties: false examples: - default: *136 - '500': *39 + default: &225 + value: + - day: '2023-10-15' + total_suggestions_count: 1000 + total_acceptances_count: 800 + total_lines_suggested: 1800 + total_lines_accepted: 1200 + total_active_users: 10 + total_chat_acceptances: 32 + total_chat_turns: 200 + total_active_chat_users: 4 + breakdown: + - language: python + editor: vscode + suggestions_count: 300 + acceptances_count: 250 + lines_suggested: 900 + lines_accepted: 700 + active_users: 5 + - language: python + editor: jetbrains + suggestions_count: 300 + acceptances_count: 200 + lines_suggested: 400 + lines_accepted: 300 + active_users: 2 + - language: ruby + editor: vscode + suggestions_count: 400 + acceptances_count: 350 + lines_suggested: 500 + lines_accepted: 200 + active_users: 3 + - day: '2023-10-16' + total_suggestions_count: 800 + total_acceptances_count: 600 + total_lines_suggested: 1100 + total_lines_accepted: 700 + total_active_users: 12 + total_chat_acceptances: 57 + total_chat_turns: 426 + total_active_chat_users: 8 + breakdown: + - language: python + editor: vscode + suggestions_count: 300 + acceptances_count: 200 + lines_suggested: 600 + lines_accepted: 300 + active_users: 2 + - language: python + editor: jetbrains + suggestions_count: 300 + acceptances_count: 150 + lines_suggested: 300 + lines_accepted: 250 + active_users: 6 + - language: ruby + editor: vscode + suggestions_count: 200 + acceptances_count: 150 + lines_suggested: 200 + lines_accepted: 150 + active_users: 3 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -24214,18 +23805,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *89 + - *83 + - *130 + - *131 + - *132 + - *133 + - *134 + - *135 + - *37 + - *38 + - *39 + - *136 - *137 - - *138 - - *139 - - *140 - - *141 - - *142 - - *40 - - *41 - - *42 - - *143 - - *144 - *17 responses: '200': @@ -24234,9 +23825,9 @@ paths: application/json: schema: type: array - items: *145 + items: *138 examples: - default: *146 + default: *139 '304': *35 '400': *14 '403': *27 @@ -24262,7 +23853,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *89 + - *83 - *17 - *18 responses: @@ -24280,7 +23871,7 @@ paths: type: integer secrets: type: array - items: &147 + items: &140 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -24332,7 +23923,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24353,13 +23944,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &387 + schema: &386 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -24378,7 +23969,7 @@ paths: - key_id - key examples: - default: &388 + default: &387 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -24401,14 +23992,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 responses: '200': description: Response content: application/json: - schema: *147 + schema: *140 examples: default: value: @@ -24436,8 +24027,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 requestBody: required: true content: @@ -24492,7 +24083,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -24516,8 +24107,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 responses: '204': description: Response @@ -24541,8 +24132,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - *18 - *17 responses: @@ -24560,9 +24151,9 @@ paths: type: integer repositories: type: array - items: *108 + items: *102 examples: - default: *120 + default: *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24583,8 +24174,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 requestBody: required: true content: @@ -24634,8 +24225,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - name: repository_id in: path required: true @@ -24666,8 +24257,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - name: repository_id in: path required: true @@ -24697,7 +24288,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: - - *89 + - *83 responses: '200': description: Response @@ -24705,7 +24296,7 @@ paths: application/json: schema: type: array - items: &189 + items: &183 title: Package description: A software package type: object @@ -24758,7 +24349,7 @@ paths: repository: anyOf: - type: 'null' - - *108 + - *102 created_at: type: string format: date-time @@ -24776,7 +24367,7 @@ paths: - created_at - updated_at examples: - default: &190 + default: &184 value: - id: 197 name: hello_docker @@ -24854,7 +24445,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *89 + - *83 - *17 - *18 responses: @@ -24864,7 +24455,7 @@ paths: application/json: schema: type: array - items: *83 + items: *78 examples: 200-response: value: @@ -24933,7 +24524,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *89 + - *83 - *17 - *18 responses: @@ -24943,7 +24534,7 @@ paths: application/json: schema: type: array - items: &170 + items: &163 title: Organization Invitation description: Organization Invitation type: object @@ -24997,7 +24588,7 @@ paths: - invitation_teams_url - node_id examples: - default: &171 + default: &164 value: - id: 1 login: monalisa @@ -25030,7 +24621,7 @@ paths: invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams invitation_source: member headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -25054,7 +24645,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *89 + - *83 - *17 - *18 responses: @@ -25064,7 +24655,7 @@ paths: application/json: schema: type: array - items: &148 + items: &141 title: Org Hook description: Org Hook type: object @@ -25164,7 +24755,7 @@ paths: created_at: '2011-09-06T17:26:27Z' type: Organization headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -25187,7 +24778,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *89 + - *83 requestBody: required: true content: @@ -25249,9 +24840,9 @@ paths: description: Response content: application/json: - schema: *148 + schema: *141 examples: - default: &149 + default: &142 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -25298,8 +24889,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *89 - - &150 + - *83 + - &143 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. @@ -25312,9 +24903,9 @@ paths: description: Response content: application/json: - schema: *148 + schema: *141 examples: - default: *149 + default: *142 '404': *6 x-github: githubCloudOnly: false @@ -25341,8 +24932,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *89 - - *150 + - *83 + - *143 requestBody: required: false content: @@ -25388,7 +24979,7 @@ paths: description: Response content: application/json: - schema: *148 + schema: *141 examples: default: value: @@ -25429,8 +25020,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *89 - - *150 + - *83 + - *143 responses: '204': description: Response @@ -25457,8 +25048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *89 - - *150 + - *83 + - *143 responses: '200': description: Response @@ -25488,8 +25079,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *89 - - *150 + - *83 + - *143 requestBody: required: false content: @@ -25539,10 +25130,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *89 - - *150 + - *83 + - *143 - *17 - - *151 + - *144 responses: '200': description: Response @@ -25550,9 +25141,9 @@ paths: application/json: schema: type: array - items: *152 + items: *145 examples: - default: *153 + default: *146 '400': *14 '422': *15 x-github: @@ -25577,17 +25168,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *89 - - *150 + - *83 + - *143 - *16 responses: '200': description: Response content: application/json: - schema: *154 + schema: *147 examples: - default: *155 + default: *148 '400': *14 '422': *15 x-github: @@ -25612,11 +25203,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *89 - - *150 + - *83 + - *143 - *16 responses: - '202': *94 + '202': *88 '400': *14 '422': *15 x-github: @@ -25642,8 +25233,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *89 - - *150 + - *83 + - *143 responses: '204': description: Response @@ -25665,8 +25256,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *89 - - &160 + - *83 + - &153 name: actor_type in: path description: The type of the actor @@ -25679,14 +25270,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &161 + - &154 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &156 + - &149 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -25694,7 +25285,7 @@ paths: required: true schema: type: string - - &157 + - &150 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -25705,7 +25296,7 @@ paths: type: string - *18 - *17 - - *40 + - *37 - name: sort description: The property to sort the results by. in: query @@ -25788,13 +25379,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - - *89 - - *156 - - *157 + - *83 + - *149 + - *150 - *18 - *17 - - *40 - - &166 + - *37 + - &159 name: sort description: The property to sort the results by. in: query @@ -25873,15 +25464,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - - *89 - - *156 - - *157 + - *83 + - *149 + - *150 responses: '200': description: Response content: application/json: - schema: &158 + schema: &151 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -25897,7 +25488,7 @@ paths: type: integer format: int64 examples: - default: &159 + default: &152 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -25917,24 +25508,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *89 - - &162 + - *83 + - &155 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *156 - - *157 + - *149 + - *150 responses: '200': description: Response content: application/json: - schema: *158 + schema: *151 examples: - default: *159 + default: *152 x-github: enabledForGitHubApps: true category: orgs @@ -25952,19 +25543,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *89 - - *156 - - *157 - - *160 - - *161 + - *83 + - *149 + - *150 + - *153 + - *154 responses: '200': description: Response content: application/json: - schema: *158 + schema: *151 examples: - default: *159 + default: *152 x-github: enabledForGitHubApps: true category: orgs @@ -25981,10 +25572,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - - *89 - - *156 - - *157 - - &163 + - *83 + - *149 + - *150 + - &156 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -25997,7 +25588,7 @@ paths: description: Response content: application/json: - schema: &164 + schema: &157 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -26013,7 +25604,7 @@ paths: type: integer format: int64 examples: - default: &165 + default: &158 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -26049,19 +25640,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - - *89 - - *162 + - *83 + - *155 + - *149 + - *150 - *156 - - *157 - - *163 responses: '200': description: Response content: application/json: - schema: *164 + schema: *157 examples: - default: *165 + default: *158 x-github: enabledForGitHubApps: true category: orgs @@ -26078,20 +25669,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *89 - - *160 - - *161 + - *83 + - *153 + - *154 + - *149 + - *150 - *156 - - *157 - - *163 responses: '200': description: Response content: application/json: - schema: *164 + schema: *157 examples: - default: *165 + default: *158 x-github: enabledForGitHubApps: true category: orgs @@ -26108,14 +25699,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - - *89 - - *162 - - *156 - - *157 + - *83 + - *155 + - *149 + - *150 - *18 - *17 - - *40 - - *166 + - *37 + - *159 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -26191,7 +25782,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *89 + - *83 responses: '200': description: Response @@ -26199,7 +25790,7 @@ paths: application/json: schema: *20 examples: - default: &426 + default: &425 value: id: 1 account: @@ -26268,7 +25859,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *89 + - *83 - *17 - *18 responses: @@ -26338,7 +25929,7 @@ paths: suspended_at: suspended_by: headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26357,7 +25948,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response @@ -26365,12 +25956,12 @@ paths: application/json: schema: anyOf: - - &168 + - &161 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &167 + limit: &160 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -26398,7 +25989,7 @@ paths: properties: {} additionalProperties: false examples: - default: &169 + default: &162 value: limit: collaborators_only origin: organization @@ -26422,18 +26013,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *89 + - *83 requestBody: required: true content: application/json: - schema: &427 + schema: &426 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *167 + limit: *160 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -26458,9 +26049,9 @@ paths: description: Response content: application/json: - schema: *168 + schema: *161 examples: - default: *169 + default: *162 '422': *15 x-github: githubCloudOnly: false @@ -26478,7 +26069,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *89 + - *83 responses: '204': description: Response @@ -26502,7 +26093,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *89 + - *83 - *17 - *18 - name: role @@ -26536,11 +26127,11 @@ paths: application/json: schema: type: array - items: *170 + items: *163 examples: - default: *171 + default: *164 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -26561,7 +26152,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *89 + - *83 requestBody: required: false content: @@ -26615,7 +26206,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *163 examples: default: value: @@ -26669,8 +26260,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *89 - - &172 + - *83 + - &165 name: invitation_id description: The unique identifier of the invitation. in: path @@ -26700,8 +26291,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *89 - - *172 + - *83 + - *165 - *17 - *18 responses: @@ -26711,9 +26302,9 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - default: &188 + default: &182 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -26729,7 +26320,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -26758,7 +26349,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *89 + - *83 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -26788,7 +26379,7 @@ paths: - closed - all default: open - - *174 + - *167 - name: sort description: What to sort results by. in: query @@ -26800,8 +26391,8 @@ paths: - updated - comments default: created - - *40 - - *62 + - *37 + - *57 - *17 - *18 responses: @@ -26811,11 +26402,11 @@ paths: application/json: schema: type: array - items: *72 + items: *67 examples: - default: *175 + default: *168 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -26835,7 +26426,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *89 + - *83 - 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) @@ -26871,9 +26462,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 '422': *15 x-github: githubCloudOnly: false @@ -26891,8 +26482,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response if requester is an organization member and user is @@ -26923,8 +26514,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response @@ -26950,8 +26541,8 @@ paths: parameters: - *17 - *18 - - *89 - - *121 + - *83 + - *115 responses: '200': description: Response @@ -26967,11 +26558,11 @@ paths: type: integer codespaces: type: array - items: *177 + items: *170 examples: - default: *178 + default: *171 '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -26994,9 +26585,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *89 - - *121 - - &179 + - *83 + - *115 + - &172 name: codespace_name in: path required: true @@ -27004,9 +26595,9 @@ paths: schema: type: string responses: - '202': *94 + '202': *88 '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -27029,17 +26620,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *89 - - *121 - - *179 + - *83 + - *115 + - *172 responses: '200': description: Response content: application/json: - schema: *177 + schema: *170 examples: - default: &358 + default: &357 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -27181,7 +26772,7 @@ paths: recent_folders: [] template: '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -27212,14 +26803,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: - - *89 - - *121 + - *83 + - *115 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *134 + schema: *173 examples: default: value: @@ -27262,7 +26853,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -27287,14 +26878,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - - *89 - - *121 + - *83 + - *115 responses: '200': description: Response content: application/json: - schema: &180 + schema: &174 title: Org Membership description: Org Membership type: object @@ -27327,7 +26918,7 @@ paths: format: uri examples: - https://api.github.com/orgs/octocat - organization: *88 + organization: *129 user: anyOf: - type: 'null' @@ -27347,7 +26938,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &181 + response-if-user-has-an-active-admin-membership-with-organization: &175 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -27415,8 +27006,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - - *89 - - *121 + - *83 + - *115 requestBody: required: false content: @@ -27444,9 +27035,9 @@ paths: description: Response content: application/json: - schema: *180 + schema: *174 examples: - response-if-user-already-had-membership-with-organization: *181 + response-if-user-already-had-membership-with-organization: *175 '422': *15 '403': *27 x-github: @@ -27467,8 +27058,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response @@ -27493,7 +27084,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *89 + - *83 - *17 - *18 - name: exclude @@ -27515,7 +27106,7 @@ paths: application/json: schema: type: array - items: &182 + items: &176 title: Migration description: A migration. type: object @@ -27557,7 +27148,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *57 + items: *52 url: type: string format: uri @@ -27756,7 +27347,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27772,7 +27363,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *89 + - *83 requestBody: required: true content: @@ -27853,7 +27444,7 @@ paths: description: Response content: application/json: - schema: *182 + schema: *176 examples: default: value: @@ -28031,8 +27622,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *89 - - &183 + - *83 + - &177 name: migration_id description: The unique identifier of the migration. in: path @@ -28060,7 +27651,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *182 + schema: *176 examples: default: value: @@ -28229,8 +27820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *89 - - *183 + - *83 + - *177 responses: '302': description: Response @@ -28251,8 +27842,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *89 - - *183 + - *83 + - *177 responses: '204': description: Response @@ -28275,9 +27866,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *89 - - *183 - - &568 + - *83 + - *177 + - &567 name: repo_name description: repo_name parameter in: path @@ -28304,8 +27895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *89 - - *183 + - *83 + - *177 - *17 - *18 responses: @@ -28315,9 +27906,9 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: &195 + default: &189 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -28428,7 +28019,7 @@ paths: secret_scanning_non_provider_patterns: status: disabled headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -28454,7 +28045,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response - list of organization roles @@ -28470,7 +28061,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &186 + items: &180 title: Organization Role description: Organization roles type: object @@ -28619,8 +28210,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *89 - - *184 + - *83 + - &178 + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string responses: '204': description: Response @@ -28645,9 +28242,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *89 - - *184 - - &185 + - *83 + - *178 + - &179 name: role_id description: The unique identifier of the role. in: path @@ -28682,9 +28279,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *89 - - *184 - - *185 + - *83 + - *178 + - *179 responses: '204': description: Response @@ -28709,8 +28306,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response @@ -28735,9 +28332,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *89 - - *121 - - *185 + - *83 + - *115 + - *179 responses: '204': description: Response @@ -28767,9 +28364,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *89 - - *121 - - *185 + - *83 + - *115 + - *179 responses: '204': description: Response @@ -28797,14 +28394,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *89 - - *185 + - *83 + - *179 responses: '200': description: Response content: application/json: - schema: *186 + schema: *180 examples: default: value: @@ -28854,8 +28451,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: - - *89 - - *185 + - *83 + - *179 - *17 - *18 responses: @@ -28934,7 +28531,7 @@ paths: parent: anyOf: - type: 'null' - - *187 + - *181 required: - id - node_id @@ -28948,9 +28545,9 @@ paths: - slug - parent examples: - default: *188 + default: *182 headers: - Link: *37 + Link: *50 '404': description: Response if the organization or role does not exist. '422': @@ -28977,8 +28574,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: - - *89 - - *185 + - *83 + - *179 - *17 - *18 responses: @@ -29007,7 +28604,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *187 + items: *181 name: type: - string @@ -29124,9 +28721,9 @@ paths: - type - url examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 '404': description: Response if the organization or role does not exist. '422': @@ -29148,7 +28745,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *89 + - *83 - 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) @@ -29172,9 +28769,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29197,8 +28794,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *89 - - *121 + - *83 + - *115 requestBody: required: false content: @@ -29255,8 +28852,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response @@ -29313,8 +28910,8 @@ paths: - docker - nuget - container - - *89 - - &570 + - *83 + - &569 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -29350,12 +28947,12 @@ paths: application/json: schema: type: array - items: *189 + items: *183 examples: - default: *190 + default: *184 '403': *27 '401': *23 - '400': &572 + '400': &571 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -29377,7 +28974,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &191 + - &185 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 @@ -29395,20 +28992,20 @@ paths: - docker - nuget - container - - &192 + - &186 name: package_name description: The name of the package. in: path required: true schema: type: string - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: *189 + schema: *183 examples: default: value: @@ -29460,9 +29057,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *191 - - *192 - - *89 + - *185 + - *186 + - *83 responses: '204': description: Response @@ -29494,9 +29091,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *191 - - *192 - - *89 + - *185 + - *186 + - *83 - name: token description: package token schema: @@ -29528,9 +29125,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: - - *191 - - *192 - - *89 + - *185 + - *186 + - *83 - *18 - *17 - name: state @@ -29550,7 +29147,7 @@ paths: application/json: schema: type: array - items: &193 + items: &187 title: Package Version description: A version of a software package type: object @@ -29685,10 +29282,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *191 - - *192 - - *89 - - &194 + - *185 + - *186 + - *83 + - &188 name: package_version_id description: Unique identifier of the package version. in: path @@ -29700,7 +29297,7 @@ paths: description: Response content: application/json: - schema: *193 + schema: *187 examples: default: value: @@ -29736,10 +29333,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *191 - - *192 - - *89 - - *194 + - *185 + - *186 + - *83 + - *188 responses: '204': description: Response @@ -29771,10 +29368,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *191 - - *192 - - *89 - - *194 + - *185 + - *186 + - *83 + - *188 responses: '204': description: Response @@ -29801,10 +29398,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: - - *89 + - *83 - *17 - *18 - - &196 + - &190 name: sort description: The property by which to sort the results. in: query @@ -29814,8 +29411,8 @@ paths: enum: - created_at default: created_at - - *40 - - &197 + - *37 + - &191 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -29827,7 +29424,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &198 + - &192 name: repository description: The name of the repository to use to filter the results. in: query @@ -29836,7 +29433,7 @@ paths: type: string examples: - Hello-World - - &199 + - &193 name: permission description: The permission to use to filter the results. in: query @@ -29845,7 +29442,7 @@ paths: type: string examples: - issues_read - - &200 + - &194 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) @@ -29855,7 +29452,7 @@ paths: schema: type: string format: date-time - - &201 + - &195 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) @@ -29866,7 +29463,7 @@ paths: type: string format: date-time responses: - '500': *39 + '500': *127 '422': *15 '404': *6 '403': *27 @@ -30001,7 +29598,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30021,7 +29618,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: - - *89 + - *83 requestBody: required: true content: @@ -30063,11 +29660,11 @@ paths: action: deny reason: Access is too broad. responses: - '500': *39 + '500': *127 '422': *15 '404': *6 '403': *27 - '202': *94 + '202': *88 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30088,7 +29685,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: - - *89 + - *83 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -30125,11 +29722,11 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *39 + '500': *127 '422': *15 '404': *6 '403': *27 - '204': *132 + '204': *126 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30150,7 +29747,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: - - *89 + - *83 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -30161,7 +29758,7 @@ paths: - *17 - *18 responses: - '500': *39 + '500': *127 '404': *6 '403': *27 '200': @@ -30170,11 +29767,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30195,18 +29792,18 @@ 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: - - *89 + - *83 - *17 - *18 - - *196 - - *40 - - *197 - - *198 - - *199 - - *200 - - *201 + - *190 + - *37 + - *191 + - *192 + - *193 + - *194 + - *195 responses: - '500': *39 + '500': *127 '422': *15 '404': *6 '403': *27 @@ -30335,7 +29932,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30355,7 +29952,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: - - *89 + - *83 requestBody: required: true content: @@ -30390,9 +29987,9 @@ paths: - 1296269 - 1296280 responses: - '500': *39 + '500': *127 '404': *6 - '202': *94 + '202': *88 '403': *27 '422': *15 x-github: @@ -30415,7 +30012,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: - - *89 + - *83 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -30443,9 +30040,9 @@ paths: value: action: revoke responses: - '500': *39 + '500': *127 '404': *6 - '204': *132 + '204': *126 '403': *27 '422': *15 x-github: @@ -30467,7 +30064,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: - - *89 + - *83 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -30477,7 +30074,7 @@ paths: - *17 - *18 responses: - '500': *39 + '500': *127 '404': *6 '403': *27 '200': @@ -30486,11 +30083,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30510,7 +30107,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-organization-projects parameters: - - *89 + - *83 - name: state description: Indicates the state of the projects to return. in: query @@ -30531,7 +30128,7 @@ paths: application/json: schema: type: array - items: &202 + items: &196 title: Project description: Projects are a way to organize columns and cards of work. @@ -30664,7 +30261,7 @@ paths: organization_permission: write private: true headers: - Link: *37 + Link: *50 '422': *7 x-github: githubCloudOnly: false @@ -30684,7 +30281,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#create-an-organization-project parameters: - - *89 + - *83 requestBody: required: true content: @@ -30710,7 +30307,7 @@ paths: description: Response content: application/json: - schema: *202 + schema: *196 examples: default: value: @@ -30748,7 +30345,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': &251 + '410': &250 description: Gone content: application/json: @@ -30772,7 +30369,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response @@ -30780,7 +30377,7 @@ paths: application/json: schema: type: array - items: &203 + items: &197 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -30856,7 +30453,7 @@ paths: - property_name - value_type examples: - default: &204 + default: &198 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -30900,7 +30497,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *89 + - *83 requestBody: required: true content: @@ -30911,7 +30508,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *203 + items: *197 minItems: 1 maxItems: 100 required: @@ -30941,9 +30538,9 @@ paths: application/json: schema: type: array - items: *203 + items: *197 examples: - default: *204 + default: *198 '403': *27 '404': *6 x-github: @@ -30964,8 +30561,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *89 - - &205 + - *83 + - &199 name: custom_property_name description: The custom property name in: path @@ -30977,9 +30574,9 @@ paths: description: Response content: application/json: - schema: *203 + schema: *197 examples: - default: &206 + default: &200 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -31013,13 +30610,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *89 - - *205 + - *83 + - *199 requestBody: required: true content: application/json: schema: + title: Custom Property Set Payload + description: Custom property set payload type: object properties: value_type: @@ -31079,9 +30678,9 @@ paths: description: Response content: application/json: - schema: *203 + schema: *197 examples: - default: *206 + default: *200 '403': *27 '404': *6 x-github: @@ -31104,10 +30703,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *89 - - *205 + - *83 + - *199 responses: - '204': *132 + '204': *126 '403': *27 '404': *6 x-github: @@ -31128,7 +30727,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *89 + - *83 - *17 - *18 - name: repository_query @@ -31169,7 +30768,7 @@ paths: - octocat/Hello-World properties: type: array - items: &207 + items: &201 title: Custom Property Value description: Custom property name and associated value type: object @@ -31211,7 +30810,7 @@ paths: - property_name: team value: octocat headers: - Link: *37 + Link: *50 '403': *27 '404': *6 x-github: @@ -31239,7 +30838,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: - - *89 + - *83 requestBody: required: true content: @@ -31259,7 +30858,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *207 + items: *201 required: - repository_names - properties @@ -31300,7 +30899,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *89 + - *83 - *17 - *18 responses: @@ -31312,9 +30911,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31331,8 +30930,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response if user is a public member @@ -31356,8 +30955,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response @@ -31378,8 +30977,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response @@ -31403,7 +31002,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *89 + - *83 - name: type description: Specifies the types of repositories you want returned. in: query @@ -31449,11 +31048,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31472,7 +31071,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *89 + - *83 requestBody: required: true content: @@ -31654,7 +31253,7 @@ paths: description: Response content: application/json: - schema: &253 + schema: &252 title: Full Repository description: Full Repository type: object @@ -32000,7 +31599,7 @@ paths: template_repository: anyOf: - type: 'null' - - *57 + - *52 temp_clone_token: type: - string @@ -32100,13 +31699,13 @@ paths: license: anyOf: - type: 'null' - - *73 + - *68 organization: anyOf: - type: 'null' - *4 - parent: *57 - source: *57 + parent: *52 + source: *52 forks: type: integer master_branch: @@ -32119,7 +31718,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &377 + code_of_conduct: &376 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -32149,7 +31748,7 @@ paths: - key - name - html_url - security_and_analysis: *208 + security_and_analysis: *202 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -32233,7 +31832,7 @@ paths: - network_count - subscribers_count examples: - default: &255 + default: &254 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -32751,10 +32350,10 @@ paths: category: orgs subcategory: rules parameters: - - *89 + - *83 - *17 - *18 - - &508 + - &507 name: targets description: | A comma-separated list of rule targets to filter by. @@ -32773,7 +32372,7 @@ paths: application/json: schema: type: array - items: &215 + items: &209 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -32797,16 +32396,18 @@ paths: - branch - tag - push + - repository source_type: type: string description: The type of the source of the ruleset enum: - Repository - Organization + - Enterprise source: type: string description: The name of the source - enforcement: &211 + enforcement: &205 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -32819,7 +32420,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &212 + items: &206 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -32885,7 +32486,7 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - &209 + - &203 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -32909,20 +32510,21 @@ paths: match. items: type: string - - &213 + - &207 title: Organization ruleset conditions type: object description: |- Conditions for an organization ruleset. The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. The push rulesets conditions object does not require the `ref_name` property. + For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. oneOf: - type: object title: repository_name_and_ref_name description: Conditions to target repositories by name and refs by name allOf: - - *209 + - *203 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -32956,7 +32558,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *209 + - *203 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -32978,7 +32580,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *209 + - *203 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -32991,7 +32593,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &210 + items: &204 title: Repository ruleset property targeting definition type: object @@ -33024,7 +32626,7 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *210 + items: *204 required: - repository_property type: @@ -33032,12 +32634,12 @@ paths: - object rules: type: array - items: &214 + items: &208 title: Repository Rule type: object description: A repository rule. oneOf: - - &490 + - &489 title: creation description: Only allow users with bypass permission to create matching refs. @@ -33049,7 +32651,7 @@ paths: type: string enum: - creation - - &491 + - &490 title: update description: Only allow users with bypass permission to update matching refs. @@ -33070,7 +32672,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &493 + - &492 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -33082,7 +32684,7 @@ paths: type: string enum: - deletion - - &494 + - &493 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -33094,7 +32696,7 @@ paths: type: string enum: - required_linear_history - - &495 + - &494 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -33172,7 +32774,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &496 + - &495 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -33196,7 +32798,7 @@ paths: type: string required: - required_deployment_environments - - &497 + - &496 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -33208,7 +32810,7 @@ paths: type: string enum: - required_signatures - - &498 + - &497 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -33224,6 +32826,13 @@ paths: parameters: type: object properties: + allowed_merge_methods: + type: array + description: When merging pull requests, you can + allow any combination of merge commits, squashing, + or rebasing. At least one option must be enabled. + items: + type: string dismiss_stale_reviews_on_push: type: boolean description: New, reviewable commits pushed will @@ -33254,7 +32863,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &499 + - &498 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -33302,7 +32911,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &500 + - &499 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -33314,7 +32923,7 @@ paths: type: string enum: - non_fast_forward - - &501 + - &500 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -33350,7 +32959,7 @@ paths: required: - operator - pattern - - &502 + - &501 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -33386,7 +32995,7 @@ paths: required: - operator - pattern - - &503 + - &502 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -33422,7 +33031,7 @@ paths: required: - operator - pattern - - &504 + - &503 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -33458,7 +33067,7 @@ paths: required: - operator - pattern - - &505 + - &504 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -33584,7 +33193,7 @@ paths: maximum: 100 required: - max_file_size - - &506 + - &505 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -33634,7 +33243,7 @@ paths: - repository_id required: - workflows - - &507 + - &506 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -33731,7 +33340,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *39 + '500': *127 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -33747,7 +33356,7 @@ paths: category: orgs subcategory: rules parameters: - - *89 + - *83 requestBody: description: Request body required: true @@ -33766,17 +33375,18 @@ paths: - branch - tag - push + - repository default: branch - enforcement: *211 + enforcement: *205 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *212 - conditions: *213 + items: *206 + conditions: *207 rules: type: array description: An array of rules within the ruleset. - items: *214 + items: *208 required: - name - enforcement @@ -33814,9 +33424,9 @@ paths: description: Response content: application/json: - schema: *215 + schema: *209 examples: - default: &216 + default: &210 value: id: 21 name: super cool ruleset @@ -33856,7 +33466,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *39 + '500': *127 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -33870,8 +33480,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *89 - - &509 + - *83 + - &508 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 @@ -33886,7 +33496,7 @@ paths: in: query schema: type: string - - &510 + - &509 name: time_period description: |- The time period to filter by. @@ -33902,14 +33512,14 @@ paths: - week - month default: day - - &511 + - &510 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 - - &512 + - &511 name: rule_suite_result description: The rule results to filter on. When specified, only suites with this result will be returned. @@ -33929,7 +33539,7 @@ paths: description: Response content: application/json: - schema: &513 + schema: &512 title: Rule Suites description: Response type: array @@ -33985,7 +33595,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &514 + default: &513 value: - id: 21 actor_id: 12 @@ -34009,7 +33619,7 @@ paths: result: pass evaluation_result: fail '404': *6 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34028,8 +33638,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *89 - - &515 + - *83 + - &514 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -34045,7 +33655,7 @@ paths: description: Response content: application/json: - schema: &516 + schema: &515 title: Rule Suite description: Response type: object @@ -34152,7 +33762,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &517 + default: &516 value: id: 21 actor_id: 12 @@ -34187,7 +33797,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *6 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34213,7 +33823,7 @@ paths: category: orgs subcategory: rules parameters: - - *89 + - *83 - name: ruleset_id description: The ID of the ruleset. in: path @@ -34225,11 +33835,11 @@ paths: description: Response content: application/json: - schema: *215 + schema: *209 examples: - default: *216 + default: *210 '404': *6 - '500': *39 + '500': *127 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -34245,7 +33855,7 @@ paths: category: orgs subcategory: rules parameters: - - *89 + - *83 - name: ruleset_id description: The ID of the ruleset. in: path @@ -34270,16 +33880,17 @@ paths: - branch - tag - push - enforcement: *211 + - repository + enforcement: *205 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *212 - conditions: *213 + items: *206 + conditions: *207 rules: description: An array of rules within the ruleset. type: array - items: *214 + items: *208 examples: default: value: @@ -34314,11 +33925,11 @@ paths: description: Response content: application/json: - schema: *215 + schema: *209 examples: - default: *216 + default: *210 '404': *6 - '500': *39 + '500': *127 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -34334,7 +33945,7 @@ paths: category: orgs subcategory: rules parameters: - - *89 + - *83 - name: ruleset_id description: The ID of the ruleset. in: path @@ -34345,7 +33956,7 @@ paths: '204': description: Response '404': *6 - '500': *39 + '500': *127 "/orgs/{org}/secret-scanning/alerts": get: summary: List secret scanning alerts for an organization @@ -34362,15 +33973,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *89 - - *217 - - *218 - - *219 - - *220 - - *40 + - *83 + - *211 + - *212 + - *213 + - *214 + - *37 - *18 - *17 - - &519 + - &518 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 @@ -34380,7 +33991,7 @@ paths: required: false schema: type: string - - &520 + - &519 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 @@ -34390,9 +34001,9 @@ paths: required: false schema: type: string - - *221 - - *222 - - *223 + - *215 + - *216 + - *217 responses: '200': description: Response @@ -34400,13 +34011,13 @@ paths: application/json: schema: type: array - items: *224 + items: *218 examples: - default: *225 + default: *219 headers: - Link: *37 + Link: *50 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34428,8 +34039,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *89 - - *40 + - *83 + - *37 - name: sort description: The property to sort the results by. in: query @@ -34441,8 +34052,8 @@ paths: - updated - published default: created - - *41 - - *42 + - *38 + - *39 - name: per_page description: The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -34472,7 +34083,7 @@ paths: application/json: schema: type: array - items: &527 + items: &526 description: A repository security advisory. type: object properties: @@ -34680,7 +34291,7 @@ paths: required: - vector_string - score - cvss_severities: *44 + cvss_severities: *41 cwes: type: - array @@ -34716,7 +34327,7 @@ paths: login: type: string description: The username of the user credited. - type: *226 + type: *220 credits_detailed: type: - array @@ -34727,7 +34338,7 @@ paths: type: object properties: user: *4 - type: *226 + type: *220 state: type: string description: The state of the user's acceptance of the @@ -34753,13 +34364,13 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *173 + items: *166 private_fork: readOnly: true description: A temporary private fork of the advisory's repository for collaborating on a fix. allOf: - - *51 + - *49 type: - 'null' required: @@ -34791,7 +34402,7 @@ paths: - private_fork additionalProperties: false examples: - default: &528 + default: &527 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -35173,7 +34784,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *89 + - *83 responses: '200': description: Response @@ -35181,9 +34792,9 @@ paths: application/json: schema: type: array - items: *187 + items: *181 examples: - default: *188 + default: *182 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35206,8 +34817,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *89 - - *184 + - *83 + - *178 responses: '204': description: Response @@ -35232,8 +34843,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *89 - - *184 + - *83 + - *178 responses: '204': description: Response @@ -35259,13 +34870,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &586 + schema: &585 type: object properties: total_minutes_used: @@ -35335,7 +34946,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &587 + default: &586 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -35365,13 +34976,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &588 + schema: &587 type: object properties: total_gigabytes_bandwidth_used: @@ -35389,7 +35000,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &589 + default: &588 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -35415,13 +35026,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &590 + schema: &589 type: object properties: days_left_in_billing_cycle: @@ -35439,7 +35050,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &591 + default: &590 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -35473,8 +35084,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *89 - - *184 + - *83 + - *178 - 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`). @@ -35506,13 +35117,13 @@ paths: application/json: schema: type: array - items: *52 + items: *221 examples: - default: *53 - '500': *39 + default: *222 + '500': *127 '403': *27 '404': *6 - '422': *54 + '422': *223 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35546,8 +35157,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: - - *89 - - *184 + - *83 + - *178 - 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`). @@ -35579,10 +35190,10 @@ paths: application/json: schema: type: array - items: *55 + items: *224 examples: - default: *136 - '500': *39 + default: *225 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -35603,7 +35214,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *89 + - *83 - *17 - *18 responses: @@ -35613,11 +35224,11 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - default: *188 + default: *182 headers: - Link: *37 + Link: *50 '403': *27 x-github: githubCloudOnly: false @@ -35637,7 +35248,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *89 + - *83 requestBody: required: true content: @@ -35709,7 +35320,7 @@ paths: description: Response content: application/json: - schema: &227 + schema: &226 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -35783,7 +35394,7 @@ paths: parent: anyOf: - type: 'null' - - *187 + - *181 members_count: type: integer examples: @@ -36089,7 +35700,7 @@ paths: - repos_count - organization examples: - default: &228 + default: &227 value: id: 1 node_id: MDQ6VGVhbTE= @@ -36159,16 +35770,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *89 - - *184 + - *83 + - *178 responses: '200': description: Response content: application/json: - schema: *227 + schema: *226 examples: - default: *228 + default: *227 '404': *6 x-github: githubCloudOnly: false @@ -36189,8 +35800,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *89 - - *184 + - *83 + - *178 requestBody: required: false content: @@ -36253,16 +35864,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *227 + schema: *226 examples: - default: *228 + default: *227 '201': description: Response content: application/json: - schema: *227 + schema: *226 examples: - default: *228 + default: *227 '404': *6 '422': *15 '403': *27 @@ -36287,8 +35898,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *89 - - *184 + - *83 + - *178 responses: '204': description: Response @@ -36314,9 +35925,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *89 - - *184 - - *40 + - *83 + - *178 + - *37 - *17 - *18 - name: pinned @@ -36332,7 +35943,7 @@ paths: application/json: schema: type: array - items: &229 + items: &228 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -36423,7 +36034,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *59 + reactions: *54 required: - author - body @@ -36443,7 +36054,7 @@ paths: - updated_at - url examples: - default: &542 + default: &541 value: - author: login: octocat @@ -36493,7 +36104,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36517,8 +36128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *89 - - *184 + - *83 + - *178 requestBody: required: true content: @@ -36552,9 +36163,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *228 examples: - default: &230 + default: &229 value: author: login: octocat @@ -36626,9 +36237,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *89 - - *184 - - &231 + - *83 + - *178 + - &230 name: discussion_number description: The number that identifies the discussion. in: path @@ -36640,9 +36251,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *228 examples: - default: *230 + default: *229 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36664,9 +36275,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *89 - - *184 - - *231 + - *83 + - *178 + - *230 requestBody: required: false content: @@ -36689,9 +36300,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *228 examples: - default: &543 + default: &542 value: author: login: octocat @@ -36761,9 +36372,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *89 - - *184 - - *231 + - *83 + - *178 + - *230 responses: '204': description: Response @@ -36789,10 +36400,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *89 - - *184 - - *231 - - *40 + - *83 + - *178 + - *230 + - *37 - *17 - *18 responses: @@ -36802,7 +36413,7 @@ paths: application/json: schema: type: array - items: &232 + items: &231 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -36867,7 +36478,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *59 + reactions: *54 required: - author - body @@ -36882,7 +36493,7 @@ paths: - updated_at - url examples: - default: &544 + default: &543 value: - author: login: octocat @@ -36926,7 +36537,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36950,9 +36561,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *89 - - *184 - - *231 + - *83 + - *178 + - *230 requestBody: required: true content: @@ -36974,9 +36585,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *231 examples: - default: &233 + default: &232 value: author: login: octocat @@ -37042,10 +36653,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *89 - - *184 - - *231 - - &234 + - *83 + - *178 + - *230 + - &233 name: comment_number description: The number that identifies the comment. in: path @@ -37057,9 +36668,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *231 examples: - default: *233 + default: *232 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37081,10 +36692,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *89 - - *184 - - *231 - - *234 + - *83 + - *178 + - *230 + - *233 requestBody: required: true content: @@ -37106,9 +36717,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *231 examples: - default: &545 + default: &544 value: author: login: octocat @@ -37172,10 +36783,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *89 - - *184 - - *231 - - *234 + - *83 + - *178 + - *230 + - *233 responses: '204': description: Response @@ -37201,10 +36812,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *89 - - *184 - - *231 - - *234 + - *83 + - *178 + - *230 + - *233 - 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. @@ -37230,7 +36841,7 @@ paths: application/json: schema: type: array - items: &235 + items: &234 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -37274,7 +36885,7 @@ paths: - content - created_at examples: - default: &237 + default: &236 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -37300,7 +36911,7 @@ paths: content: heart created_at: '2016-05-20T20:09:31Z' headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37324,10 +36935,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *89 - - *184 - - *231 - - *234 + - *83 + - *178 + - *230 + - *233 requestBody: required: true content: @@ -37360,9 +36971,9 @@ paths: team discussion comment content: application/json: - schema: *235 + schema: *234 examples: - default: &236 + default: &235 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -37391,9 +37002,9 @@ paths: description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37416,11 +37027,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *89 - - *184 - - *231 - - *234 - - &238 + - *83 + - *178 + - *230 + - *233 + - &237 name: reaction_id description: The unique identifier of the reaction. in: path @@ -37452,9 +37063,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *89 - - *184 - - *231 + - *83 + - *178 + - *230 - 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. @@ -37480,11 +37091,11 @@ paths: application/json: schema: type: array - items: *235 + items: *234 examples: - default: *237 + default: *236 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37508,9 +37119,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *89 - - *184 - - *231 + - *83 + - *178 + - *230 requestBody: required: true content: @@ -37542,16 +37153,16 @@ paths: description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '201': description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -37574,10 +37185,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *89 - - *184 - - *231 - - *238 + - *83 + - *178 + - *230 + - *237 responses: '204': description: Response @@ -37601,8 +37212,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *89 - - *184 + - *83 + - *178 - *17 - *18 responses: @@ -37612,11 +37223,11 @@ paths: application/json: schema: type: array - items: *170 + items: *163 examples: - default: *171 + default: *164 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37636,8 +37247,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *89 - - *184 + - *83 + - *178 - name: role description: Filters members returned by their role in the team. in: query @@ -37660,9 +37271,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37690,15 +37301,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - - *89 - - *184 - - *121 + - *83 + - *178 + - *115 responses: '200': description: Response content: application/json: - schema: &239 + schema: &238 title: Team Membership description: Team Membership type: object @@ -37726,7 +37337,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &546 + response-if-user-is-a-team-maintainer: &545 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -37762,9 +37373,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *89 - - *184 - - *121 + - *83 + - *178 + - *115 requestBody: required: false content: @@ -37789,9 +37400,9 @@ paths: description: Response content: application/json: - schema: *239 + schema: *238 examples: - response-if-users-membership-with-team-is-now-pending: &547 + response-if-users-membership-with-team-is-now-pending: &546 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -37826,9 +37437,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - - *89 - - *184 - - *121 + - *83 + - *178 + - *115 responses: '204': description: Response @@ -37854,8 +37465,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects parameters: - - *89 - - *184 + - *83 + - *178 - *17 - *18 responses: @@ -37865,7 +37476,7 @@ paths: application/json: schema: type: array - items: &240 + items: &239 title: Team Project description: A team's access to a project. type: object @@ -37934,7 +37545,7 @@ paths: - updated_at - permissions examples: - default: &548 + default: &547 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -37974,7 +37585,7 @@ paths: write: true admin: false headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37995,9 +37606,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project parameters: - - *89 - - *184 - - &241 + - *83 + - *178 + - &240 name: project_id description: The unique identifier of the project. in: path @@ -38009,9 +37620,9 @@ paths: description: Response content: application/json: - schema: *240 + schema: *239 examples: - default: &549 + default: &548 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -38071,9 +37682,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions parameters: - - *89 - - *184 - - *241 + - *83 + - *178 + - *240 requestBody: required: false content: @@ -38138,9 +37749,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team parameters: - - *89 - - *184 - - *241 + - *83 + - *178 + - *240 responses: '204': description: Response @@ -38164,8 +37775,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *89 - - *184 + - *83 + - *178 - *17 - *18 responses: @@ -38175,11 +37786,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38206,16 +37817,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *89 - - *184 + - *83 + - *178 + - *241 - *242 - - *243 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &550 + schema: &549 title: Team Repository description: A team's access to a repository. type: object @@ -38241,7 +37852,7 @@ paths: license: anyOf: - type: 'null' - - *73 + - *68 forks: type: integer permissions: @@ -38856,10 +38467,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *89 - - *184 + - *83 + - *178 + - *241 - *242 - - *243 requestBody: required: false content: @@ -38904,10 +38515,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *89 - - *184 + - *83 + - *178 + - *241 - *242 - - *243 responses: '204': description: Response @@ -38931,8 +38542,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *89 - - *184 + - *83 + - *178 - *17 - *18 responses: @@ -38942,9 +38553,9 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - response-if-child-teams-exist: &551 + response-if-child-teams-exist: &550 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -38972,7 +38583,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38997,7 +38608,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *89 + - *83 - name: security_product in: path description: The security feature to enable or disable. @@ -39068,7 +38679,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#get-a-project-card parameters: - - &244 + - &243 name: card_id description: The unique identifier of the card. in: path @@ -39080,7 +38691,7 @@ paths: description: Response content: application/json: - schema: &245 + schema: &244 title: Project Card description: Project cards represent a scope of work. type: object @@ -39155,7 +38766,7 @@ paths: - created_at - updated_at examples: - default: &246 + default: &245 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -39205,7 +38816,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#update-an-existing-project-card parameters: - - *244 + - *243 requestBody: required: false content: @@ -39235,9 +38846,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *244 examples: - default: *246 + default: *245 '304': *35 '403': *27 '401': *23 @@ -39258,7 +38869,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#delete-a-project-card parameters: - - *244 + - *243 responses: '204': description: Response @@ -39296,7 +38907,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#move-a-project-card parameters: - - *244 + - *243 requestBody: required: true content: @@ -39403,7 +39014,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#get-a-project-column parameters: - - &247 + - &246 name: column_id description: The unique identifier of the column. in: path @@ -39415,7 +39026,7 @@ paths: description: Response content: application/json: - schema: &248 + schema: &247 title: Project Column description: Project columns contain cards of work. type: object @@ -39469,7 +39080,7 @@ paths: - created_at - updated_at examples: - default: &249 + default: &248 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -39498,7 +39109,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#update-an-existing-project-column parameters: - - *247 + - *246 requestBody: required: true content: @@ -39523,9 +39134,9 @@ paths: description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '304': *35 '403': *27 '401': *23 @@ -39544,7 +39155,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#delete-a-project-column parameters: - - *247 + - *246 responses: '204': description: Response @@ -39567,7 +39178,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#list-project-cards parameters: - - *247 + - *246 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -39588,7 +39199,7 @@ paths: application/json: schema: type: array - items: *245 + items: *244 examples: default: value: @@ -39622,7 +39233,7 @@ paths: content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 project_url: https://api.github.com/projects/120 headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -39641,7 +39252,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#create-a-project-card parameters: - - *247 + - *246 requestBody: required: true content: @@ -39685,9 +39296,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *244 examples: - default: *246 + default: *245 '304': *35 '403': *27 '401': *23 @@ -39697,8 +39308,8 @@ paths: application/json: schema: oneOf: - - *92 - - *93 + - *86 + - *87 '503': description: Response content: @@ -39737,7 +39348,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#move-a-project-column parameters: - - *247 + - *246 requestBody: required: true content: @@ -39794,15 +39405,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-a-project parameters: - - *241 + - *240 responses: '200': description: Response content: application/json: - schema: *202 + schema: *196 examples: - default: &250 + default: &249 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -39855,7 +39466,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#update-a-project parameters: - - *241 + - *240 requestBody: required: false content: @@ -39904,9 +39515,9 @@ paths: description: Response content: application/json: - schema: *202 + schema: *196 examples: - default: *250 + default: *249 '404': description: Not Found if the authenticated user does not have access to the project @@ -39927,7 +39538,7 @@ paths: items: type: string '401': *23 - '410': *251 + '410': *250 '422': *7 x-github: githubCloudOnly: false @@ -39945,7 +39556,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#delete-a-project parameters: - - *241 + - *240 responses: '204': description: Delete Success @@ -39966,7 +39577,7 @@ paths: items: type: string '401': *23 - '410': *251 + '410': *250 '404': *6 x-github: githubCloudOnly: false @@ -39989,7 +39600,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#list-project-collaborators parameters: - - *241 + - *240 - 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 @@ -40016,9 +39627,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 '404': *6 '422': *15 '304': *35 @@ -40041,8 +39652,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#add-project-collaborator parameters: - - *241 - - *121 + - *240 + - *115 requestBody: required: false content: @@ -40091,8 +39702,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator parameters: - - *241 - - *121 + - *240 + - *115 responses: '204': description: Response @@ -40120,8 +39731,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user parameters: - - *241 - - *121 + - *240 + - *115 responses: '200': description: Response @@ -40185,7 +39796,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#list-project-columns parameters: - - *241 + - *240 - *17 - *18 responses: @@ -40195,7 +39806,7 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: default: value: @@ -40208,7 +39819,7 @@ paths: created_at: '2016-09-05T14:18:44Z' updated_at: '2016-09-05T14:22:28Z' headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -40227,7 +39838,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#create-a-project-column parameters: - - *241 + - *240 requestBody: required: true content: @@ -40251,7 +39862,7 @@ paths: description: Response content: application/json: - schema: *248 + schema: *247 examples: default: value: @@ -40312,7 +39923,7 @@ paths: resources: type: object properties: - core: &252 + core: &251 title: Rate Limit type: object properties: @@ -40329,19 +39940,20 @@ paths: - remaining - reset - used - 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 + graphql: *251 + search: *251 + code_search: *251 + source_import: *251 + integration_manifest: *251 + code_scanning_upload: *251 + actions_runner_registration: *251 + scim: *251 + dependency_snapshots: *251 + code_scanning_autofix: *251 required: - core - search - rate: *252 + rate: *251 required: - rate - resources @@ -40399,6 +40011,11 @@ paths: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -40440,14 +40057,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *253 + schema: *252 examples: default-response: summary: Default response @@ -40948,7 +40565,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *254 + '301': *253 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40966,8 +40583,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: + - *241 - *242 - - *243 requestBody: required: false content: @@ -41204,10 +40821,10 @@ paths: description: Response content: application/json: - schema: *253 + schema: *252 examples: - default: *255 - '307': &256 + default: *254 + '307': &255 description: Temporary Redirect content: application/json: @@ -41236,8 +40853,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -41259,7 +40876,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *256 + '307': *255 '404': *6 x-github: githubCloudOnly: false @@ -41282,11 +40899,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: + - *241 - *242 - - *243 - *17 - *18 - - &282 + - &281 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -41309,7 +40926,7 @@ paths: type: integer artifacts: type: array - items: &257 + items: &256 title: Artifact description: An artifact type: object @@ -41395,7 +41012,7 @@ paths: - expires_at - updated_at examples: - default: &283 + default: &282 value: total_count: 2 artifacts: @@ -41432,7 +41049,7 @@ paths: head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41454,9 +41071,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: + - *241 - *242 - - *243 - - &258 + - &257 name: artifact_id description: The unique identifier of the artifact. in: path @@ -41468,7 +41085,7 @@ paths: description: Response content: application/json: - schema: *257 + schema: *256 examples: default: value: @@ -41505,9 +41122,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: + - *241 - *242 - - *243 - - *258 + - *257 responses: '204': description: Response @@ -41531,9 +41148,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: + - *241 - *242 - - *243 - - *258 + - *257 - name: archive_format in: path required: true @@ -41547,7 +41164,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': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41570,14 +41187,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *259 + schema: *258 examples: default: value: @@ -41603,11 +41220,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: + - *241 - *242 - - *243 - *17 - *18 - - &260 + - &259 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 @@ -41635,13 +41252,13 @@ paths: - last_accessed_at - size_in_bytes default: last_accessed_at - - *40 + - *37 responses: '200': description: Response content: application/json: - schema: &261 + schema: &260 title: Repository actions caches description: Repository actions caches type: object @@ -41691,7 +41308,7 @@ paths: - total_count - actions_caches examples: - default: &262 + default: &261 value: total_count: 1 actions_caches: @@ -41703,7 +41320,7 @@ paths: created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41723,23 +41340,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: + - *241 - *242 - - *243 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *260 + - *259 responses: '200': description: Response content: application/json: - schema: *261 + schema: *260 examples: - default: *262 + default: *261 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41759,8 +41376,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: + - *241 - *242 - - *243 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -41791,9 +41408,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: + - *241 - *242 - - *243 - - &263 + - &262 name: job_id description: The unique identifier of the job. in: path @@ -41805,7 +41422,7 @@ paths: description: Response content: application/json: - schema: &286 + schema: &285 title: Job description: Information of a job execution in a workflow run type: object @@ -42152,9 +41769,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: + - *241 - *242 - - *243 - - *263 + - *262 responses: '302': description: Response @@ -42182,9 +41799,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: + - *241 - *242 - - *243 - - *263 + - *262 requestBody: required: false content: @@ -42206,7 +41823,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -42230,8 +41847,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: + - *241 - *242 - - *243 responses: '200': description: Status response @@ -42281,8 +41898,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: + - *241 - *242 - - *243 requestBody: required: true content: @@ -42316,7 +41933,7 @@ paths: description: Empty response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -42345,8 +41962,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -42364,7 +41981,7 @@ paths: type: integer secrets: type: array - items: &288 + items: &287 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -42385,7 +42002,7 @@ paths: - created_at - updated_at examples: - default: &289 + default: &288 value: total_count: 2 secrets: @@ -42396,7 +42013,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42418,9 +42035,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: + - *241 - *242 - - *243 - - *264 + - *263 - *18 responses: '200': @@ -42437,7 +42054,7 @@ paths: type: integer variables: type: array - items: &292 + items: &291 title: Actions Variable type: object properties: @@ -42471,7 +42088,7 @@ paths: - created_at - updated_at examples: - default: &293 + default: &292 value: total_count: 2 variables: @@ -42484,7 +42101,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42504,8 +42121,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -42514,11 +42131,11 @@ paths: schema: type: object properties: - enabled: &266 + enabled: &265 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *98 - selected_actions_url: *265 + allowed_actions: *92 + selected_actions_url: *264 required: - enabled examples: @@ -42545,8 +42162,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -42557,8 +42174,8 @@ paths: schema: type: object properties: - enabled: *266 - allowed_actions: *98 + enabled: *265 + allowed_actions: *92 required: - enabled examples: @@ -42587,14 +42204,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: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: &267 + schema: &266 type: object properties: access_level: @@ -42611,7 +42228,7 @@ paths: required: - access_level examples: - default: &268 + default: &267 value: access_level: organization x-github: @@ -42635,15 +42252,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: + - *241 - *242 - - *243 requestBody: required: true content: application/json: - schema: *267 + schema: *266 examples: - default: *268 + default: *267 responses: '204': description: Response @@ -42667,16 +42284,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *100 + schema: *94 examples: - default: *101 + default: *95 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -42695,8 +42312,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -42704,9 +42321,9 @@ paths: required: false content: application/json: - schema: *100 + schema: *94 examples: - selected_actions: *101 + selected_actions: *95 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -42728,16 +42345,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *269 + schema: *268 examples: - default: *104 + default: *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42758,8 +42375,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: + - *241 - *242 - - *243 responses: '204': description: Success response @@ -42770,9 +42387,9 @@ paths: required: true content: application/json: - schema: *270 + schema: *269 examples: - default: *104 + default: *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42799,8 +42416,8 @@ paths: in: query schema: type: string + - *241 - *242 - - *243 - *17 - *18 responses: @@ -42818,11 +42435,11 @@ paths: type: integer runners: type: array - items: *110 + items: *104 examples: - default: *111 + default: *105 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42844,8 +42461,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -42853,9 +42470,9 @@ paths: application/json: schema: type: array - items: *271 + items: *270 examples: - default: *272 + default: *271 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42877,8 +42494,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: + - *241 - *242 - - *243 requestBody: required: true content: @@ -42921,7 +42538,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *273 + '201': *272 '404': *6 '422': *7 x-github: @@ -42951,16 +42568,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: + - *241 - *242 - - *243 responses: '201': description: Response content: application/json: - schema: *112 + schema: *106 examples: - default: *274 + default: *273 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42988,16 +42605,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: + - *241 - *242 - - *243 responses: '201': description: Response content: application/json: - schema: *112 + schema: *106 examples: - default: *275 + default: *274 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43019,17 +42636,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: + - *241 - *242 - - *243 - - *109 + - *103 responses: '200': description: Response content: application/json: - schema: *110 + schema: *104 examples: - default: *276 + default: *275 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43050,9 +42667,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: + - *241 - *242 - - *243 - - *109 + - *103 responses: '204': description: Response @@ -43077,11 +42694,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: + - *241 - *242 - - *243 - - *109 + - *103 responses: - '200': *114 + '200': *108 '404': *6 x-github: githubCloudOnly: false @@ -43103,9 +42720,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: + - *241 - *242 - - *243 - - *109 + - *103 requestBody: required: true content: @@ -43129,7 +42746,7 @@ paths: - gpu - accelerated responses: - '200': *114 + '200': *108 '404': *6 '422': *7 x-github: @@ -43153,9 +42770,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: + - *241 - *242 - - *243 - - *109 + - *103 requestBody: required: true content: @@ -43180,7 +42797,7 @@ paths: - gpu - accelerated responses: - '200': *114 + '200': *108 '404': *6 '422': *7 x-github: @@ -43204,11 +42821,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: + - *241 - *242 - - *243 - - *109 + - *103 responses: - '200': *277 + '200': *276 '404': *6 x-github: githubCloudOnly: false @@ -43235,12 +42852,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: + - *241 - *242 - - *243 - - *109 - - *278 + - *103 + - *277 responses: - '200': *114 + '200': *108 '404': *6 '422': *7 x-github: @@ -43266,9 +42883,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: + - *241 - *242 - - *243 - - &296 + - &295 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. @@ -43276,7 +42893,7 @@ paths: required: false schema: type: string - - &297 + - &296 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -43284,7 +42901,7 @@ paths: required: false schema: type: string - - &298 + - &297 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -43293,7 +42910,7 @@ paths: required: false schema: type: string - - &299 + - &298 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 @@ -43320,7 +42937,7 @@ paths: - pending - *17 - *18 - - &300 + - &299 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)." @@ -43329,7 +42946,7 @@ paths: schema: type: string format: date-time - - &279 + - &278 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -43338,13 +42955,13 @@ paths: schema: type: boolean default: false - - &301 + - &300 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &302 + - &301 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -43367,7 +42984,7 @@ paths: type: integer workflow_runs: type: array - items: &280 + items: &279 title: Workflow Run description: An invocation of a workflow type: object @@ -43484,7 +43101,7 @@ paths: type: - array - 'null' - items: &321 + items: &320 title: Pull Request Minimal type: object properties: @@ -43611,7 +43228,7 @@ paths: head_commit: anyOf: - type: 'null' - - &325 + - &324 title: Simple Commit description: A commit. type: object @@ -43685,8 +43302,8 @@ paths: - timestamp - author - committer - repository: *108 - head_repository: *108 + repository: *102 + head_repository: *102 head_repository_id: type: integer examples: @@ -43726,7 +43343,7 @@ paths: - workflow_url - pull_requests examples: - default: &303 + default: &302 value: total_count: 1 workflow_runs: @@ -43940,7 +43557,7 @@ paths: releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43962,24 +43579,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: + - *241 - *242 - - *243 - - &281 + - &280 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *279 + - *278 responses: '200': description: Response content: application/json: - schema: *280 + schema: *279 examples: - default: &284 + default: &283 value: id: 30433642 name: Build @@ -44220,9 +43837,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: + - *241 - *242 - - *243 - - *281 + - *280 responses: '204': description: Response @@ -44245,9 +43862,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: + - *241 - *242 - - *243 - - *281 + - *280 responses: '200': description: Response @@ -44375,15 +43992,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: + - *241 - *242 - - *243 - - *281 + - *280 responses: '201': description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -44410,12 +44027,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: + - *241 - *242 - - *243 - - *281 + - *280 - *17 - *18 - - *282 + - *281 responses: '200': description: Response @@ -44431,11 +44048,11 @@ paths: type: integer artifacts: type: array - items: *257 + items: *256 examples: - default: *283 + default: *282 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44457,25 +44074,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: + - *241 - *242 - - *243 - - *281 - - &285 + - *280 + - &284 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *279 + - *278 responses: '200': description: Response content: application/json: - schema: *280 + schema: *279 examples: - default: *284 + default: *283 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44498,10 +44115,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: + - *241 - *242 - - *243 - - *281 - - *285 + - *280 + - *284 - *17 - *18 responses: @@ -44519,9 +44136,9 @@ paths: type: integer jobs: type: array - items: *286 + items: *285 examples: - default: &287 + default: &286 value: total_count: 1 jobs: @@ -44610,7 +44227,7 @@ paths: workflow_name: CI head_branch: main headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -44634,10 +44251,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: + - *241 - *242 - - *243 - - *281 - - *285 + - *280 + - *284 responses: '302': description: Response @@ -44665,19 +44282,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: + - *241 - *242 - - *243 - - *281 + - *280 responses: '202': description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44700,9 +44317,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: + - *241 - *242 - - *243 - - *281 + - *280 requestBody: required: true content: @@ -44769,19 +44386,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: + - *241 - *242 - - *243 - - *281 + - *280 responses: '202': description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44804,9 +44421,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: + - *241 - *242 - - *243 - - *281 + - *280 - 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 @@ -44836,11 +44453,11 @@ paths: type: integer jobs: type: array - items: *286 + items: *285 examples: - default: *287 + default: *286 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44863,9 +44480,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: + - *241 - *242 - - *243 - - *281 + - *280 responses: '302': description: Response @@ -44892,14 +44509,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: + - *241 - *242 - - *243 - - *281 + - *280 responses: '204': description: Response '403': *27 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44921,9 +44538,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: + - *241 - *242 - - *243 - - *281 + - *280 responses: '200': description: Response @@ -44992,7 +44609,7 @@ paths: items: type: object properties: - type: &396 + type: &395 type: string description: The type of reviewer. enum: @@ -45003,7 +44620,7 @@ paths: reviewer: anyOf: - *4 - - *173 + - *166 required: - environment - wait_timer @@ -45078,9 +44695,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: + - *241 - *242 - - *243 - - *281 + - *280 requestBody: required: true content: @@ -45130,7 +44747,7 @@ paths: application/json: schema: type: array - items: &391 + items: &390 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -45242,7 +44859,7 @@ paths: - created_at - updated_at examples: - default: &392 + default: &391 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -45298,9 +44915,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: + - *241 - *242 - - *243 - - *281 + - *280 requestBody: required: false content: @@ -45322,7 +44939,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -45345,9 +44962,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: + - *241 - *242 - - *243 - - *281 + - *280 requestBody: required: false content: @@ -45369,7 +44986,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -45394,9 +45011,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: + - *241 - *242 - - *243 - - *281 + - *280 responses: '200': description: Response @@ -45533,8 +45150,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -45552,11 +45169,11 @@ paths: type: integer secrets: type: array - items: *288 + items: *287 examples: - default: *289 + default: *288 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45579,16 +45196,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *290 + schema: *289 examples: - default: *291 + default: *290 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45610,17 +45227,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 responses: '200': description: Response content: application/json: - schema: *288 + schema: *287 examples: - default: &409 + default: &408 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -45646,9 +45263,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 requestBody: required: true content: @@ -45676,7 +45293,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -45702,9 +45319,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 responses: '204': description: Response @@ -45729,9 +45346,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: + - *241 - *242 - - *243 - - *264 + - *263 - *18 responses: '200': @@ -45748,11 +45365,11 @@ paths: type: integer variables: type: array - items: *292 + items: *291 examples: - default: *293 + default: *292 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45773,8 +45390,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -45801,7 +45418,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -45826,17 +45443,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: + - *241 - *242 - - *243 - - *119 + - *113 responses: '200': description: Response content: application/json: - schema: *292 + schema: *291 examples: - default: &410 + default: &409 value: name: USERNAME value: octocat @@ -45862,9 +45479,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: + - *241 - *242 - - *243 - - *119 + - *113 requestBody: required: true content: @@ -45906,9 +45523,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: + - *241 - *242 - - *243 - - *119 + - *113 responses: '204': description: Response @@ -45933,8 +45550,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -45952,7 +45569,7 @@ paths: type: integer workflows: type: array - items: &294 + items: &293 title: Workflow description: A GitHub Actions workflow type: object @@ -46047,7 +45664,7 @@ paths: html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289 badge_url: https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46070,9 +45687,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: + - *241 - *242 - - *243 - - &295 + - &294 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -46087,7 +45704,7 @@ paths: description: Response content: application/json: - schema: *294 + schema: *293 examples: default: value: @@ -46120,9 +45737,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: + - *241 - *242 - - *243 - - *295 + - *294 responses: '204': description: Response @@ -46147,9 +45764,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: + - *241 - *242 - - *243 - - *295 + - *294 responses: '204': description: Response @@ -46200,9 +45817,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: + - *241 - *242 - - *243 - - *295 + - *294 responses: '204': description: Response @@ -46229,19 +45846,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: + - *241 - *242 - - *243 + - *294 - *295 - *296 - *297 - *298 - - *299 - *17 - *18 + - *299 + - *278 - *300 - - *279 - *301 - - *302 responses: '200': description: Response @@ -46257,11 +45874,11 @@ paths: type: integer workflow_runs: type: array - items: *280 + items: *279 examples: - default: *303 + default: *302 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46285,9 +45902,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: + - *241 - *242 - - *243 - - *295 + - *294 responses: '200': description: Response @@ -46348,12 +45965,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: + - *241 - *242 - - *243 - - *40 + - *37 - *17 - - *41 - - *42 + - *38 + - *39 - name: ref description: |- The Git reference for the activities you want to list. @@ -46498,7 +46115,7 @@ paths: type: User site_admin: false headers: - Link: *37 + Link: *50 '422': *7 x-github: githubCloudOnly: false @@ -46517,8 +46134,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -46530,9 +46147,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -46555,8 +46172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: + - *241 - *242 - - *243 - name: assignee in: path required: true @@ -46592,8 +46209,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -46705,11 +46322,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: + - *241 - *242 - - *243 - *17 - - *41 - - *42 + - *38 + - *39 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -46749,8 +46366,10 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: - default: *304 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46770,8 +46389,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -46779,7 +46398,7 @@ paths: application/json: schema: type: array - items: &305 + items: &304 title: Autolink reference description: An autolink reference. type: object @@ -46833,8 +46452,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -46873,9 +46492,9 @@ paths: description: response content: application/json: - schema: *305 + schema: *304 examples: - default: &306 + default: &305 value: id: 1 key_prefix: TICKET- @@ -46906,9 +46525,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: + - *241 - *242 - - *243 - - &307 + - &306 name: autolink_id description: The unique identifier of the autolink. in: path @@ -46920,9 +46539,9 @@ paths: description: Response content: application/json: - schema: *305 + schema: *304 examples: - default: *306 + default: *305 '404': *6 x-github: githubCloudOnly: false @@ -46942,9 +46561,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: + - *241 - *242 - - *243 - - *307 + - *306 responses: '204': description: Response @@ -46968,8 +46587,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: + - *241 - *242 - - *243 responses: '200': description: Response if Dependabot is enabled @@ -47019,8 +46638,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-automated-security-fixes parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -47041,8 +46660,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-automated-security-fixes parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -47062,8 +46681,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: + - *241 - *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. @@ -47101,7 +46720,7 @@ paths: - url protected: type: boolean - protection: &309 + protection: &308 title: Branch Protection description: Branch Protection type: object @@ -47144,7 +46763,7 @@ paths: required: - contexts - checks - enforce_admins: &312 + enforce_admins: &311 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -47161,7 +46780,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &314 + required_pull_request_reviews: &313 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -47183,7 +46802,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *173 + items: *166 apps: description: The list of apps with review dismissal access. @@ -47215,7 +46834,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *173 + items: *166 apps: description: The list of apps allowed to bypass pull request requirements. @@ -47245,7 +46864,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &311 + restrictions: &310 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -47552,7 +47171,7 @@ paths: - linter protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -47570,9 +47189,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: + - *241 - *242 - - *243 - - &310 + - &309 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). @@ -47586,14 +47205,14 @@ paths: description: Response content: application/json: - schema: &320 + schema: &319 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &367 + commit: &366 title: Commit description: Commit type: object @@ -47632,7 +47251,7 @@ paths: author: anyOf: - type: 'null' - - &308 + - &307 title: Git User description: Metaproperties for Git author/committer information. @@ -47653,7 +47272,7 @@ paths: committer: anyOf: - type: 'null' - - *308 + - *307 message: type: string examples: @@ -47677,7 +47296,7 @@ paths: required: - sha - url - verification: &416 + verification: &415 title: Verification type: object properties: @@ -47712,14 +47331,14 @@ paths: author: oneOf: - *4 - - *117 + - *111 type: - 'null' - object committer: oneOf: - *4 - - *117 + - *111 type: - 'null' - object @@ -47756,7 +47375,7 @@ paths: type: integer files: type: array - items: &379 + items: &378 title: Diff Entry description: Diff Entry type: object @@ -47850,7 +47469,7 @@ paths: - self protected: type: boolean - protection: *309 + protection: *308 protection_url: type: string format: uri @@ -47959,7 +47578,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *254 + '301': *253 '404': *6 x-github: githubCloudOnly: false @@ -47981,15 +47600,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response content: application/json: - schema: *309 + schema: *308 examples: default: value: @@ -48183,9 +47802,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: true content: @@ -48445,7 +48064,7 @@ paths: url: type: string format: uri - required_status_checks: &317 + required_status_checks: &316 title: Status Check Policy description: Status Check Policy type: object @@ -48526,7 +48145,7 @@ paths: items: *4 teams: type: array - items: *173 + items: *166 apps: type: array items: *5 @@ -48544,7 +48163,7 @@ paths: items: *4 teams: type: array - items: *173 + items: *166 apps: type: array items: *5 @@ -48604,7 +48223,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *311 + restrictions: *310 required_conversation_resolution: type: object properties: @@ -48716,9 +48335,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '204': description: Response @@ -48743,17 +48362,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response content: application/json: - schema: *312 + schema: *311 examples: - default: &313 + default: &312 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -48775,17 +48394,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response content: application/json: - schema: *312 + schema: *311 examples: - default: *313 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48804,9 +48423,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '204': description: Response @@ -48831,17 +48450,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response content: application/json: - schema: *314 + schema: *313 examples: - default: &315 + default: &314 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -48937,9 +48556,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: false content: @@ -49037,9 +48656,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *313 examples: - default: *315 + default: *314 '422': *15 x-github: githubCloudOnly: false @@ -49060,9 +48679,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '204': description: Response @@ -49089,17 +48708,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response content: application/json: - schema: *312 + schema: *311 examples: - default: &316 + default: &315 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -49122,17 +48741,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response content: application/json: - schema: *312 + schema: *311 examples: - default: *316 + default: *315 '404': *6 x-github: githubCloudOnly: false @@ -49152,9 +48771,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '204': description: Response @@ -49179,17 +48798,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response content: application/json: - schema: *317 + schema: *316 examples: - default: &318 + default: &317 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -49215,9 +48834,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: false content: @@ -49269,9 +48888,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *316 examples: - default: *318 + default: *317 '404': *6 '422': *15 x-github: @@ -49293,9 +48912,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '204': description: Response @@ -49319,9 +48938,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response @@ -49355,9 +48974,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: false content: @@ -49424,9 +49043,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: false content: @@ -49490,9 +49109,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: content: application/json: @@ -49558,15 +49177,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response content: application/json: - schema: *311 + schema: *310 examples: default: value: @@ -49657,9 +49276,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '204': description: Response @@ -49682,9 +49301,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response @@ -49694,7 +49313,7 @@ paths: type: array items: *5 examples: - default: &319 + default: &318 value: - id: 1 slug: octoapp @@ -49751,9 +49370,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: true content: @@ -49787,7 +49406,7 @@ paths: type: array items: *5 examples: - default: *319 + default: *318 '422': *15 x-github: githubCloudOnly: false @@ -49808,9 +49427,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: true content: @@ -49844,7 +49463,7 @@ paths: type: array items: *5 examples: - default: *319 + default: *318 '422': *15 x-github: githubCloudOnly: false @@ -49865,9 +49484,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: true content: @@ -49901,7 +49520,7 @@ paths: type: array items: *5 examples: - default: *319 + default: *318 '422': *15 x-github: githubCloudOnly: false @@ -49923,9 +49542,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response @@ -49933,9 +49552,9 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - default: *188 + default: *182 '404': *6 x-github: githubCloudOnly: false @@ -49955,9 +49574,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: false content: @@ -49993,9 +49612,9 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - default: *188 + default: *182 '422': *15 x-github: githubCloudOnly: false @@ -50016,9 +49635,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: false content: @@ -50054,9 +49673,9 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - default: *188 + default: *182 '422': *15 x-github: githubCloudOnly: false @@ -50077,9 +49696,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: content: application/json: @@ -50114,9 +49733,9 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - default: *188 + default: *182 '422': *15 x-github: githubCloudOnly: false @@ -50138,9 +49757,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response @@ -50150,7 +49769,7 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 '404': *6 x-github: githubCloudOnly: false @@ -50174,9 +49793,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: true content: @@ -50209,7 +49828,7 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 '422': *15 x-github: githubCloudOnly: false @@ -50234,9 +49853,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: true content: @@ -50269,7 +49888,7 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 '422': *15 x-github: githubCloudOnly: false @@ -50294,9 +49913,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: true content: @@ -50329,7 +49948,7 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 '422': *15 x-github: githubCloudOnly: false @@ -50356,9 +49975,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: true content: @@ -50380,7 +49999,7 @@ paths: description: Response content: application/json: - schema: *320 + schema: *319 examples: default: value: @@ -50496,8 +50115,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -50776,7 +50395,7 @@ paths: description: Response content: application/json: - schema: &322 + schema: &321 title: CheckRun description: A check performed on the code of a given code change type: object @@ -50911,8 +50530,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *321 - deployment: &600 + items: *320 + deployment: &599 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -51199,9 +50818,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: + - *241 - *242 - - *243 - - &323 + - &322 name: check_run_id description: The unique identifier of the check run. in: path @@ -51213,9 +50832,9 @@ paths: description: Response content: application/json: - schema: *322 + schema: *321 examples: - default: &324 + default: &323 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -51315,9 +50934,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: + - *241 - *242 - - *243 - - *323 + - *322 requestBody: required: true content: @@ -51557,9 +51176,9 @@ paths: description: Response content: application/json: - schema: *322 + schema: *321 examples: - default: *324 + default: *323 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51579,9 +51198,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: + - *241 - *242 - - *243 - - *323 + - *322 - *17 - *18 responses: @@ -51671,7 +51290,7 @@ paths: raw_details: Do you mean 'bananas' or 'banana'? blob_href: https://api.github.com/repos/github/rest-api-description/git/blobs/abc headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51693,15 +51312,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: + - *241 - *242 - - *243 - - *323 + - *322 responses: '201': description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -51739,8 +51358,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -51762,7 +51381,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &326 + schema: &325 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -51844,12 +51463,12 @@ paths: type: - array - 'null' - items: *321 + items: *320 app: anyOf: - type: 'null' - *5 - repository: *108 + repository: *102 created_at: type: - string @@ -51860,7 +51479,7 @@ paths: - string - 'null' format: date-time - head_commit: *325 + head_commit: *324 latest_check_runs_count: type: integer check_runs_url: @@ -51888,7 +51507,7 @@ paths: - check_runs_url - pull_requests examples: - default: &327 + default: &326 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -52179,9 +51798,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *326 + schema: *325 examples: - default: *327 + default: *326 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52200,8 +51819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -52262,7 +51881,7 @@ paths: required: - app_id - setting - repository: *108 + repository: *102 examples: default: value: @@ -52510,9 +52129,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: + - *241 - *242 - - *243 - - &328 + - &327 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -52524,9 +52143,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *325 examples: - default: *327 + default: *326 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52549,17 +52168,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: + - *241 - *242 - - *243 - - *328 - - &374 + - *327 + - &373 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &375 + - &374 name: status description: Returns check runs with the specified `status`. in: query @@ -52598,9 +52217,9 @@ paths: type: integer check_runs: type: array - items: *322 + items: *321 examples: - default: &376 + default: &375 value: total_count: 1 check_runs: @@ -52682,7 +52301,7 @@ paths: url: https://api.github.com/repos/github/hello-world name: hello-world headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52702,15 +52321,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: + - *241 - *242 - - *243 - - *328 + - *327 responses: '201': description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -52737,30 +52356,30 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: + - *241 - *242 - - *243 + - *328 - *329 - - *330 - *18 - *17 - - &343 + - &342 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: *331 - - &344 + schema: *330 + - &343 name: pr description: The number of the pull request for the results you want to list. in: query required: false schema: type: integer - - *40 - - *41 - - *42 + - *37 + - *38 + - *39 - name: sort description: The property by which to sort the results. in: query @@ -52776,13 +52395,13 @@ paths: be returned. in: query required: false - schema: *332 + schema: *331 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *333 + schema: *332 responses: '200': description: Response @@ -52793,24 +52412,24 @@ paths: items: type: object properties: - number: *46 - created_at: *47 - updated_at: *48 - url: *49 - html_url: *50 - instances_url: *334 - state: *126 - fixed_at: *122 + number: *44 + created_at: *45 + updated_at: *46 + url: *47 + html_url: *48 + instances_url: *333 + state: *120 + fixed_at: *116 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *123 - dismissed_reason: *335 - dismissed_comment: *336 - rule: *337 - tool: *338 - most_recent_instance: *339 + dismissed_at: *117 + dismissed_reason: *334 + dismissed_comment: *335 + rule: *336 + tool: *337 + most_recent_instance: *338 required: - number - created_at @@ -52926,14 +52545,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &340 + '403': &339 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52953,9 +52572,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: + - *241 - *242 - - *243 - - &341 + - &340 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -52963,30 +52582,30 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *46 + schema: *44 responses: '200': description: Response content: application/json: - schema: &342 + schema: &341 type: object properties: - number: *46 - created_at: *47 - updated_at: *48 - url: *49 - html_url: *50 - instances_url: *334 - state: *126 - fixed_at: *122 + number: *44 + created_at: *45 + updated_at: *46 + url: *47 + html_url: *48 + instances_url: *333 + state: *120 + fixed_at: *116 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *123 - dismissed_reason: *335 - dismissed_comment: *336 + dismissed_at: *117 + dismissed_reason: *334 + dismissed_comment: *335 rule: type: object properties: @@ -53048,8 +52667,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *338 - most_recent_instance: *339 + tool: *337 + most_recent_instance: *338 required: - number - created_at @@ -53138,9 +52757,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *340 + '403': *339 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53158,9 +52777,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: + - *241 - *242 - - *243 - - *341 + - *340 requestBody: required: true content: @@ -53175,8 +52794,8 @@ paths: enum: - open - dismissed - dismissed_reason: *335 - dismissed_comment: *336 + dismissed_reason: *334 + dismissed_comment: *335 required: - state examples: @@ -53191,7 +52810,7 @@ paths: description: Response content: application/json: - schema: *342 + schema: *341 examples: default: value: @@ -53266,14 +52885,14 @@ paths: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '403': &349 + '403': &348 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *60 + '503': *55 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53293,13 +52912,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: + - *241 - *242 - - *243 - - *341 + - *340 - *18 - *17 + - *342 - *343 - - *344 responses: '200': description: Response @@ -53307,7 +52926,7 @@ paths: application/json: schema: type: array - items: *339 + items: *338 examples: default: value: @@ -53346,9 +52965,9 @@ paths: end_column: 50 classifications: - source - '403': *340 + '403': *339 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53380,30 +52999,30 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: + - *241 - *242 - - *243 + - *328 - *329 - - *330 - *18 - *17 - - *344 + - *343 - 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: *331 + schema: *330 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &347 + schema: &346 type: string description: An identifier for the upload. examples: - 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - - *40 + - *37 - name: sort description: The property by which to sort the results. in: query @@ -53420,23 +53039,23 @@ paths: application/json: schema: type: array - items: &348 + items: &347 type: object properties: - ref: *331 - commit_sha: &357 + ref: *330 + commit_sha: &356 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: *345 + analysis_key: *344 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *346 + category: *345 error: type: string examples: @@ -53461,8 +53080,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *347 - tool: *338 + sarif_id: *346 + tool: *337 deletable: type: boolean warning: @@ -53524,9 +53143,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *340 + '403': *339 '404': *6 - '503': *60 + '503': *55 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53560,8 +53179,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: + - *241 - *242 - - *243 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -53574,7 +53193,7 @@ paths: description: Response content: application/json: - schema: *348 + schema: *347 examples: response: summary: application/json response @@ -53628,9 +53247,9 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *340 + '403': *339 '404': *6 - '503': *60 + '503': *55 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53710,8 +53329,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: + - *241 - *242 - - *243 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -53767,9 +53386,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *349 + '403': *348 '404': *6 - '503': *60 + '503': *55 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53789,8 +53408,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -53798,7 +53417,7 @@ paths: application/json: schema: type: array - items: &350 + items: &349 title: CodeQL Database description: A CodeQL database. type: object @@ -53910,9 +53529,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': *340 + '403': *339 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53939,8 +53558,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: + - *241 - *242 - - *243 - name: language in: path description: The language of the CodeQL database. @@ -53952,7 +53571,7 @@ paths: description: Response content: application/json: - schema: *350 + schema: *349 examples: default: value: @@ -53984,11 +53603,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': &381 + '302': &380 description: Found - '403': *340 + '403': *339 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54008,8 +53627,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: + - *241 - *242 - - *243 - name: language in: path description: The language of the CodeQL database. @@ -54019,9 +53638,9 @@ paths: responses: '204': description: Response - '403': *349 + '403': *348 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54047,8 +53666,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -54057,7 +53676,7 @@ paths: type: object additionalProperties: false properties: - language: &351 + language: &350 type: string description: The language targeted by the CodeQL query enum: @@ -54135,7 +53754,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &355 + schema: &354 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -54143,9 +53762,9 @@ paths: id: type: integer description: The ID of the variant analysis. - controller_repo: *51 + controller_repo: *49 actor: *4 - query_language: *351 + query_language: *350 query_pack_url: type: string description: The download url for the query pack. @@ -54193,7 +53812,7 @@ paths: items: type: object properties: - repository: &352 + repository: &351 title: Repository Identifier description: Repository Identifier type: object @@ -54235,7 +53854,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &356 + analysis_status: &355 type: string description: The new status of the CodeQL variant analysis repository task. @@ -54267,7 +53886,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &353 + access_mismatch_repos: &352 type: object properties: repository_count: @@ -54282,7 +53901,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: *352 + items: *351 required: - repository_count - repositories @@ -54305,8 +53924,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *353 - over_limit_repos: *353 + no_codeql_db_repos: *352 + over_limit_repos: *352 required: - access_mismatch_repos - not_found_repos @@ -54322,7 +53941,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &354 + value: &353 summary: Default response value: id: 1 @@ -54474,17 +54093,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *354 + value: *353 repository_lists: summary: Response for a successful variant analysis submission - value: *354 + value: *353 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54505,8 +54124,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: + - *241 - *242 - - *243 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -54518,11 +54137,11 @@ paths: description: Response content: application/json: - schema: *355 + schema: *354 examples: - default: *354 + default: *353 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54543,7 +54162,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: - - *242 + - *241 - name: repo in: path description: The name of the controller repository. @@ -54577,8 +54196,8 @@ paths: schema: type: object properties: - repository: *51 - analysis_status: *356 + repository: *49 + analysis_status: *355 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -54682,7 +54301,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54703,8 +54322,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -54769,9 +54388,9 @@ paths: query_suite: default updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *340 + '403': *339 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54790,8 +54409,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -54849,7 +54468,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -54874,7 +54493,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *349 + '403': *348 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -54882,7 +54501,7 @@ paths: content: application/json: schema: *3 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54939,8 +54558,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -54948,7 +54567,7 @@ paths: schema: type: object properties: - commit_sha: *357 + commit_sha: *356 ref: type: string description: |- @@ -55008,7 +54627,7 @@ paths: schema: type: object properties: - id: *347 + id: *346 url: type: string description: The REST API URL for checking the status of the upload. @@ -55022,11 +54641,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': *349 + '403': *348 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *60 + '503': *55 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -55045,8 +54664,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: + - *241 - *242 - - *243 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -55094,10 +54713,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': *340 + '403': *339 '404': description: Not Found if the sarif id does not match any upload - '503': *60 + '503': *55 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -55119,8 +54738,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: + - *241 - *242 - - *243 responses: '200': description: Response @@ -55144,7 +54763,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *127 + configuration: *121 examples: default: value: @@ -55173,7 +54792,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': *132 + '204': *126 '304': *35 '403': *27 '404': *6 @@ -55198,8 +54817,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: + - *241 - *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 @@ -55327,8 +54946,8 @@ paths: parameters: - *17 - *18 + - *241 - *242 - - *243 responses: '200': description: Response @@ -55344,7 +54963,7 @@ paths: type: integer codespaces: type: array - items: *177 + items: *170 examples: default: value: @@ -55620,7 +55239,7 @@ paths: start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop recent_folders: [] - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -55642,8 +55261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -55707,22 +55326,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '400': *14 '401': *23 '403': *27 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55746,8 +55365,8 @@ paths: parameters: - *17 - *18 + - *241 - *242 - - *243 responses: '200': description: Response @@ -55787,7 +55406,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *39 + '500': *127 '400': *14 '401': *23 '403': *27 @@ -55811,8 +55430,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: + - *241 - *242 - - *243 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -55849,9 +55468,9 @@ paths: type: integer machines: type: array - items: *359 + items: *358 examples: - default: &558 + default: &557 value: total_count: 2 machines: @@ -55868,7 +55487,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -55891,8 +55510,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: + - *241 - *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. @@ -55979,8 +55598,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: + - *241 - *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 @@ -56028,7 +55647,7 @@ paths: '403': *27 '404': *6 '422': *15 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56049,8 +55668,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -56068,7 +55687,7 @@ paths: type: integer secrets: type: array - items: &363 + items: &362 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -56089,9 +55708,9 @@ paths: - created_at - updated_at examples: - default: *360 + default: *359 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56112,16 +55731,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *361 + schema: *360 examples: - default: *362 + default: *361 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56141,17 +55760,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 responses: '200': description: Response content: application/json: - schema: *363 + schema: *362 examples: - default: *364 + default: *363 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56171,9 +55790,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 requestBody: required: true content: @@ -56201,7 +55820,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -56225,9 +55844,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 responses: '204': description: Response @@ -56255,8 +55874,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: + - *241 - *242 - - *243 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -56294,7 +55913,7 @@ paths: application/json: schema: type: array - items: &365 + items: &364 title: Collaborator description: Collaborator type: object @@ -56462,7 +56081,7 @@ paths: admin: false role_name: write headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -56487,9 +56106,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: + - *241 - *242 - - *243 - - *121 + - *115 responses: '204': description: Response if user is a collaborator @@ -56531,9 +56150,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: + - *241 - *242 - - *243 - - *121 + - *115 requestBody: required: false content: @@ -56559,7 +56178,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &429 + schema: &428 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -56571,7 +56190,7 @@ paths: format: int64 examples: - 42 - repository: *108 + repository: *102 invitee: anyOf: - type: 'null' @@ -56780,9 +56399,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: + - *241 - *242 - - *243 - - *121 + - *115 responses: '204': description: No Content when collaborator was removed from the repository. @@ -56811,9 +56430,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: + - *241 - *242 - - *243 - - *121 + - *115 responses: '200': description: if user has admin permissions @@ -56833,7 +56452,7 @@ paths: user: anyOf: - type: 'null' - - *365 + - *364 required: - permission - role_name @@ -56887,8 +56506,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -56898,7 +56517,7 @@ paths: application/json: schema: type: array - items: &366 + items: &365 title: Commit Comment description: Commit Comment type: object @@ -56939,8 +56558,8 @@ paths: updated_at: type: string format: date-time - author_association: *58 - reactions: *59 + author_association: *53 + reactions: *54 required: - url - html_url @@ -56956,7 +56575,7 @@ paths: - created_at - updated_at examples: - default: &369 + default: &368 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -56990,7 +56609,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' author_association: COLLABORATOR headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57015,17 +56634,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 responses: '200': description: Response content: application/json: - schema: *366 + schema: *365 examples: - default: &370 + default: &369 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -57082,9 +56701,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 requestBody: required: true content: @@ -57106,7 +56725,7 @@ paths: description: Response content: application/json: - schema: *366 + schema: *365 examples: default: value: @@ -57157,9 +56776,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 responses: '204': description: Response @@ -57180,9 +56799,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 - 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. @@ -57208,11 +56827,11 @@ paths: application/json: schema: type: array - items: *235 + items: *234 examples: - default: *237 + default: *236 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -57231,9 +56850,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 requestBody: required: true content: @@ -57265,16 +56884,16 @@ paths: description: Reaction exists content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '201': description: Reaction created content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '422': *15 x-github: githubCloudOnly: false @@ -57296,10 +56915,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: + - *241 - *242 - - *243 - - *71 - - *238 + - *66 + - *237 responses: '204': description: Response @@ -57348,8 +56967,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: + - *241 - *242 - - *243 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -57405,9 +57024,9 @@ paths: application/json: schema: type: array - items: *367 + items: *366 examples: - default: &477 + default: &476 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -57477,11 +57096,11 @@ paths: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: - Link: *37 - '500': *39 + Link: *50 + '500': *127 '400': *14 '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57501,9 +57120,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: + - *241 - *242 - - *243 - - &368 + - &367 name: commit_sha description: The SHA of the commit. in: path @@ -57550,7 +57169,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57575,9 +57194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: + - *241 - *242 - - *243 - - *368 + - *367 - *17 - *18 responses: @@ -57587,11 +57206,11 @@ paths: application/json: schema: type: array - items: *366 + items: *365 examples: - default: *369 + default: *368 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57617,9 +57236,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: + - *241 - *242 - - *243 - - *368 + - *367 requestBody: required: true content: @@ -57654,9 +57273,9 @@ paths: description: Response content: application/json: - schema: *366 + schema: *365 examples: - default: *370 + default: *369 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -57684,9 +57303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: + - *241 - *242 - - *243 - - *368 + - *367 - *17 - *18 responses: @@ -57696,7 +57315,7 @@ paths: application/json: schema: type: array - items: &468 + items: &467 title: Pull Request Simple description: Pull Request Simple type: object @@ -57816,7 +57435,7 @@ paths: milestone: anyOf: - type: 'null' - - *371 + - *370 active_lock_reason: type: - string @@ -57871,7 +57490,7 @@ paths: type: - array - 'null' - items: *173 + items: *166 head: type: object properties: @@ -57879,7 +57498,7 @@ paths: type: string ref: type: string - repo: *57 + repo: *52 sha: type: string user: @@ -57899,7 +57518,7 @@ paths: type: string ref: type: string - repo: *57 + repo: *52 sha: type: string user: @@ -57915,7 +57534,7 @@ paths: _links: type: object properties: - comments: &372 + comments: &371 title: Link description: Hypermedia Link type: object @@ -57924,13 +57543,13 @@ paths: type: string required: - href - commits: *372 - statuses: *372 - html: *372 - issue: *372 - review_comments: *372 - review_comment: *372 - self: *372 + commits: *371 + statuses: *371 + html: *371 + issue: *371 + review_comments: *371 + review_comment: *371 + self: *371 required: - comments - commits @@ -57940,8 +57559,8 @@ paths: - review_comments - review_comment - self - author_association: *58 - auto_merge: &470 + author_association: *53 + auto_merge: &469 title: Auto merge description: The status of auto merging a pull request. type: @@ -58006,7 +57625,7 @@ paths: - author_association - auto_merge examples: - default: &469 + default: &468 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -58485,8 +58104,8 @@ paths: auto_merge: draft: false headers: - Link: *37 - '409': *128 + Link: *50 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58543,11 +58162,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: + - *241 - *242 - - *243 - *18 - *17 - - &373 + - &372 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)" @@ -58562,9 +58181,9 @@ paths: description: Response content: application/json: - schema: *367 + schema: *366 examples: - default: &456 + default: &455 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -58650,9 +58269,9 @@ paths: ..... '422': *15 '404': *6 - '500': *39 - '503': *60 - '409': *128 + '500': *127 + '503': *55 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58677,11 +58296,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: + - *241 - *242 - - *243 + - *372 - *373 - *374 - - *375 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -58715,11 +58334,11 @@ paths: type: integer check_runs: type: array - items: *322 + items: *321 examples: - default: *376 + default: *375 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58742,9 +58361,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: + - *241 - *242 - - *243 - - *373 + - *372 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -58752,7 +58371,7 @@ paths: schema: type: integer example: 1 - - *374 + - *373 - *17 - *18 responses: @@ -58770,7 +58389,7 @@ paths: type: integer check_suites: type: array - items: *326 + items: *325 examples: default: value: @@ -58945,7 +58564,7 @@ paths: latest_check_runs_count: 1 check_runs_url: https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58970,9 +58589,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: + - *241 - *242 - - *243 - - *373 + - *372 - *17 - *18 responses: @@ -59043,7 +58662,7 @@ paths: type: string total_count: type: integer - repository: *108 + repository: *102 commit_url: type: string format: uri @@ -59174,9 +58793,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: + - *241 - *242 - - *243 - - *373 + - *372 - *17 - *18 responses: @@ -59186,7 +58805,7 @@ paths: application/json: schema: type: array - items: &532 + items: &531 title: Status description: The status of a commit. type: object @@ -59266,8 +58885,8 @@ paths: type: User site_admin: false headers: - Link: *37 - '301': *254 + Link: *50 + '301': *253 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59295,8 +58914,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -59329,11 +58948,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *377 + - *376 code_of_conduct_file: anyOf: - type: 'null' - - &378 + - &377 title: Community Health File type: object properties: @@ -59349,23 +58968,23 @@ paths: license: anyOf: - type: 'null' - - *73 + - *68 contributing: anyOf: - type: 'null' - - *378 + - *377 readme: anyOf: - type: 'null' - - *378 + - *377 issue_template: anyOf: - type: 'null' - - *378 + - *377 pull_request_template: anyOf: - type: 'null' - - *378 + - *377 required: - code_of_conduct - code_of_conduct_file @@ -59494,8 +59113,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: + - *241 - *242 - - *243 - *18 - *17 - name: basehead @@ -59543,8 +59162,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *367 - merge_base_commit: *367 + base_commit: *366 + merge_base_commit: *366 status: type: string enum: @@ -59568,10 +59187,10 @@ paths: - 6 commits: type: array - items: *367 + items: *366 files: type: array - items: *379 + items: *378 required: - url - html_url @@ -59814,8 +59433,8 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *6 - '500': *39 - '503': *60 + '500': *127 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59857,8 +59476,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: + - *241 - *242 - - *243 - name: path description: path parameter in: path @@ -60009,7 +59628,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &380 + response-if-content-is-a-file: &379 summary: Response if content is a file value: type: file @@ -60146,7 +59765,7 @@ paths: - size - type - url - - &482 + - &481 title: Content File description: Content File type: object @@ -60364,7 +59983,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *380 + response-if-content-is-a-file: *379 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -60433,7 +60052,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *381 + '302': *380 '304': *35 x-github: githubCloudOnly: false @@ -60456,8 +60075,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: + - *241 - *242 - - *243 - name: path description: path parameter in: path @@ -60552,7 +60171,7 @@ paths: description: Response content: application/json: - schema: &382 + schema: &381 title: File Commit description: File Commit type: object @@ -60708,7 +60327,7 @@ paths: description: Response content: application/json: - schema: *382 + schema: *381 examples: example-for-creating-a-file: value: @@ -60762,7 +60381,7 @@ paths: schema: oneOf: - *3 - - &411 + - &410 description: Repository rule violation was detected type: object properties: @@ -60783,7 +60402,7 @@ paths: items: type: object properties: - placeholder_id: &524 + placeholder_id: &523 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -60815,8 +60434,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: + - *241 - *242 - - *243 - name: path description: path parameter in: path @@ -60877,7 +60496,7 @@ paths: description: Response content: application/json: - schema: *382 + schema: *381 examples: default: value: @@ -60911,8 +60530,8 @@ paths: verified_at: '422': *15 '404': *6 - '409': *128 - '503': *60 + '409': *122 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60932,8 +60551,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: + - *241 - *242 - - *243 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -61034,7 +60653,7 @@ paths: site_admin: false contributions: 32 headers: - Link: *37 + Link: *50 '204': description: Response if repository is empty '403': *27 @@ -61057,21 +60676,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: + - *241 - *242 - - *243 - - *137 - - *138 - - *139 - - *140 + - *130 + - *131 + - *132 + - *133 - 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 - - *141 - - *142 - - *40 + - *134 + - *135 + - *37 - name: page description: "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead." @@ -61088,10 +60707,10 @@ paths: schema: type: integer default: 30 - - *41 - - *42 - - *143 - - *144 + - *38 + - *39 + - *136 + - *137 responses: '200': description: Response @@ -61099,11 +60718,11 @@ paths: application/json: schema: type: array - items: &385 + items: &384 type: object description: A Dependabot alert. properties: - number: *46 + number: *44 state: type: string description: The state of the Dependabot alert. @@ -61118,7 +60737,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: *43 + package: *40 manifest_path: type: string description: The full path to the dependency manifest file, @@ -61134,13 +60753,13 @@ paths: - development - runtime - - security_advisory: *383 - security_vulnerability: *45 - url: *49 - html_url: *50 - created_at: *47 - updated_at: *48 - dismissed_at: *123 + security_advisory: *382 + security_vulnerability: *42 + url: *47 + html_url: *48 + created_at: *45 + updated_at: *46 + dismissed_at: *117 dismissed_by: anyOf: - type: 'null' @@ -61164,8 +60783,8 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: *122 - auto_dismissed_at: *384 + fixed_at: *116 + auto_dismissed_at: *383 required: - number - state @@ -61392,9 +61011,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: + - *241 - *242 - - *243 - - &386 + - &385 name: alert_number in: path description: |- @@ -61403,13 +61022,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *46 + schema: *44 responses: '200': description: Response content: application/json: - schema: *385 + schema: *384 examples: default: value: @@ -61519,9 +61138,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: + - *241 - *242 - - *243 - - *386 + - *385 requestBody: required: true content: @@ -61566,7 +61185,7 @@ paths: description: Response content: application/json: - schema: *385 + schema: *384 examples: default: value: @@ -61672,7 +61291,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *128 + '409': *122 '422': *7 x-github: githubCloudOnly: false @@ -61695,8 +61314,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -61714,7 +61333,7 @@ paths: type: integer secrets: type: array - items: &389 + items: &388 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -61746,7 +61365,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61768,16 +61387,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *387 + schema: *386 examples: - default: *388 + default: *387 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61797,15 +61416,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 responses: '200': description: Response content: application/json: - schema: *389 + schema: *388 examples: default: value: @@ -61831,9 +61450,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 requestBody: required: true content: @@ -61861,7 +61480,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -61885,9 +61504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 responses: '204': description: Response @@ -61909,8 +61528,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: + - *241 - *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 @@ -62060,7 +61679,7 @@ paths: advisory_summary: Ruby OpenID advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 headers: - Link: *37 + Link: *50 '404': *6 '403': description: Response if GitHub Advanced Security is not enabled for this @@ -62084,8 +61703,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: + - *241 - *242 - - *243 responses: '200': description: Response @@ -62322,7 +61941,7 @@ paths: spdxElementId: SPDXRef-DOCUMENT relatedSpdxElement: SPDXRef-Repository headers: - Link: *37 + Link: *50 '404': *6 '403': *27 x-github: @@ -62345,8 +61964,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: + - *241 - *242 - - *243 requestBody: required: true content: @@ -62429,7 +62048,7 @@ paths: - version - url additionalProperties: false - metadata: &390 + metadata: &389 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -62468,7 +62087,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *390 + metadata: *389 resolved: type: object description: A collection of resolved package dependencies. @@ -62482,7 +62101,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *390 + metadata: *389 relationship: type: string description: A notation of whether a dependency is requested @@ -62615,8 +62234,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: + - *241 - *242 - - *243 - name: sha description: The SHA recorded at creation time. in: query @@ -62657,11 +62276,11 @@ paths: application/json: schema: type: array - items: *391 + items: *390 examples: - default: *392 + default: *391 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62725,8 +62344,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -62808,7 +62427,7 @@ paths: description: Response content: application/json: - schema: *391 + schema: *390 examples: simple-example: summary: Simple example @@ -62881,9 +62500,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: + - *241 - *242 - - *243 - - &393 + - &392 name: deployment_id description: deployment_id parameter in: path @@ -62895,7 +62514,7 @@ paths: description: Response content: application/json: - schema: *391 + schema: *390 examples: default: value: @@ -62960,9 +62579,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: + - *241 - *242 - - *243 - - *393 + - *392 responses: '204': description: Response @@ -62984,9 +62603,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: + - *241 - *242 - - *243 - - *393 + - *392 - *17 - *18 responses: @@ -62996,7 +62615,7 @@ paths: application/json: schema: type: array - items: &394 + items: &393 title: Deployment Status description: The status of a deployment. type: object @@ -63140,7 +62759,7 @@ paths: environment_url: https://test-branch.lab.acme.com log_url: https://example.com/deployment/42/output headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -63160,9 +62779,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: + - *241 - *242 - - *243 - - *393 + - *392 requestBody: required: true content: @@ -63237,9 +62856,9 @@ paths: description: Response content: application/json: - schema: *394 + schema: *393 examples: - default: &395 + default: &394 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -63295,9 +62914,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: + - *241 - *242 - - *243 - - *393 + - *392 - name: status_id in: path required: true @@ -63308,9 +62927,9 @@ paths: description: Response content: application/json: - schema: *394 + schema: *393 examples: - default: *395 + default: *394 '404': *6 x-github: githubCloudOnly: false @@ -63335,8 +62954,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -63393,8 +63012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -63412,7 +63031,7 @@ paths: - 5 environments: type: array - items: &397 + items: &396 title: Environment description: Details of a deployment environment type: object @@ -63474,7 +63093,7 @@ paths: type: string examples: - wait_timer - wait_timer: &399 + wait_timer: &398 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -63516,11 +63135,11 @@ paths: items: type: object properties: - type: *396 + type: *395 reviewer: anyOf: - *4 - - *173 + - *166 required: - id - node_id @@ -63543,7 +63162,7 @@ paths: - id - node_id - type - deployment_branch_policy: &400 + deployment_branch_policy: &399 type: - object - 'null' @@ -63660,9 +63279,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: + - *241 - *242 - - *243 - - &398 + - &397 name: environment_name in: path required: true @@ -63675,9 +63294,9 @@ paths: description: Response content: application/json: - schema: *397 + schema: *396 examples: - default: &401 + default: &400 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -63761,9 +63380,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: + - *241 - *242 - - *243 - - *398 + - *397 requestBody: required: false content: @@ -63773,7 +63392,7 @@ paths: - object - 'null' properties: - wait_timer: *399 + wait_timer: *398 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -63792,14 +63411,14 @@ paths: items: type: object properties: - type: *396 + type: *395 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *400 + deployment_branch_policy: *399 additionalProperties: false examples: default: @@ -63819,9 +63438,9 @@ paths: description: Response content: application/json: - schema: *397 + schema: *396 examples: - default: *401 + default: *400 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -63845,9 +63464,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: + - *241 - *242 - - *243 - - *398 + - *397 responses: '204': description: Default response @@ -63872,9 +63491,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: + - *241 - *242 - - *243 - - *398 + - *397 - *17 - *18 responses: @@ -63893,7 +63512,7 @@ paths: - 2 branch_policies: type: array - items: &402 + items: &401 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -63954,9 +63573,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: + - *241 - *242 - - *243 - - *398 + - *397 requestBody: required: true content: @@ -64004,9 +63623,9 @@ paths: description: Response content: application/json: - schema: *402 + schema: *401 examples: - example-wildcard: &403 + example-wildcard: &402 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -64048,10 +63667,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: + - *241 - *242 - - *243 - - *398 - - &404 + - *397 + - &403 name: branch_policy_id in: path required: true @@ -64063,9 +63682,9 @@ paths: description: Response content: application/json: - schema: *402 + schema: *401 examples: - default: *403 + default: *402 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64084,10 +63703,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: + - *241 - *242 - - *243 - - *398 - - *404 + - *397 + - *403 requestBody: required: true content: @@ -64116,9 +63735,9 @@ paths: description: Response content: application/json: - schema: *402 + schema: *401 examples: - default: *403 + default: *402 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64137,10 +63756,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: + - *241 - *242 - - *243 - - *398 - - *404 + - *397 + - *403 responses: '204': description: Response @@ -64165,9 +63784,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *398 - - *243 + - *397 - *242 + - *241 responses: '200': description: List of deployment protection rules @@ -64184,7 +63803,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &405 + items: &404 title: Deployment protection rule description: Deployment protection rule type: object @@ -64206,7 +63825,7 @@ paths: for the environment. examples: - true - app: &406 + app: &405 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -64309,9 +63928,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: - - *398 - - *243 + - *397 - *242 + - *241 requestBody: content: application/json: @@ -64332,9 +63951,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *405 + schema: *404 examples: - default: &407 + default: &406 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -64369,9 +63988,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: - - *398 - - *243 + - *397 - *242 + - *241 - *18 - *17 responses: @@ -64391,7 +64010,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *406 + items: *405 examples: default: value: @@ -64426,10 +64045,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: + - *241 - *242 - - *243 - - *398 - - &408 + - *397 + - &407 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -64441,9 +64060,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *404 examples: - default: *407 + default: *406 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64464,10 +64083,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *398 - - *243 + - *397 - *242 - - *408 + - *241 + - *407 responses: '204': description: Response @@ -64493,9 +64112,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: + - *241 - *242 - - *243 - - *398 + - *397 - *17 - *18 responses: @@ -64513,11 +64132,11 @@ paths: type: integer secrets: type: array - items: *288 + items: *287 examples: - default: *289 + default: *288 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64540,17 +64159,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: + - *241 - *242 - - *243 - - *398 + - *397 responses: '200': description: Response content: application/json: - schema: *290 + schema: *289 examples: - default: *291 + default: *290 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64572,18 +64191,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: + - *241 - *242 - - *243 - - *398 - - *116 + - *397 + - *110 responses: '200': description: Response content: application/json: - schema: *288 + schema: *287 examples: - default: *409 + default: *408 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64605,10 +64224,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: + - *241 - *242 - - *243 - - *398 - - *116 + - *397 + - *110 requestBody: required: true content: @@ -64639,7 +64258,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -64665,10 +64284,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: + - *241 - *242 - - *243 - - *398 - - *116 + - *397 + - *110 responses: '204': description: Default response @@ -64693,10 +64312,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: + - *241 - *242 - - *243 - - *398 - - *264 + - *397 + - *263 - *18 responses: '200': @@ -64713,11 +64332,11 @@ paths: type: integer variables: type: array - items: *292 + items: *291 examples: - default: *293 + default: *292 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64738,9 +64357,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: + - *241 - *242 - - *243 - - *398 + - *397 requestBody: required: true content: @@ -64767,7 +64386,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -64792,18 +64411,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: + - *241 - *242 - - *243 - - *398 - - *119 + - *397 + - *113 responses: '200': description: Response content: application/json: - schema: *292 + schema: *291 examples: - default: *410 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64824,10 +64443,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: + - *241 - *242 - - *243 - - *119 - - *398 + - *113 + - *397 requestBody: required: true content: @@ -64869,10 +64488,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: + - *241 - *242 - - *243 - - *119 - - *398 + - *113 + - *397 responses: '204': description: Response @@ -64894,8 +64513,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -64905,7 +64524,7 @@ paths: application/json: schema: type: array - items: *83 + items: *78 examples: 200-response: value: @@ -64972,8 +64591,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: + - *241 - *242 - - *243 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -64995,7 +64614,7 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: default: value: @@ -65108,7 +64727,7 @@ paths: url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== headers: - Link: *37 + Link: *50 '400': *14 x-github: githubCloudOnly: false @@ -65132,8 +64751,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: + - *241 - *242 - - *243 requestBody: required: false content: @@ -65166,9 +64785,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *252 examples: - default: *255 + default: *254 '400': *14 '422': *15 '403': *27 @@ -65189,8 +64808,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -65241,7 +64860,7 @@ paths: schema: type: string '404': *6 - '409': *128 + '409': *122 '403': *27 '422': description: Validation failed @@ -65249,8 +64868,8 @@ paths: application/json: schema: oneOf: - - *92 - - *411 + - *86 + - *410 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65275,8 +64894,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: + - *241 - *242 - - *243 - name: file_sha in: path required: true @@ -65328,7 +64947,7 @@ paths: '404': *6 '422': *15 '403': *27 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65376,8 +64995,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -65486,7 +65105,7 @@ paths: description: Response content: application/json: - schema: &412 + schema: &411 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -65662,7 +65281,7 @@ paths: type: string '422': *15 '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65712,15 +65331,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: + - *241 - *242 - - *243 - - *368 + - *367 responses: '200': description: Response content: application/json: - schema: *412 + schema: *411 examples: default: value: @@ -65751,7 +65370,7 @@ paths: payload: verified_at: '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65776,9 +65395,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: + - *241 - *242 - - *243 - - &413 + - &412 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. @@ -65795,7 +65414,7 @@ paths: application/json: schema: type: array - items: &414 + items: &413 title: Git Reference description: Git references within a repository type: object @@ -65849,8 +65468,8 @@ paths: sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: - Link: *37 - '409': *128 + Link: *50 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65871,17 +65490,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: + - *241 - *242 - - *243 - - *413 + - *412 responses: '200': description: Response content: application/json: - schema: *414 + schema: *413 examples: - default: &415 + default: &414 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -65891,7 +65510,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65910,8 +65529,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -65940,16 +65559,16 @@ paths: description: Response content: application/json: - schema: *414 + schema: *413 examples: - default: *415 + default: *414 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65968,9 +65587,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: + - *241 - *242 - - *243 - - *413 + - *412 requestBody: required: true content: @@ -65999,11 +65618,11 @@ paths: description: Response content: application/json: - schema: *414 + schema: *413 examples: - default: *415 + default: *414 '422': *15 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66019,14 +65638,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: + - *241 - *242 - - *243 - - *413 + - *412 responses: '204': description: Response '422': *15 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66074,8 +65693,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -66142,7 +65761,7 @@ paths: description: Response content: application/json: - schema: &417 + schema: &416 title: Git Tag description: Metadata for a Git tag type: object @@ -66198,7 +65817,7 @@ paths: - sha - type - url - verification: *416 + verification: *415 required: - sha - url @@ -66208,7 +65827,7 @@ paths: - tag - message examples: - default: &418 + default: &417 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -66235,7 +65854,7 @@ paths: schema: type: string '422': *15 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66281,8 +65900,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: + - *241 - *242 - - *243 - name: tag_sha in: path required: true @@ -66293,11 +65912,11 @@ paths: description: Response content: application/json: - schema: *417 + schema: *416 examples: - default: *418 + default: *417 '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66319,8 +65938,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -66394,7 +66013,7 @@ paths: description: Response content: application/json: - schema: &419 + schema: &418 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -66489,7 +66108,7 @@ paths: '422': *15 '404': *6 '403': *27 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66512,8 +66131,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: + - *241 - *242 - - *243 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -66536,7 +66155,7 @@ paths: description: Response content: application/json: - schema: *419 + schema: *418 examples: default-response: summary: Default response @@ -66577,7 +66196,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66595,8 +66214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -66606,7 +66225,7 @@ paths: application/json: schema: type: array - items: &420 + items: &419 title: Webhook description: Webhooks for repositories. type: object @@ -66669,7 +66288,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &631 + last_response: &630 title: Hook Response type: object properties: @@ -66727,7 +66346,7 @@ paths: status: unused message: headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -66746,8 +66365,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: + - *241 - *242 - - *243 requestBody: required: false content: @@ -66800,9 +66419,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *419 examples: - default: &421 + default: &420 value: type: Repository id: 12345678 @@ -66850,17 +66469,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: + - *241 - *242 - - *243 - - *150 + - *143 responses: '200': description: Response content: application/json: - schema: *420 + schema: *419 examples: - default: *421 + default: *420 '404': *6 x-github: githubCloudOnly: false @@ -66880,9 +66499,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: + - *241 - *242 - - *243 - - *150 + - *143 requestBody: required: true content: @@ -66927,9 +66546,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *419 examples: - default: *421 + default: *420 '422': *15 '404': *6 x-github: @@ -66950,9 +66569,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: + - *241 - *242 - - *243 - - *150 + - *143 responses: '204': description: Response @@ -66976,9 +66595,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: + - *241 - *242 - - *243 - - *150 + - *143 responses: '200': description: Response @@ -67005,9 +66624,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: + - *241 - *242 - - *243 - - *150 + - *143 requestBody: required: false content: @@ -67051,11 +66670,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: + - *241 - *242 - - *243 - - *150 + - *143 - *17 - - *151 + - *144 responses: '200': description: Response @@ -67063,9 +66682,9 @@ paths: application/json: schema: type: array - items: *152 + items: *145 examples: - default: *153 + default: *146 '400': *14 '422': *15 x-github: @@ -67084,18 +66703,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: + - *241 - *242 - - *243 - - *150 + - *143 - *16 responses: '200': description: Response content: application/json: - schema: *154 + schema: *147 examples: - default: *155 + default: *148 '400': *14 '422': *15 x-github: @@ -67114,12 +66733,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: + - *241 - *242 - - *243 - - *150 + - *143 - *16 responses: - '202': *94 + '202': *88 '400': *14 '422': *15 x-github: @@ -67139,9 +66758,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: + - *241 - *242 - - *243 - - *150 + - *143 responses: '204': description: Response @@ -67166,9 +66785,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: + - *241 - *242 - - *243 - - *150 + - *143 responses: '204': description: Response @@ -67226,14 +66845,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: &422 + schema: &421 title: Import description: A repository import from an external source. type: object @@ -67340,7 +66959,7 @@ paths: - html_url - authors_url examples: - default: &425 + default: &424 value: vcs: subversion use_lfs: true @@ -67356,7 +66975,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &423 + '503': &422 description: Unavailable due to service under maintenance. content: application/json: @@ -67385,8 +67004,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -67434,7 +67053,7 @@ paths: description: Response content: application/json: - schema: *422 + schema: *421 examples: default: value: @@ -67459,7 +67078,7 @@ paths: type: string '422': *15 '404': *6 - '503': *423 + '503': *422 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67487,8 +67106,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: + - *241 - *242 - - *243 requestBody: required: false content: @@ -67540,7 +67159,7 @@ paths: description: Response content: application/json: - schema: *422 + schema: *421 examples: example-1: summary: Example 1 @@ -67588,7 +67207,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': *423 + '503': *422 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67611,12 +67230,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: + - *241 - *242 - - *243 responses: '204': description: Response - '503': *423 + '503': *422 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67642,9 +67261,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: + - *241 - *242 - - *243 - - &581 + - &580 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -67658,7 +67277,7 @@ paths: application/json: schema: type: array - items: &424 + items: &423 title: Porter Author description: Porter Author type: object @@ -67712,7 +67331,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *423 + '503': *422 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67737,8 +67356,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: + - *241 - *242 - - *243 - name: author_id in: path required: true @@ -67768,7 +67387,7 @@ paths: description: Response content: application/json: - schema: *424 + schema: *423 examples: default: value: @@ -67781,7 +67400,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *423 + '503': *422 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67805,8 +67424,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -67847,7 +67466,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *423 + '503': *422 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67875,8 +67494,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -67903,11 +67522,11 @@ paths: description: Response content: application/json: - schema: *422 + schema: *421 examples: - default: *425 + default: *424 '422': *15 - '503': *423 + '503': *422 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67930,8 +67549,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -67939,8 +67558,8 @@ paths: application/json: schema: *20 examples: - default: *426 - '301': *254 + default: *425 + '301': *253 '404': *6 x-github: githubCloudOnly: false @@ -67960,8 +67579,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -67969,12 +67588,12 @@ paths: application/json: schema: anyOf: - - *168 + - *161 - type: object properties: {} additionalProperties: false examples: - default: &428 + default: &427 value: limit: collaborators_only origin: repository @@ -67999,13 +67618,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: + - *241 - *242 - - *243 requestBody: required: true content: application/json: - schema: *427 + schema: *426 examples: default: summary: Example request body @@ -68017,9 +67636,9 @@ paths: description: Response content: application/json: - schema: *168 + schema: *161 examples: - default: *428 + default: *427 '409': description: Response x-github: @@ -68041,8 +67660,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -68065,8 +67684,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -68076,9 +67695,9 @@ paths: application/json: schema: type: array - items: *429 + items: *428 examples: - default: &574 + default: &573 value: - id: 1 repository: @@ -68192,7 +67811,7 @@ paths: html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68209,9 +67828,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: + - *241 - *242 - - *243 - - *172 + - *165 requestBody: required: false content: @@ -68240,7 +67859,7 @@ paths: description: Response content: application/json: - schema: *429 + schema: *428 examples: default: value: @@ -68371,9 +67990,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: + - *241 - *242 - - *243 - - *172 + - *165 responses: '204': description: Response @@ -68404,8 +68023,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: + - *241 - *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 @@ -68445,7 +68064,7 @@ paths: required: false schema: type: string - - *174 + - *167 - name: sort description: What to sort results by. in: query @@ -68457,8 +68076,8 @@ paths: - updated - comments default: created - - *40 - - *62 + - *37 + - *57 - *17 - *18 responses: @@ -68468,9 +68087,9 @@ paths: application/json: schema: type: array - items: *72 + items: *67 examples: - default: &438 + default: &437 value: - id: 1 node_id: MDU6SXNzdWUx @@ -68617,8 +68236,8 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *37 - '301': *254 + Link: *50 + '301': *253 '422': *15 '404': *6 x-github: @@ -68647,8 +68266,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -68729,9 +68348,9 @@ paths: description: Response content: application/json: - schema: *72 + schema: *67 examples: - default: &433 + default: &432 value: id: 1 node_id: MDU6SXNzdWUx @@ -68885,9 +68504,9 @@ paths: '400': *14 '403': *27 '422': *15 - '503': *60 + '503': *55 '404': *6 - '410': *251 + '410': *250 x-github: triggersNotification: true githubCloudOnly: false @@ -68915,9 +68534,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: + - *241 - *242 - - *243 - - *81 + - *76 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -68927,7 +68546,7 @@ paths: enum: - asc - desc - - *62 + - *57 - *17 - *18 responses: @@ -68937,9 +68556,9 @@ paths: application/json: schema: type: array - items: *430 + items: *429 examples: - default: &435 + default: &434 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -68970,7 +68589,7 @@ paths: issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR headers: - Link: *37 + Link: *50 '422': *15 '404': *6 x-github: @@ -68997,17 +68616,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 responses: '200': description: Response content: application/json: - schema: *430 + schema: *429 examples: - default: &431 + default: &430 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -69061,9 +68680,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 requestBody: required: true content: @@ -69085,9 +68704,9 @@ paths: description: Response content: application/json: - schema: *430 + schema: *429 examples: - default: *431 + default: *430 '422': *15 x-github: githubCloudOnly: false @@ -69105,9 +68724,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 responses: '204': description: Response @@ -69127,9 +68746,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 - 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. @@ -69155,11 +68774,11 @@ paths: application/json: schema: type: array - items: *235 + items: *234 examples: - default: *237 + default: *236 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -69178,9 +68797,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 requestBody: required: true content: @@ -69212,16 +68831,16 @@ paths: description: Reaction exists content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '201': description: Reaction created content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '422': *15 x-github: githubCloudOnly: false @@ -69243,10 +68862,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: + - *241 - *242 - - *243 - - *71 - - *238 + - *66 + - *237 responses: '204': description: Response @@ -69266,8 +68885,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -69277,7 +68896,7 @@ paths: application/json: schema: type: array - items: &432 + items: &431 title: Issue Event description: Issue Event type: object @@ -69324,7 +68943,7 @@ paths: issue: anyOf: - type: 'null' - - *72 + - *67 label: title: Issue Event Label description: Issue Event Label @@ -69357,7 +68976,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *173 + requested_team: *166 dismissed_review: title: Issue Event Dismissed Review type: object @@ -69424,7 +69043,7 @@ paths: required: - from - to - author_association: *58 + author_association: *53 lock_reason: type: - string @@ -69598,7 +69217,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *37 + Link: *50 '422': *15 x-github: githubCloudOnly: false @@ -69616,8 +69235,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: + - *241 - *242 - - *243 - name: event_id in: path required: true @@ -69628,7 +69247,7 @@ paths: description: Response content: application/json: - schema: *432 + schema: *431 examples: default: value: @@ -69821,7 +69440,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *251 + '410': *250 '403': *27 x-github: githubCloudOnly: false @@ -69855,9 +69474,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: + - *241 - *242 - - *243 - - &434 + - &433 name: issue_number description: The number that identifies the issue. in: path @@ -69869,12 +69488,12 @@ paths: description: Response content: application/json: - schema: *72 + schema: *67 examples: - default: *433 - '301': *254 + default: *432 + '301': *253 '404': *6 - '410': *251 + '410': *250 '304': *35 x-github: githubCloudOnly: false @@ -69899,9 +69518,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: false content: @@ -70009,15 +69628,15 @@ paths: description: Response content: application/json: - schema: *72 + schema: *67 examples: - default: *433 + default: *432 '422': *15 - '503': *60 + '503': *55 '403': *27 - '301': *254 + '301': *253 '404': *6 - '410': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70035,9 +69654,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: false content: @@ -70063,9 +69682,9 @@ paths: description: Response content: application/json: - schema: *72 + schema: *67 examples: - default: *433 + default: *432 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70081,9 +69700,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: content: application/json: @@ -70108,9 +69727,9 @@ paths: description: Response content: application/json: - schema: *72 + schema: *67 examples: - default: *433 + default: *432 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70132,9 +69751,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: + - *241 - *242 - - *243 - - *434 + - *433 - name: assignee in: path required: true @@ -70174,10 +69793,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: + - *241 - *242 - - *243 - - *434 - - *62 + - *433 + - *57 - *17 - *18 responses: @@ -70187,13 +69806,13 @@ paths: application/json: schema: type: array - items: *430 + items: *429 examples: - default: *435 + default: *434 headers: - Link: *37 + Link: *50 '404': *6 - '410': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70222,9 +69841,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: true content: @@ -70246,16 +69865,16 @@ paths: description: Response content: application/json: - schema: *430 + schema: *429 examples: - default: *431 + default: *430 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *251 + '410': *250 '422': *15 '404': *6 x-github: @@ -70275,9 +69894,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: + - *241 - *242 - - *243 - - *434 + - *433 - *17 - *18 responses: @@ -70291,7 +69910,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &439 + - &438 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -70340,7 +69959,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &440 + - &439 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -70468,7 +70087,7 @@ paths: - performed_via_github_app - assignee - assigner - - &441 + - &440 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -70514,7 +70133,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &442 + - &441 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -70560,7 +70179,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &443 + - &442 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -70609,7 +70228,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &444 + - &443 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -70638,7 +70257,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *173 + requested_team: *166 requested_reviewer: *4 required: - review_requester @@ -70651,7 +70270,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &445 + - &444 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -70680,7 +70299,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *173 + requested_team: *166 requested_reviewer: *4 required: - review_requester @@ -70693,7 +70312,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &446 + - &445 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -70749,7 +70368,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &447 + - &446 title: Locked Issue Event description: Locked Issue Event type: object @@ -70794,7 +70413,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &448 + - &447 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -70855,7 +70474,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &449 + - &448 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -70916,7 +70535,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &450 + - &449 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -70977,7 +70596,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &451 + - &450 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -71069,8 +70688,8 @@ paths: name: label color: red headers: - Link: *37 - '410': *251 + Link: *50 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71087,9 +70706,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 - *17 - *18 responses: @@ -71099,7 +70718,7 @@ paths: application/json: schema: type: array - items: &436 + items: &435 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -71154,7 +70773,7 @@ paths: - color - default examples: - default: &437 + default: &436 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -71171,10 +70790,10 @@ paths: color: a2eeef default: false headers: - Link: *37 - '301': *254 + Link: *50 + '301': *253 '404': *6 - '410': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71191,9 +70810,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: false content: @@ -71252,12 +70871,12 @@ paths: application/json: schema: type: array - items: *436 + items: *435 examples: - default: *437 - '301': *254 + default: *436 + '301': *253 '404': *6 - '410': *251 + '410': *250 '422': *15 x-github: githubCloudOnly: false @@ -71274,9 +70893,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: false content: @@ -71336,12 +70955,12 @@ paths: application/json: schema: type: array - items: *436 + items: *435 examples: - default: *437 - '301': *254 + default: *436 + '301': *253 '404': *6 - '410': *251 + '410': *250 '422': *15 x-github: githubCloudOnly: false @@ -71358,15 +70977,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 responses: '204': description: Response - '301': *254 + '301': *253 '404': *6 - '410': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71385,9 +71004,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 - name: name in: path required: true @@ -71400,7 +71019,7 @@ paths: application/json: schema: type: array - items: *436 + items: *435 examples: default: value: @@ -71411,9 +71030,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *254 + '301': *253 '404': *6 - '410': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71433,9 +71052,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: false content: @@ -71464,7 +71083,7 @@ paths: '204': description: Response '403': *27 - '410': *251 + '410': *250 '404': *6 '422': *15 x-github: @@ -71482,9 +71101,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 responses: '204': description: Response @@ -71506,9 +71125,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 - 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. @@ -71534,13 +71153,13 @@ paths: application/json: schema: type: array - items: *235 + items: *234 examples: - default: *237 + default: *236 headers: - Link: *37 + Link: *50 '404': *6 - '410': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71558,9 +71177,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: true content: @@ -71592,16 +71211,16 @@ paths: description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '201': description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '422': *15 x-github: githubCloudOnly: false @@ -71623,10 +71242,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: + - *241 - *242 - - *243 - - *434 - - *238 + - *433 + - *237 responses: '204': description: Response @@ -71655,9 +71274,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: true content: @@ -71679,9 +71298,9 @@ paths: description: Response content: application/json: - schema: *72 + schema: *67 examples: - default: *433 + default: *432 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -71714,9 +71333,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: + - *241 - *242 - - *243 - - *434 + - *433 - *17 - *18 responses: @@ -71726,13 +71345,13 @@ paths: application/json: schema: type: array - items: *72 + items: *67 examples: - default: *438 + default: *437 headers: - Link: *37 + Link: *50 '404': *6 - '410': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71760,9 +71379,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: true content: @@ -71788,16 +71407,16 @@ paths: description: Response content: application/json: - schema: *72 + schema: *67 examples: - default: *433 + default: *432 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *251 + '410': *250 '422': *15 '404': *6 x-github: @@ -71817,9 +71436,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: true content: @@ -71850,13 +71469,13 @@ paths: description: Response content: application/json: - schema: *72 + schema: *67 examples: - default: *433 + default: *432 '403': *27 '404': *6 '422': *7 - '503': *60 + '503': *55 x-github: triggersNotification: true githubCloudOnly: false @@ -71874,9 +71493,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 - *17 - *18 responses: @@ -71891,6 +71510,7 @@ paths: description: Timeline Event type: object anyOf: + - *438 - *439 - *440 - *441 @@ -71903,7 +71523,6 @@ paths: - *448 - *449 - *450 - - *451 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -71951,12 +71570,12 @@ paths: issue_url: type: string format: uri - author_association: *58 + author_association: *53 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *59 + reactions: *54 required: - event - actor @@ -71987,7 +71606,7 @@ paths: properties: type: type: string - issue: *72 + issue: *67 required: - event - created_at @@ -72203,7 +71822,7 @@ paths: type: string body_text: type: string - author_association: *58 + author_association: *53 required: - event - id @@ -72226,7 +71845,7 @@ paths: type: string comments: type: array - items: &471 + items: &470 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -72331,7 +71950,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *58 + author_association: *53 _links: type: object properties: @@ -72426,7 +72045,7 @@ paths: enum: - line - file - reactions: *59 + reactions: *54 body_html: type: string examples: @@ -72464,7 +72083,7 @@ paths: type: string comments: type: array - items: *366 + items: *365 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -72737,9 +72356,9 @@ paths: type: User site_admin: true headers: - Link: *37 + Link: *50 '404': *6 - '410': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72756,8 +72375,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -72767,7 +72386,7 @@ paths: application/json: schema: type: array - items: &452 + items: &451 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -72818,7 +72437,7 @@ paths: last_used: '2022-01-10T15:53:42Z' enabled: true headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72834,8 +72453,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -72871,9 +72490,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *451 examples: - default: &453 + default: &452 value: id: 1 key: ssh-rsa AAA... @@ -72907,9 +72526,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: + - *241 - *242 - - *243 - - &454 + - &453 name: key_id description: The unique identifier of the key. in: path @@ -72921,9 +72540,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *451 examples: - default: *453 + default: *452 '404': *6 x-github: githubCloudOnly: false @@ -72941,9 +72560,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: + - *241 - *242 - - *243 - - *454 + - *453 responses: '204': description: Response @@ -72963,8 +72582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -72974,11 +72593,11 @@ paths: application/json: schema: type: array - items: *436 + items: *435 examples: - default: *437 + default: *436 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -72997,8 +72616,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -73034,9 +72653,9 @@ paths: description: Response content: application/json: - schema: *436 + schema: *435 examples: - default: &455 + default: &454 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -73068,8 +72687,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: + - *241 - *242 - - *243 - name: name in: path required: true @@ -73080,9 +72699,9 @@ paths: description: Response content: application/json: - schema: *436 + schema: *435 examples: - default: *455 + default: *454 '404': *6 x-github: githubCloudOnly: false @@ -73099,8 +72718,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: + - *241 - *242 - - *243 - name: name in: path required: true @@ -73139,7 +72758,7 @@ paths: description: Response content: application/json: - schema: *436 + schema: *435 examples: default: value: @@ -73165,8 +72784,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: + - *241 - *242 - - *243 - name: name in: path required: true @@ -73192,8 +72811,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -73232,9 +72851,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: + - *241 - *242 - - *243 - - *343 + - *342 responses: '200': description: Response @@ -73300,7 +72919,7 @@ paths: license: anyOf: - type: 'null' - - *73 + - *68 required: - _links - git_url @@ -73381,8 +73000,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -73447,8 +73066,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -73482,9 +73101,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *367 + schema: *366 examples: - default: *456 + default: *455 '204': description: Response when already merged '404': @@ -73509,8 +73128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: + - *241 - *242 - - *243 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -73551,7 +73170,7 @@ paths: application/json: schema: type: array - items: *371 + items: *370 examples: default: value: @@ -73590,7 +73209,7 @@ paths: closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -73607,8 +73226,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -73648,9 +73267,9 @@ paths: description: Response content: application/json: - schema: *371 + schema: *370 examples: - default: &457 + default: &456 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -73709,9 +73328,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: + - *241 - *242 - - *243 - - &458 + - &457 name: milestone_number description: The number that identifies the milestone. in: path @@ -73723,9 +73342,9 @@ paths: description: Response content: application/json: - schema: *371 + schema: *370 examples: - default: *457 + default: *456 '404': *6 x-github: githubCloudOnly: false @@ -73742,9 +73361,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: + - *241 - *242 - - *243 - - *458 + - *457 requestBody: required: false content: @@ -73782,9 +73401,9 @@ paths: description: Response content: application/json: - schema: *371 + schema: *370 examples: - default: *457 + default: *456 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73800,9 +73419,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: + - *241 - *242 - - *243 - - *458 + - *457 responses: '204': description: Response @@ -73823,9 +73442,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: + - *241 - *242 - - *243 - - *458 + - *457 - *17 - *18 responses: @@ -73835,11 +73454,11 @@ paths: application/json: schema: type: array - items: *436 + items: *435 examples: - default: *437 + default: *436 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73856,12 +73475,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: + - *241 - *242 - - *243 + - *458 - *459 + - *57 - *460 - - *62 - - *461 - *17 - *18 responses: @@ -73871,11 +73490,11 @@ paths: application/json: schema: type: array - items: *84 + items: *79 examples: - default: *462 + default: *461 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -73897,8 +73516,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: + - *241 - *242 - - *243 requestBody: required: false content: @@ -73956,14 +73575,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: &463 + schema: &462 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -74107,7 +73726,7 @@ paths: - custom_404 - public examples: - default: &464 + default: &463 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -74148,8 +73767,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -74204,11 +73823,11 @@ paths: description: Response content: application/json: - schema: *463 + schema: *462 examples: - default: *464 + default: *463 '422': *15 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74229,8 +73848,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -74309,7 +73928,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74330,14 +73949,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: + - *241 - *242 - - *243 responses: '204': description: Response '422': *15 '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74357,8 +73976,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -74368,7 +73987,7 @@ paths: application/json: schema: type: array - items: &465 + items: &464 title: Page Build description: Page Build type: object @@ -74441,7 +74060,7 @@ paths: created_at: '2014-02-10T19:00:49Z' updated_at: '2014-02-10T19:00:51Z' headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74460,8 +74079,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: + - *241 - *242 - - *243 responses: '201': description: Response @@ -74508,16 +74127,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *465 + schema: *464 examples: - default: &466 + default: &465 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -74565,8 +74184,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: + - *241 - *242 - - *243 - name: build_id in: path required: true @@ -74577,9 +74196,9 @@ paths: description: Response content: application/json: - schema: *465 + schema: *464 examples: - default: *466 + default: *465 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74599,8 +74218,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -74709,9 +74328,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: + - *241 - *242 - - *243 - - &467 + - &466 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -74769,11 +74388,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: + - *241 - *242 - - *243 - - *467 + - *466 responses: - '204': *132 + '204': *126 '404': *6 x-github: githubCloudOnly: false @@ -74798,8 +74417,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -75067,7 +74686,7 @@ paths: description: Empty response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -75094,8 +74713,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: + - *241 - *242 - - *243 responses: '200': description: Private vulnerability reporting status @@ -75132,10 +74751,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: + - *241 - *242 - - *243 responses: - '204': *132 + '204': *126 '422': *14 x-github: githubCloudOnly: false @@ -75154,10 +74773,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: + - *241 - *242 - - *243 responses: - '204': *132 + '204': *126 '422': *14 x-github: githubCloudOnly: false @@ -75178,8 +74797,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-repository-projects parameters: + - *241 - *242 - - *243 - name: state description: Indicates the state of the projects to return. in: query @@ -75200,7 +74819,7 @@ paths: application/json: schema: type: array - items: *202 + items: *196 examples: default: value: @@ -75236,11 +74855,11 @@ paths: created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' headers: - Link: *37 + Link: *50 '401': *23 '403': *27 '404': *6 - '410': *251 + '410': *250 '422': *7 x-github: githubCloudOnly: false @@ -75260,8 +74879,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#create-a-repository-project parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -75287,13 +74906,13 @@ paths: description: Response content: application/json: - schema: *202 + schema: *196 examples: - default: *250 + default: *249 '401': *23 '403': *27 '404': *6 - '410': *251 + '410': *250 '422': *7 x-github: githubCloudOnly: false @@ -75313,8 +74932,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -75322,7 +74941,7 @@ paths: application/json: schema: type: array - items: *207 + items: *201 examples: default: value: @@ -75353,8 +74972,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: + - *241 - *242 - - *243 requestBody: required: true content: @@ -75366,7 +74985,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *207 + items: *201 required: - properties examples: @@ -75416,8 +75035,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: + - *241 - *242 - - *243 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -75477,11 +75096,11 @@ paths: application/json: schema: type: array - items: *468 + items: *467 examples: - default: *469 + default: *468 headers: - Link: *37 + Link: *50 '304': *35 '422': *15 x-github: @@ -75511,8 +75130,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -75579,7 +75198,7 @@ paths: description: Response content: application/json: - schema: &473 + schema: &472 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -75708,7 +75327,7 @@ paths: milestone: anyOf: - type: 'null' - - *371 + - *370 active_lock_reason: type: - string @@ -75763,7 +75382,7 @@ paths: type: - array - 'null' - items: *187 + items: *181 head: type: object properties: @@ -75771,7 +75390,7 @@ paths: type: string ref: type: string - repo: *57 + repo: *52 sha: type: string user: *4 @@ -75788,7 +75407,7 @@ paths: type: string ref: type: string - repo: *57 + repo: *52 sha: type: string user: *4 @@ -75801,14 +75420,14 @@ paths: _links: type: object properties: - comments: *372 - commits: *372 - statuses: *372 - html: *372 - issue: *372 - review_comments: *372 - review_comment: *372 - self: *372 + comments: *371 + commits: *371 + statuses: *371 + html: *371 + issue: *371 + review_comments: *371 + review_comment: *371 + self: *371 required: - comments - commits @@ -75818,8 +75437,8 @@ paths: - review_comments - review_comment - self - author_association: *58 - auto_merge: *470 + author_association: *53 + auto_merge: *469 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -75921,7 +75540,7 @@ paths: - merged_by - review_comments examples: - default: &474 + default: &473 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -76448,8 +76067,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: + - *241 - *242 - - *243 - name: sort in: query required: false @@ -76468,7 +76087,7 @@ paths: enum: - asc - desc - - *62 + - *57 - *17 - *18 responses: @@ -76478,9 +76097,9 @@ paths: application/json: schema: type: array - items: *471 + items: *470 examples: - default: &476 + default: &475 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -76532,7 +76151,7 @@ paths: original_line: 2 side: RIGHT headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76557,17 +76176,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *71 + - *66 responses: '200': description: Response content: application/json: - schema: *471 + schema: *470 examples: - default: &472 + default: &471 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -76642,9 +76261,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *71 + - *66 requestBody: required: true content: @@ -76666,9 +76285,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *470 examples: - default: *472 + default: *471 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76684,9 +76303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *71 + - *66 responses: '204': description: Response @@ -76707,9 +76326,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 - 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. @@ -76735,11 +76354,11 @@ paths: application/json: schema: type: array - items: *235 + items: *234 examples: - default: *237 + default: *236 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -76758,9 +76377,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 requestBody: required: true content: @@ -76792,16 +76411,16 @@ paths: description: Reaction exists content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '201': description: Reaction created content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '422': *15 x-github: githubCloudOnly: false @@ -76823,10 +76442,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: + - *241 - *242 - - *243 - - *71 - - *238 + - *66 + - *237 responses: '204': description: Response @@ -76869,9 +76488,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: + - *241 - *242 - - *243 - - &475 + - &474 name: pull_number description: The number that identifies the pull request. in: path @@ -76884,9 +76503,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *473 + schema: *472 examples: - default: *474 + default: *473 '304': *35 '404': *6 '406': @@ -76894,8 +76513,8 @@ paths: content: application/json: schema: *3 - '500': *39 - '503': *60 + '500': *127 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76921,9 +76540,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 requestBody: required: false content: @@ -76965,9 +76584,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *472 examples: - default: *474 + default: *473 '422': *15 '403': *27 x-github: @@ -76989,9 +76608,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 requestBody: required: true content: @@ -77052,21 +76671,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '401': *23 '403': *27 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -77092,10 +76711,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 - - *81 + - *474 + - *76 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -77105,7 +76724,7 @@ paths: enum: - asc - desc - - *62 + - *57 - *17 - *18 responses: @@ -77115,11 +76734,11 @@ paths: application/json: schema: type: array - items: *471 + items: *470 examples: - default: *476 + default: *475 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77150,9 +76769,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 requestBody: required: true content: @@ -77258,7 +76877,7 @@ paths: description: Response content: application/json: - schema: *471 + schema: *470 examples: example-for-a-multi-line-comment: value: @@ -77346,10 +76965,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: + - *241 - *242 - - *243 - - *475 - - *71 + - *474 + - *66 requestBody: required: true content: @@ -77371,7 +76990,7 @@ paths: description: Response content: application/json: - schema: *471 + schema: *470 examples: default: value: @@ -77457,9 +77076,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 - *17 - *18 responses: @@ -77469,11 +77088,11 @@ paths: application/json: schema: type: array - items: *367 + items: *366 examples: - default: *477 + default: *476 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77501,9 +77120,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: + - *241 - *242 - - *243 - - *475 + - *474 - *17 - *18 responses: @@ -77513,7 +77132,7 @@ paths: application/json: schema: type: array - items: *379 + items: *378 examples: default: value: @@ -77529,10 +77148,10 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" headers: - Link: *37 + Link: *50 '422': *15 - '500': *39 - '503': *60 + '500': *127 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77551,9 +77170,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: + - *241 - *242 - - *243 - - *475 + - *474 responses: '204': description: Response if pull request has been merged @@ -77576,9 +77195,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 requestBody: required: false content: @@ -77690,9 +77309,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 responses: '200': description: Response @@ -77708,7 +77327,7 @@ paths: items: *4 teams: type: array - items: *173 + items: *166 required: - users - teams @@ -77749,7 +77368,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77767,9 +77386,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 requestBody: required: false content: @@ -77806,7 +77425,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *467 examples: default: value: @@ -78342,9 +77961,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 requestBody: required: true content: @@ -78378,7 +77997,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *467 examples: default: value: @@ -78883,9 +78502,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 - *17 - *18 responses: @@ -78895,7 +78514,7 @@ paths: application/json: schema: type: array - items: &478 + items: &477 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -78969,7 +78588,7 @@ paths: type: string body_text: type: string - author_association: *58 + author_association: *53 required: - id - node_id @@ -79018,7 +78637,7 @@ paths: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 author_association: COLLABORATOR headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79051,9 +78670,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 requestBody: required: false content: @@ -79143,9 +78762,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *477 examples: - default: &480 + default: &479 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -79208,10 +78827,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 - - &479 + - *474 + - &478 name: review_id description: The unique identifier of the review. in: path @@ -79223,9 +78842,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *477 examples: - default: &481 + default: &480 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -79284,10 +78903,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 - - *479 + - *474 + - *478 requestBody: required: true content: @@ -79310,7 +78929,7 @@ paths: description: Response content: application/json: - schema: *478 + schema: *477 examples: default: value: @@ -79372,18 +78991,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 - - *479 + - *474 + - *478 responses: '200': description: Response content: application/json: - schema: *478 + schema: *477 examples: - default: *480 + default: *479 '422': *7 '404': *6 x-github: @@ -79410,10 +79029,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: + - *241 - *242 - - *243 - - *475 - - *479 + - *474 + - *478 - *17 - *18 responses: @@ -79507,13 +79126,13 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *58 + author_association: *53 _links: type: object properties: - self: *372 - html: *372 - pull_request: *372 + self: *371 + html: *371 + pull_request: *371 required: - self - html @@ -79522,7 +79141,7 @@ paths: type: string body_html: type: string - reactions: *59 + reactions: *54 side: description: The side of the first line of the range for a multi-line comment. @@ -79635,7 +79254,7 @@ paths: pull_request: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -79664,10 +79283,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 - - *479 + - *474 + - *478 requestBody: required: true content: @@ -79696,7 +79315,7 @@ paths: description: Response content: application/json: - schema: *478 + schema: *477 examples: default: value: @@ -79759,10 +79378,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 - - *479 + - *474 + - *478 requestBody: required: true content: @@ -79797,9 +79416,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *477 examples: - default: *481 + default: *480 '404': *6 '422': *7 '403': *27 @@ -79821,9 +79440,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: + - *241 - *242 - - *243 - - *475 + - *474 requestBody: required: false content: @@ -79887,8 +79506,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: + - *241 - *242 - - *243 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -79901,9 +79520,9 @@ paths: description: Response content: application/json: - schema: *482 + schema: *481 examples: - default: &483 + default: &482 value: type: file encoding: base64 @@ -79945,8 +79564,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: + - *241 - *242 - - *243 - name: dir description: The alternate path to look for a README file in: path @@ -79966,9 +79585,9 @@ paths: description: Response content: application/json: - schema: *482 + schema: *481 examples: - default: *483 + default: *482 '404': *6 '422': *15 x-github: @@ -79990,8 +79609,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -80001,7 +79620,7 @@ paths: application/json: schema: type: array - items: &484 + items: &483 title: Release description: A release. type: object @@ -80073,7 +79692,7 @@ paths: author: *4 assets: type: array - items: &485 + items: &484 title: Release Asset description: Data related to a release. type: object @@ -80143,7 +79762,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *59 + reactions: *54 required: - assets_url - upload_url @@ -80233,7 +79852,7 @@ paths: type: User site_admin: false headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -80253,8 +79872,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -80330,9 +79949,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *483 examples: - default: &488 + default: &487 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -80435,9 +80054,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: + - *241 - *242 - - *243 - - &486 + - &485 name: asset_id description: The unique identifier of the asset. in: path @@ -80449,9 +80068,9 @@ paths: description: Response content: application/json: - schema: *485 + schema: *484 examples: - default: &487 + default: &486 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 @@ -80485,7 +80104,7 @@ paths: type: User site_admin: false '404': *6 - '302': *381 + '302': *380 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80501,9 +80120,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: + - *241 - *242 - - *243 - - *486 + - *485 requestBody: required: false content: @@ -80532,9 +80151,9 @@ paths: description: Response content: application/json: - schema: *485 + schema: *484 examples: - default: *487 + default: *486 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80550,9 +80169,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: + - *241 - *242 - - *243 - - *486 + - *485 responses: '204': description: Response @@ -80576,8 +80195,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -80663,16 +80282,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *484 + schema: *483 examples: - default: *488 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80689,8 +80308,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: + - *241 - *242 - - *243 - name: tag description: tag parameter in: path @@ -80703,9 +80322,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *483 examples: - default: *488 + default: *487 '404': *6 x-github: githubCloudOnly: false @@ -80727,9 +80346,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: + - *241 - *242 - - *243 - - &489 + - &488 name: release_id description: The unique identifier of the release. in: path @@ -80743,9 +80362,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: *484 + schema: *483 examples: - default: *488 + default: *487 '401': description: Unauthorized x-github: @@ -80763,9 +80382,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: + - *241 - *242 - - *243 - - *489 + - *488 requestBody: required: false content: @@ -80829,9 +80448,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *483 examples: - default: *488 + default: *487 '404': description: Not Found if the discussion category name is invalid content: @@ -80852,9 +80471,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: + - *241 - *242 - - *243 - - *489 + - *488 responses: '204': description: Response @@ -80874,9 +80493,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: + - *241 - *242 - - *243 - - *489 + - *488 - *17 - *18 responses: @@ -80886,7 +80505,7 @@ paths: application/json: schema: type: array - items: *485 + items: *484 examples: default: value: @@ -80922,7 +80541,7 @@ paths: type: User site_admin: false headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80966,9 +80585,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: + - *241 - *242 - - *243 - - *489 + - *488 - name: name in: query required: true @@ -80994,7 +80613,7 @@ paths: description: Response for successful upload content: application/json: - schema: *485 + schema: *484 examples: response-for-successful-upload: value: @@ -81048,9 +80667,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: + - *241 - *242 - - *243 - - *489 + - *488 - 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. @@ -81074,11 +80693,11 @@ paths: application/json: schema: type: array - items: *235 + items: *234 examples: - default: *237 + default: *236 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -81097,9 +80716,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: + - *241 - *242 - - *243 - - *489 + - *488 requestBody: required: true content: @@ -81129,16 +80748,16 @@ paths: description: Reaction exists content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '201': description: Reaction created content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '422': *15 x-github: githubCloudOnly: false @@ -81160,10 +80779,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: + - *241 - *242 - - *243 - - *489 - - *238 + - *488 + - *237 responses: '204': description: Response @@ -81187,9 +80806,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: + - *241 - *242 - - *243 - - *310 + - *309 - *17 - *18 responses: @@ -81205,8 +80824,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *490 - - &492 + - *489 + - &491 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -81226,53 +80845,53 @@ paths: type: integer description: The ID of the ruleset that includes this rule. - allOf: + - *490 - *491 + - allOf: - *492 + - *491 - allOf: - *493 - - *492 + - *491 - allOf: - *494 - - *492 + - *491 - allOf: - *495 - - *492 + - *491 - allOf: - *496 - - *492 + - *491 - allOf: - *497 - - *492 + - *491 - allOf: - *498 - - *492 + - *491 - allOf: - *499 - - *492 + - *491 - allOf: - *500 - - *492 + - *491 - allOf: - *501 - - *492 + - *491 - allOf: - *502 - - *492 + - *491 - allOf: - *503 - - *492 + - *491 - allOf: - *504 - - *492 + - *491 - allOf: - *505 - - *492 + - *491 - allOf: - *506 - - *492 - - allOf: - - *507 - - *492 + - *491 examples: default: value: @@ -81311,8 +80930,8 @@ paths: category: repos subcategory: rules parameters: + - *241 - *242 - - *243 - *17 - *18 - name: includes_parents @@ -81323,7 +80942,7 @@ paths: schema: type: boolean default: true - - *508 + - *507 responses: '200': description: Response @@ -81331,7 +80950,7 @@ paths: application/json: schema: type: array - items: *215 + items: *209 examples: default: value: @@ -81362,7 +80981,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *39 + '500': *127 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -81378,8 +80997,8 @@ paths: category: repos subcategory: rules parameters: + - *241 - *242 - - *243 requestBody: description: Request body required: true @@ -81399,16 +81018,16 @@ paths: - tag - push default: branch - enforcement: *211 + enforcement: *205 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *212 - conditions: *209 + items: *206 + conditions: *203 rules: type: array description: An array of rules within the ruleset. - items: *214 + items: *208 required: - name - enforcement @@ -81439,9 +81058,9 @@ paths: description: Response content: application/json: - schema: *215 + schema: *209 examples: - default: &518 + default: &517 value: id: 42 name: super cool ruleset @@ -81474,7 +81093,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *6 - '500': *39 + '500': *127 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -81488,12 +81107,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: + - *241 - *242 - - *243 + - *508 - *509 - *510 - *511 - - *512 - *17 - *18 responses: @@ -81501,11 +81120,11 @@ paths: description: Response content: application/json: - schema: *513 + schema: *512 examples: - default: *514 + default: *513 '404': *6 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81524,19 +81143,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: + - *241 - *242 - - *243 - - *515 + - *514 responses: '200': description: Response content: application/json: - schema: *516 + schema: *515 examples: - default: *517 + default: *516 '404': *6 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81562,8 +81181,8 @@ paths: category: repos subcategory: rules parameters: + - *241 - *242 - - *243 - name: ruleset_id description: The ID of the ruleset. in: path @@ -81583,11 +81202,11 @@ paths: description: Response content: application/json: - schema: *215 + schema: *209 examples: - default: *518 + default: *517 '404': *6 - '500': *39 + '500': *127 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -81603,8 +81222,8 @@ paths: category: repos subcategory: rules parameters: + - *241 - *242 - - *243 - name: ruleset_id description: The ID of the ruleset. in: path @@ -81629,16 +81248,16 @@ paths: - branch - tag - push - enforcement: *211 + enforcement: *205 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *212 - conditions: *209 + items: *206 + conditions: *203 rules: description: An array of rules within the ruleset. type: array - items: *214 + items: *208 examples: default: value: @@ -81666,11 +81285,11 @@ paths: description: Response content: application/json: - schema: *215 + schema: *209 examples: - default: *518 + default: *517 '404': *6 - '500': *39 + '500': *127 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -81686,8 +81305,8 @@ paths: category: repos subcategory: rules parameters: + - *241 - *242 - - *243 - name: ruleset_id description: The ID of the ruleset. in: path @@ -81698,7 +81317,7 @@ paths: '204': description: Response '404': *6 - '500': *39 + '500': *127 "/repos/{owner}/{repo}/secret-scanning/alerts": get: summary: List secret scanning alerts for a repository @@ -81715,20 +81334,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: + - *241 - *242 - - *243 - - *217 - - *218 - - *219 - - *220 - - *40 + - *211 + - *212 + - *213 + - *214 + - *37 - *18 - *17 + - *518 - *519 - - *520 - - *221 - - *222 - - *223 + - *215 + - *216 + - *217 responses: '200': description: Response @@ -81736,24 +81355,24 @@ paths: application/json: schema: type: array - items: &523 + items: &522 type: object properties: - number: *46 - created_at: *47 + number: *44 + created_at: *45 updated_at: anyOf: - type: 'null' - - *48 - url: *49 - html_url: *50 + - *46 + url: *47 + html_url: *48 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *521 - resolution: *522 + state: *520 + resolution: *521 resolved_at: type: - string @@ -81802,6 +81421,12 @@ paths: anyOf: - type: 'null' - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. push_protection_bypass_request_comment: type: - string @@ -81905,6 +81530,7 @@ paths: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true + push_protection_bypass_request_reviewer_comment: Example response push_protection_bypass_request_comment: Example comment push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment @@ -81927,6 +81553,7 @@ paths: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -81936,7 +81563,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81958,15 +81585,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: + - *241 - *242 - - *243 - - *341 + - *340 responses: '200': description: Response content: application/json: - schema: *523 + schema: *522 examples: default: value: @@ -81986,6 +81613,7 @@ paths: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -81996,7 +81624,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82017,9 +81645,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: + - *241 - *242 - - *243 - - *341 + - *340 requestBody: required: true content: @@ -82027,8 +81655,8 @@ paths: schema: type: object properties: - state: *521 - resolution: *522 + state: *520 + resolution: *521 resolution_comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -82047,7 +81675,7 @@ paths: description: Response content: application/json: - schema: *523 + schema: *522 examples: default: value: @@ -82085,6 +81713,7 @@ paths: push_protection_bypassed_by: push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: Example comment @@ -82099,7 +81728,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *60 + '503': *55 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -82121,9 +81750,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: + - *241 - *242 - - *243 - - *341 + - *340 - *18 - *17 responses: @@ -82134,7 +81763,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &652 + items: &651 type: object properties: type: @@ -82487,11 +82116,11 @@ paths: details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 headers: - Link: *37 + Link: *50 '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82513,8 +82142,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -82522,14 +82151,14 @@ paths: schema: type: object properties: - reason: &525 + reason: &524 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *524 + placeholder_id: *523 required: - reason - placeholder_id @@ -82546,7 +82175,7 @@ paths: schema: type: object properties: - reason: *525 + reason: *524 expire_at: type: - string @@ -82570,7 +82199,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *60 + '503': *55 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -82590,13 +82219,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: + - *241 - *242 - - *243 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *60 + '503': *55 '200': description: Response content: @@ -82606,7 +82235,7 @@ paths: properties: incremental_scans: type: array - items: &526 + items: &525 description: Information on a single scan performed by secret scanning on the repository type: object @@ -82634,15 +82263,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *526 + items: *525 backfill_scans: type: array - items: *526 + items: *525 custom_pattern_backfill_scans: type: array items: allOf: - - *526 + - *525 - type: object properties: pattern_name: @@ -82712,9 +82341,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: + - *241 - *242 - - *243 - - *40 + - *37 - name: sort description: The property to sort the results by. in: query @@ -82726,8 +82355,8 @@ paths: - updated - published default: created - - *41 - - *42 + - *38 + - *39 - name: per_page description: The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -82757,9 +82386,9 @@ paths: application/json: schema: type: array - items: *527 + items: *526 examples: - default: *528 + default: *527 '400': *14 '404': *6 x-github: @@ -82782,8 +82411,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -82863,7 +82492,7 @@ paths: login: type: string description: The username of the user credited. - type: *226 + type: *220 required: - login - type @@ -82953,9 +82582,9 @@ paths: description: Response content: application/json: - schema: *527 + schema: *526 examples: - default: &530 + default: &529 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -83188,8 +82817,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -83302,7 +82931,7 @@ paths: description: Response content: application/json: - schema: *527 + schema: *526 examples: default: value: @@ -83449,17 +83078,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: + - *241 - *242 - - *243 - - *529 + - *528 responses: '200': description: Response content: application/json: - schema: *527 + schema: *526 examples: - default: *530 + default: *529 '403': *27 '404': *6 x-github: @@ -83483,9 +83112,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: + - *241 - *242 - - *243 - - *529 + - *528 requestBody: required: true content: @@ -83565,7 +83194,7 @@ paths: login: type: string description: The username of the user credited. - type: *226 + type: *220 required: - login - type @@ -83656,17 +83285,17 @@ paths: description: Response content: application/json: - schema: *527 + schema: *526 examples: - default: *530 - add_credit: *530 + default: *529 + add_credit: *529 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *92 + schema: *86 examples: invalid_state_transition: value: @@ -83697,11 +83326,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: + - *241 - *242 - - *243 - - *529 + - *528 responses: - '202': *94 + '202': *88 '400': *14 '403': *27 '404': *6 @@ -83726,17 +83355,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: + - *241 - *242 - - *243 - - *529 + - *528 responses: '202': description: Response content: application/json: - schema: *253 + schema: *252 examples: - default: *255 + default: *254 '400': *14 '422': *15 '403': *27 @@ -83762,8 +83391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -83837,7 +83466,7 @@ paths: type: User site_admin: false headers: - Link: *37 + Link: *50 '422': *15 x-github: githubCloudOnly: false @@ -83859,8 +83488,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: + - *241 - *242 - - *243 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -83869,7 +83498,7 @@ paths: application/json: schema: type: array - items: &531 + items: &530 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -83881,8 +83510,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *94 - '204': *132 + '202': *88 + '204': *126 '422': description: Repository contains more than 10,000 commits x-github: @@ -83902,8 +83531,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -83953,8 +83582,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *94 - '204': *132 + '202': *88 + '204': *126 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83981,8 +83610,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -84053,8 +83682,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *94 - '204': *132 + '202': *88 + '204': *126 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84076,8 +83705,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: + - *241 - *242 - - *243 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -84231,8 +83860,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: + - *241 - *242 - - *243 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -84242,7 +83871,7 @@ paths: application/json: schema: type: array - items: *531 + items: *530 examples: default: value: @@ -84255,7 +83884,7 @@ paths: - - 0 - 2 - 21 - '204': *132 + '204': *126 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84275,8 +83904,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: + - *241 - *242 - - *243 - name: sha in: path required: true @@ -84332,7 +83961,7 @@ paths: description: Response content: application/json: - schema: *532 + schema: *531 examples: default: value: @@ -84386,8 +84015,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -84399,9 +84028,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84419,14 +84048,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: + - *241 - *242 - - *243 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &533 + schema: &532 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -84499,8 +84128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: + - *241 - *242 - - *243 requestBody: required: false content: @@ -84526,7 +84155,7 @@ paths: description: Response content: application/json: - schema: *533 + schema: *532 examples: default: value: @@ -84553,8 +84182,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -84574,8 +84203,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -84634,7 +84263,7 @@ paths: tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84657,8 +84286,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -84666,7 +84295,7 @@ paths: application/json: schema: type: array - items: &534 + items: &533 title: Tag protection description: Tag protection type: object @@ -84723,8 +84352,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: + - *241 - *242 - - *243 requestBody: required: true content: @@ -84747,7 +84376,7 @@ paths: description: Response content: application/json: - schema: *534 + schema: *533 examples: default: value: @@ -84778,8 +84407,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: + - *241 - *242 - - *243 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -84816,8 +84445,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: + - *241 - *242 - - *243 - name: ref in: path required: true @@ -84853,8 +84482,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -84864,11 +84493,11 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - default: *188 + default: *182 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -84886,8 +84515,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: + - *241 - *242 - - *243 - *18 - *17 responses: @@ -84895,7 +84524,7 @@ paths: description: Response content: application/json: - schema: &535 + schema: &534 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -84907,7 +84536,7 @@ paths: required: - names examples: - default: &536 + default: &535 value: names: - octocat @@ -84930,8 +84559,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -84962,9 +84591,9 @@ paths: description: Response content: application/json: - schema: *535 + schema: *534 examples: - default: *536 + default: *535 '404': *6 '422': *7 x-github: @@ -84985,9 +84614,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: + - *241 - *242 - - *243 - - &537 + - &536 name: per description: The time frame to display results for. in: query @@ -85018,7 +84647,7 @@ paths: - 128 clones: type: array - items: &538 + items: &537 title: Traffic type: object properties: @@ -85105,8 +84734,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -85200,8 +84829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -85264,9 +84893,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: + - *241 - *242 - - *243 - - *537 + - *536 responses: '200': description: Response @@ -85287,7 +84916,7 @@ paths: - 3782 views: type: array - items: *538 + items: *537 required: - uniques - count @@ -85364,8 +84993,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -85401,7 +85030,7 @@ paths: description: Response content: application/json: - schema: *108 + schema: *102 examples: default: value: @@ -85639,8 +85268,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: + - *241 - *242 - - *243 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -85663,8 +85292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -85686,8 +85315,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -85713,8 +85342,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: + - *241 - *242 - - *243 - name: ref in: path required: true @@ -85806,9 +85435,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *252 examples: - default: *255 + default: *254 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -85849,7 +85478,7 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: default: value: @@ -86038,7 +85667,7 @@ paths: html_url: type: string format: uri - repository: *108 + repository: *102 score: type: number file_size: @@ -86057,7 +85686,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &539 + text_matches: &538 title: Search Result Text Matches type: array items: @@ -86172,7 +85801,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *35 - '503': *60 + '503': *55 '422': *15 '403': *27 x-github: @@ -86220,7 +85849,7 @@ paths: enum: - author-date - committer-date - - &540 + - &539 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 @@ -86289,7 +85918,7 @@ paths: committer: anyOf: - type: 'null' - - *308 + - *307 comment_count: type: integer message: @@ -86308,7 +85937,7 @@ paths: url: type: string format: uri - verification: *416 + verification: *415 required: - author - committer @@ -86323,7 +85952,7 @@ paths: committer: anyOf: - type: 'null' - - *308 + - *307 parents: type: array items: @@ -86335,12 +85964,12 @@ paths: type: string sha: type: string - repository: *108 + repository: *102 score: type: number node_id: type: string - text_matches: *539 + text_matches: *538 required: - sha - node_id @@ -86532,7 +86161,7 @@ paths: - interactions - created - updated - - *540 + - *539 - *17 - *18 responses: @@ -86648,7 +86277,7 @@ paths: milestone: anyOf: - type: 'null' - - *371 + - *370 comments: type: integer created_at: @@ -86662,7 +86291,7 @@ paths: - string - 'null' format: date-time - text_matches: *539 + text_matches: *538 pull_request: type: object properties: @@ -86700,10 +86329,10 @@ paths: type: string score: type: number - author_association: *58 + author_association: *53 draft: type: boolean - repository: *57 + repository: *52 body_html: type: string body_text: @@ -86715,7 +86344,7 @@ paths: anyOf: - type: 'null' - *5 - reactions: *59 + reactions: *54 required: - assignee - closed_at @@ -86831,7 +86460,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *60 + '503': *55 '422': *15 '304': *35 '403': *27 @@ -86884,7 +86513,7 @@ paths: enum: - created - updated - - *540 + - *539 - *17 - *18 responses: @@ -86929,7 +86558,7 @@ paths: - 'null' score: type: number - text_matches: *539 + text_matches: *538 required: - id - node_id @@ -87014,7 +86643,7 @@ paths: - forks - help-wanted-issues - updated - - *540 + - *539 - *17 - *18 responses: @@ -87233,7 +86862,7 @@ paths: license: anyOf: - type: 'null' - - *73 + - *68 permissions: type: object properties: @@ -87251,7 +86880,7 @@ paths: - admin - pull - push - text_matches: *539 + text_matches: *538 temp_clone_token: type: string allow_merge_commit: @@ -87454,7 +87083,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *60 + '503': *55 '422': *15 '304': *35 x-github: @@ -87559,7 +87188,7 @@ paths: - string - 'null' format: uri - text_matches: *539 + text_matches: *538 related: type: - array @@ -87752,7 +87381,7 @@ paths: - followers - repositories - joined - - *540 + - *539 - *17 - *18 responses: @@ -87862,7 +87491,7 @@ paths: type: - boolean - 'null' - text_matches: *539 + text_matches: *538 blog: type: - string @@ -87924,7 +87553,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *35 - '503': *60 + '503': *55 '422': *15 x-github: githubCloudOnly: false @@ -87944,7 +87573,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &541 + - &540 name: team_id description: The unique identifier of the team. in: path @@ -87956,9 +87585,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *226 examples: - default: *228 + default: *227 '404': *6 x-github: githubCloudOnly: false @@ -87985,7 +87614,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *541 + - *540 requestBody: required: true content: @@ -88049,16 +87678,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *227 + schema: *226 examples: - default: *228 + default: *227 '201': description: Response content: application/json: - schema: *227 + schema: *226 examples: - default: *228 + default: *227 '404': *6 '422': *15 '403': *27 @@ -88086,7 +87715,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *541 + - *540 responses: '204': description: Response @@ -88117,8 +87746,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *541 - - *40 + - *540 + - *37 - *17 - *18 responses: @@ -88128,11 +87757,11 @@ paths: application/json: schema: type: array - items: *229 + items: *228 examples: - default: *542 + default: *541 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88159,7 +87788,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *541 + - *540 requestBody: required: true content: @@ -88193,9 +87822,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *228 examples: - default: *230 + default: *229 x-github: triggersNotification: true githubCloudOnly: false @@ -88222,16 +87851,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *541 - - *231 + - *540 + - *230 responses: '200': description: Response content: application/json: - schema: *229 + schema: *228 examples: - default: *230 + default: *229 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88256,8 +87885,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *541 - - *231 + - *540 + - *230 requestBody: required: false content: @@ -88280,9 +87909,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *228 examples: - default: *543 + default: *542 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88307,8 +87936,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *541 - - *231 + - *540 + - *230 responses: '204': description: Response @@ -88337,9 +87966,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *541 - - *231 - - *40 + - *540 + - *230 + - *37 - *17 - *18 responses: @@ -88349,11 +87978,11 @@ paths: application/json: schema: type: array - items: *232 + items: *231 examples: - default: *544 + default: *543 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88380,8 +88009,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *541 - - *231 + - *540 + - *230 requestBody: required: true content: @@ -88403,9 +88032,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *231 examples: - default: *233 + default: *232 x-github: triggersNotification: true githubCloudOnly: false @@ -88432,17 +88061,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *541 - - *231 - - *234 + - *540 + - *230 + - *233 responses: '200': description: Response content: application/json: - schema: *232 + schema: *231 examples: - default: *233 + default: *232 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88467,9 +88096,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *541 - - *231 - - *234 + - *540 + - *230 + - *233 requestBody: required: true content: @@ -88491,9 +88120,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *231 examples: - default: *545 + default: *544 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88518,9 +88147,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *541 - - *231 - - *234 + - *540 + - *230 + - *233 responses: '204': description: Response @@ -88549,9 +88178,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *541 - - *231 - - *234 + - *540 + - *230 + - *233 - 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. @@ -88577,11 +88206,11 @@ paths: application/json: schema: type: array - items: *235 + items: *234 examples: - default: *237 + default: *236 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88608,9 +88237,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *541 - - *231 - - *234 + - *540 + - *230 + - *233 requestBody: required: true content: @@ -88642,9 +88271,9 @@ paths: description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88670,8 +88299,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *541 - - *231 + - *540 + - *230 - 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. @@ -88697,11 +88326,11 @@ paths: application/json: schema: type: array - items: *235 + items: *234 examples: - default: *237 + default: *236 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88728,8 +88357,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *541 - - *231 + - *540 + - *230 requestBody: required: true content: @@ -88761,9 +88390,9 @@ paths: description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -88787,7 +88416,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *541 + - *540 - *17 - *18 responses: @@ -88797,11 +88426,11 @@ paths: application/json: schema: type: array - items: *170 + items: *163 examples: - default: *171 + default: *164 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88825,7 +88454,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *541 + - *540 - name: role description: Filters members returned by their role in the team. in: query @@ -88848,9 +88477,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -88876,8 +88505,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *541 - - *121 + - *540 + - *115 responses: '204': description: if user is a member @@ -88913,8 +88542,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *541 - - *121 + - *540 + - *115 responses: '204': description: Response @@ -88953,8 +88582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *541 - - *121 + - *540 + - *115 responses: '204': description: Response @@ -88990,16 +88619,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *541 - - *121 + - *540 + - *115 responses: '200': description: Response content: application/json: - schema: *239 + schema: *238 examples: - response-if-user-is-a-team-maintainer: *546 + response-if-user-is-a-team-maintainer: *545 '404': *6 x-github: githubCloudOnly: false @@ -89032,8 +88661,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *541 - - *121 + - *540 + - *115 requestBody: required: false content: @@ -89058,9 +88687,9 @@ paths: description: Response content: application/json: - schema: *239 + schema: *238 examples: - response-if-users-membership-with-team-is-now-pending: *547 + response-if-users-membership-with-team-is-now-pending: *546 '403': description: Forbidden if team synchronization is set up '422': @@ -89094,8 +88723,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *541 - - *121 + - *540 + - *115 responses: '204': description: Response @@ -89124,7 +88753,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *541 + - *540 - *17 - *18 responses: @@ -89134,11 +88763,11 @@ paths: application/json: schema: type: array - items: *240 + items: *239 examples: - default: *548 + default: *547 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -89163,16 +88792,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *541 - - *241 + - *540 + - *240 responses: '200': description: Response content: application/json: - schema: *240 + schema: *239 examples: - default: *549 + default: *548 '404': description: Not Found if project is not managed by this team x-github: @@ -89197,8 +88826,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *541 - - *241 + - *540 + - *240 requestBody: required: false content: @@ -89266,8 +88895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *541 - - *241 + - *540 + - *240 responses: '204': description: Response @@ -89294,7 +88923,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *541 + - *540 - *17 - *18 responses: @@ -89304,11 +88933,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -89336,15 +88965,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *541 + - *540 + - *241 - *242 - - *243 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *550 + schema: *549 examples: alternative-response-with-extra-repository-information: value: @@ -89495,9 +89124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *541 + - *540 + - *241 - *242 - - *243 requestBody: required: false content: @@ -89547,9 +89176,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *541 + - *540 + - *241 - *242 - - *243 responses: '204': description: Response @@ -89574,7 +89203,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *541 + - *540 - *17 - *18 responses: @@ -89584,11 +89213,11 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - response-if-child-teams-exist: *551 + response-if-child-teams-exist: *550 headers: - Link: *37 + Link: *50 '404': *6 '403': *27 '422': *15 @@ -89619,7 +89248,7 @@ paths: application/json: schema: oneOf: - - &553 + - &552 title: Private User description: Private User type: object @@ -89869,7 +89498,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *552 + - *551 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -90029,7 +89658,7 @@ paths: description: Response content: application/json: - schema: *553 + schema: *552 examples: default: value: @@ -90108,7 +89737,7 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 '304': *35 '404': *6 '403': *27 @@ -90131,7 +89760,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: - - *121 + - *115 responses: '204': description: If the user is blocked @@ -90159,7 +89788,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *121 + - *115 responses: '204': description: Response @@ -90183,7 +89812,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *121 + - *115 responses: '204': description: Response @@ -90232,11 +89861,11 @@ paths: type: integer codespaces: type: array - items: *177 + items: *170 examples: - default: *178 + default: *171 '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -90373,21 +90002,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '401': *23 '403': *27 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -90427,7 +90056,7 @@ paths: type: integer secrets: type: array - items: &554 + items: &553 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -90469,9 +90098,9 @@ paths: - visibility - selected_repositories_url examples: - default: *360 + default: *359 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -90541,13 +90170,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *116 + - *110 responses: '200': description: Response content: application/json: - schema: *554 + schema: *553 examples: default: value: @@ -90577,7 +90206,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *116 + - *110 requestBody: required: true content: @@ -90622,7 +90251,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -90650,7 +90279,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *116 + - *110 responses: '204': description: Response @@ -90675,7 +90304,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *116 + - *110 responses: '200': description: Response @@ -90691,13 +90320,13 @@ paths: type: integer repositories: type: array - items: *108 + items: *102 examples: - default: *555 + default: *554 '401': *23 '403': *27 '404': *6 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -90718,7 +90347,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *116 + - *110 requestBody: required: true content: @@ -90750,7 +90379,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -90772,7 +90401,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *116 + - *110 - name: repository_id in: path required: true @@ -90784,7 +90413,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -90805,7 +90434,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *116 + - *110 - name: repository_id in: path required: true @@ -90817,7 +90446,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -90837,17 +90466,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *179 + - *172 responses: '200': description: Response content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -90871,7 +90500,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *179 + - *172 requestBody: required: false content: @@ -90901,9 +90530,9 @@ paths: description: Response content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '401': *23 '403': *27 '404': *6 @@ -90925,11 +90554,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *179 + - *172 responses: - '202': *94 + '202': *88 '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -90954,13 +90583,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *179 + - *172 responses: '202': description: Response content: application/json: - schema: &556 + schema: &555 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -91013,7 +90642,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &557 + default: &556 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -91021,7 +90650,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -91045,7 +90674,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *179 + - *172 - name: export_id in: path required: true @@ -91058,9 +90687,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *555 examples: - default: *557 + default: *556 '404': *6 x-github: githubCloudOnly: false @@ -91081,7 +90710,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *179 + - *172 responses: '200': description: Response @@ -91097,11 +90726,11 @@ paths: type: integer machines: type: array - items: *359 + items: *358 examples: - default: *558 + default: *557 '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -91128,7 +90757,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *179 + - *172 requestBody: required: true content: @@ -91184,11 +90813,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *253 + repository: *252 machine: anyOf: - type: 'null' - - *359 + - *358 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -91985,17 +91614,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *179 + - *172 responses: '200': description: Response content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '304': *35 - '500': *39 + '500': *127 '400': *14 '401': *23 '402': @@ -92005,7 +91634,7 @@ paths: schema: *3 '403': *27 '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -92025,16 +91654,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *179 + - *172 responses: '200': description: Response content: application/json: - schema: *177 + schema: *170 examples: - default: *358 - '500': *39 + default: *357 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -92063,9 +91692,9 @@ paths: application/json: schema: type: array - items: *189 + items: *183 examples: - default: &571 + default: &570 value: - id: 197 name: hello_docker @@ -92166,7 +91795,7 @@ paths: application/json: schema: type: array - items: &559 + items: &558 title: Email description: Email type: object @@ -92236,16 +91865,16 @@ paths: application/json: schema: type: array - items: *559 + items: *558 examples: - default: &573 + default: &572 value: - email: octocat@github.com verified: true primary: true visibility: public headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -92315,7 +91944,7 @@ paths: application/json: schema: type: array - items: *559 + items: *558 examples: default: value: @@ -92427,9 +92056,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -92460,9 +92089,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -92482,7 +92111,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: - - *121 + - *115 responses: '204': description: if the person is followed by the authenticated user @@ -92512,7 +92141,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *121 + - *115 responses: '204': description: Response @@ -92537,7 +92166,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *121 + - *115 responses: '204': description: Response @@ -92573,7 +92202,7 @@ paths: application/json: schema: type: array - items: &560 + items: &559 title: GPG Key description: A unique encryption key type: object @@ -92718,7 +92347,7 @@ paths: - subkeys - revoked examples: - default: &584 + default: &583 value: - id: 3 name: Octocat's GPG Key @@ -92750,7 +92379,7 @@ paths: revoked: false raw_key: string headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -92803,9 +92432,9 @@ paths: description: Response content: application/json: - schema: *560 + schema: *559 examples: - default: &561 + default: &560 value: id: 3 name: Octocat's GPG Key @@ -92862,7 +92491,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &562 + - &561 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -92874,9 +92503,9 @@ paths: description: Response content: application/json: - schema: *560 + schema: *559 examples: - default: *561 + default: *560 '404': *6 '304': *35 '403': *27 @@ -92899,7 +92528,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *562 + - *561 responses: '204': description: Response @@ -93042,7 +92671,7 @@ paths: suspended_at: suspended_by: headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -93088,11 +92717,11 @@ paths: type: string repositories: type: array - items: *57 + items: *52 examples: - default: *563 + default: *562 headers: - Link: *37 + Link: *50 '404': *6 '403': *27 '304': *35 @@ -93115,7 +92744,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *99 + - *93 responses: '204': description: Response @@ -93141,7 +92770,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *99 + - *93 responses: '204': description: Response @@ -93175,12 +92804,12 @@ paths: application/json: schema: anyOf: - - *168 + - *161 - type: object properties: {} additionalProperties: false examples: - default: *169 + default: *162 '204': description: Response when there are no restrictions x-github: @@ -93204,7 +92833,7 @@ paths: required: true content: application/json: - schema: *427 + schema: *426 examples: default: value: @@ -93215,7 +92844,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *161 examples: default: value: @@ -93296,7 +92925,7 @@ paths: - closed - all default: open - - *174 + - *167 - name: sort description: What to sort results by. in: query @@ -93308,8 +92937,8 @@ paths: - updated - comments default: created - - *40 - - *62 + - *37 + - *57 - *17 - *18 responses: @@ -93319,11 +92948,11 @@ paths: application/json: schema: type: array - items: *72 + items: *67 examples: - default: *175 + default: *168 headers: - Link: *37 + Link: *50 '404': *6 '304': *35 x-github: @@ -93354,7 +92983,7 @@ paths: application/json: schema: type: array - items: &564 + items: &563 title: Key description: Key type: object @@ -93401,7 +93030,7 @@ paths: verified: false read_only: false headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -93452,9 +93081,9 @@ paths: description: Response content: application/json: - schema: *564 + schema: *563 examples: - default: &565 + default: &564 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -93487,15 +93116,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *454 + - *453 responses: '200': description: Response content: application/json: - schema: *564 + schema: *563 examples: - default: *565 + default: *564 '404': *6 '304': *35 '403': *27 @@ -93518,7 +93147,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *454 + - *453 responses: '204': description: Response @@ -93551,7 +93180,7 @@ paths: application/json: schema: type: array - items: &566 + items: &565 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -93619,7 +93248,7 @@ paths: - id - type - login - plan: *75 + plan: *70 required: - billing_cycle - next_billing_date @@ -93630,7 +93259,7 @@ paths: - account - plan examples: - default: &567 + default: &566 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -93663,7 +93292,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *37 + Link: *50 '304': *35 '401': *23 '404': *6 @@ -93692,11 +93321,11 @@ paths: application/json: schema: type: array - items: *566 + items: *565 examples: - default: *567 + default: *566 headers: - Link: *37 + Link: *50 '304': *35 '401': *23 x-github: @@ -93734,7 +93363,7 @@ paths: application/json: schema: type: array - items: *180 + items: *174 examples: default: value: @@ -93811,7 +93440,7 @@ paths: type: User site_admin: false headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -93836,13 +93465,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: *180 + schema: *174 examples: default: value: @@ -93900,7 +93529,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *89 + - *83 requestBody: required: true content: @@ -93925,7 +93554,7 @@ paths: description: Response content: application/json: - schema: *180 + schema: *174 examples: default: value: @@ -93993,7 +93622,7 @@ paths: application/json: schema: type: array - items: *182 + items: *176 examples: default: value: @@ -94146,7 +93775,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -94255,7 +93884,7 @@ paths: description: Response content: application/json: - schema: *182 + schema: *176 examples: default: value: @@ -94435,7 +94064,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *183 + - *177 - name: exclude in: query required: false @@ -94448,7 +94077,7 @@ paths: description: Response content: application/json: - schema: *182 + schema: *176 examples: default: value: @@ -94642,7 +94271,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *183 + - *177 responses: '302': description: Response @@ -94668,7 +94297,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *183 + - *177 responses: '204': description: Response @@ -94697,8 +94326,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *183 - - *568 + - *177 + - *567 responses: '204': description: Response @@ -94722,7 +94351,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *183 + - *177 - *17 - *18 responses: @@ -94732,11 +94361,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -94769,11 +94398,11 @@ paths: application/json: schema: type: array - items: *88 + items: *129 examples: - default: *569 + default: *568 headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -94813,7 +94442,7 @@ paths: - docker - nuget - container - - *570 + - *569 - *18 - *17 responses: @@ -94823,10 +94452,10 @@ paths: application/json: schema: type: array - items: *189 + items: *183 examples: - default: *571 - '400': *572 + default: *570 + '400': *571 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -94846,16 +94475,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *191 - - *192 + - *185 + - *186 responses: '200': description: Response content: application/json: - schema: *189 + schema: *183 examples: - default: &585 + default: &584 value: id: 40201 name: octo-name @@ -94968,8 +94597,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *191 - - *192 + - *185 + - *186 responses: '204': description: Response @@ -94999,8 +94628,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *191 - - *192 + - *185 + - *186 - name: token description: package token schema: @@ -95032,8 +94661,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: - - *191 - - *192 + - *185 + - *186 - *18 - *17 - name: state @@ -95053,7 +94682,7 @@ paths: application/json: schema: type: array - items: *193 + items: *187 examples: default: value: @@ -95102,15 +94731,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *191 - - *192 - - *194 + - *185 + - *186 + - *188 responses: '200': description: Response content: application/json: - schema: *193 + schema: *187 examples: default: value: @@ -95146,9 +94775,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *191 - - *192 - - *194 + - *185 + - *186 + - *188 responses: '204': description: Response @@ -95178,9 +94807,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *191 - - *192 - - *194 + - *185 + - *186 + - *188 responses: '204': description: Response @@ -95238,7 +94867,7 @@ paths: description: Response content: application/json: - schema: *202 + schema: *196 examples: default: value: @@ -95307,11 +94936,11 @@ paths: application/json: schema: type: array - items: *559 + items: *558 examples: - default: *573 + default: *572 headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -95420,9 +95049,9 @@ paths: application/json: schema: type: array - items: *57 + items: *52 examples: - default: &580 + default: &579 summary: Default response value: - id: 1296269 @@ -95738,9 +95367,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *252 examples: - default: *255 + default: *254 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -95778,11 +95407,11 @@ paths: application/json: schema: type: array - items: *429 + items: *428 examples: - default: *574 + default: *573 headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -95803,12 +95432,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *172 + - *165 responses: '204': description: Response '403': *27 - '409': *128 + '409': *122 '404': *6 '304': *35 x-github: @@ -95826,11 +95455,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *172 + - *165 responses: '204': description: Response - '409': *128 + '409': *122 '304': *35 '404': *6 '403': *27 @@ -95859,7 +95488,7 @@ paths: application/json: schema: type: array - items: &575 + items: &574 title: Social account description: Social media account type: object @@ -95876,12 +95505,12 @@ paths: - provider - url examples: - default: &576 + default: &575 value: - provider: twitter url: https://twitter.com/github headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -95939,9 +95568,9 @@ paths: application/json: schema: type: array - items: *575 + items: *574 examples: - default: *576 + default: *575 '422': *15 '304': *35 '404': *6 @@ -96029,7 +95658,7 @@ paths: application/json: schema: type: array - items: &577 + items: &576 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -96049,7 +95678,7 @@ paths: - title - created_at examples: - default: &592 + default: &591 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -96062,7 +95691,7 @@ paths: title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -96116,9 +95745,9 @@ paths: description: Response content: application/json: - schema: *577 + schema: *576 examples: - default: &578 + default: &577 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -96149,7 +95778,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: - - &579 + - &578 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -96161,9 +95790,9 @@ paths: description: Response content: application/json: - schema: *577 + schema: *576 examples: - default: *578 + default: *577 '404': *6 '304': *35 '403': *27 @@ -96186,7 +95815,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: - - *579 + - *578 responses: '204': description: Response @@ -96215,7 +95844,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &593 + - &592 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 @@ -96228,7 +95857,7 @@ paths: - created - updated default: created - - *40 + - *37 - *17 - *18 responses: @@ -96238,13 +95867,13 @@ paths: application/json: schema: type: array - items: *57 + items: *52 examples: - default-response: *580 + default-response: *579 application/vnd.github.v3.star+json: schema: type: array - items: &594 + items: &593 title: Starred Repository description: Starred Repository type: object @@ -96252,7 +95881,7 @@ paths: starred_at: type: string format: date-time - repo: *57 + repo: *52 required: - starred_at - repo @@ -96380,7 +96009,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -96400,8 +96029,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: + - *241 - *242 - - *243 responses: '204': description: Response if this repository is starred by you @@ -96429,8 +96058,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -96454,8 +96083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -96488,11 +96117,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -96527,7 +96156,7 @@ paths: application/json: schema: type: array - items: *227 + items: *226 examples: default: value: @@ -96578,7 +96207,7 @@ paths: updated_at: '2017-08-17T12:37:15Z' type: Organization headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -96603,7 +96232,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *77 + - *72 responses: '200': description: Response @@ -96611,10 +96240,10 @@ paths: application/json: schema: oneOf: - - *553 - *552 + - *551 examples: - default-response: &582 + default-response: &581 summary: Default response value: login: octocat @@ -96649,7 +96278,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &583 + response-with-git-hub-plan-information: &582 summary: Response with GitHub plan information value: login: octocat @@ -96709,7 +96338,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *581 + - *580 - *17 responses: '200': @@ -96720,7 +96349,7 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: Link: example: ; rel="next" @@ -96748,7 +96377,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *121 + - *115 responses: '200': description: Response @@ -96756,11 +96385,11 @@ paths: application/json: schema: oneOf: - - *553 - *552 + - *551 examples: - default-response: *582 - response-with-git-hub-plan-information: *583 + default-response: *581 + response-with-git-hub-plan-information: *582 '404': *6 x-github: githubCloudOnly: false @@ -96784,9 +96413,9 @@ paths: url: https://docs.github.com/rest/users/attestations#list-attestations parameters: - *17 - - *41 - - *42 - - *121 + - *38 + - *39 + - *115 - name: subject_digest description: Subject Digest in: path @@ -96881,6 +96510,8 @@ paths: type: string repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -96888,7 +96519,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -96914,7 +96545,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: - - *121 + - *115 responses: '200': description: Response @@ -96922,9 +96553,9 @@ paths: application/json: schema: type: array - items: *189 + items: *183 examples: - default: *571 + default: *570 '403': *27 '401': *23 x-github: @@ -96947,7 +96578,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -96957,7 +96588,7 @@ paths: application/json: schema: type: array - items: *83 + items: *78 examples: default: value: @@ -97028,8 +96659,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *121 - - *89 + - *115 + - *83 - *17 - *18 responses: @@ -97039,7 +96670,7 @@ paths: application/json: schema: type: array - items: *83 + items: *78 examples: default: value: @@ -97118,7 +96749,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -97128,7 +96759,7 @@ paths: application/json: schema: type: array - items: *83 + items: *78 examples: default: value: @@ -97195,7 +96826,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -97207,9 +96838,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97226,7 +96857,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *121 + - *115 - *17 - *18 responses: @@ -97238,9 +96869,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97257,7 +96888,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *121 + - *115 - name: target_user in: path required: true @@ -97284,8 +96915,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *121 - - *62 + - *115 + - *57 - *17 - *18 responses: @@ -97295,11 +96926,11 @@ paths: application/json: schema: type: array - items: *63 + items: *58 examples: - default: *64 + default: *59 headers: - Link: *37 + Link: *50 '422': *15 x-github: githubCloudOnly: false @@ -97318,7 +96949,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -97328,11 +96959,11 @@ paths: application/json: schema: type: array - items: *560 + items: *559 examples: - default: *584 + default: *583 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97354,7 +96985,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *121 + - *115 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -97426,7 +97057,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *121 + - *115 responses: '200': description: Response @@ -97434,7 +97065,7 @@ paths: application/json: schema: *20 examples: - default: *426 + default: *425 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97452,7 +97083,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -97480,7 +97111,7 @@ paths: - id: 1 key: ssh-rsa AAA... headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97500,7 +97131,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -97510,11 +97141,11 @@ paths: application/json: schema: type: array - items: *88 + items: *129 examples: - default: *569 + default: *568 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97551,8 +97182,8 @@ paths: - docker - nuget - container - - *570 - - *121 + - *569 + - *115 - *18 - *17 responses: @@ -97562,12 +97193,12 @@ paths: application/json: schema: type: array - items: *189 + items: *183 examples: - default: *571 + default: *570 '403': *27 '401': *23 - '400': *572 + '400': *571 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97587,17 +97218,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *191 - - *192 - - *121 + - *185 + - *186 + - *115 responses: '200': description: Response content: application/json: - schema: *189 + schema: *183 examples: - default: *585 + default: *584 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97618,9 +97249,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *191 - - *192 - - *121 + - *185 + - *186 + - *115 responses: '204': description: Response @@ -97652,9 +97283,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *191 - - *192 - - *121 + - *185 + - *186 + - *115 - name: token description: package token schema: @@ -97686,9 +97317,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: - - *191 - - *192 - - *121 + - *185 + - *186 + - *115 responses: '200': description: Response @@ -97696,7 +97327,7 @@ paths: application/json: schema: type: array - items: *193 + items: *187 examples: default: value: @@ -97754,16 +97385,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *191 - - *192 - - *194 - - *121 + - *185 + - *186 + - *188 + - *115 responses: '200': description: Response content: application/json: - schema: *193 + schema: *187 examples: default: value: @@ -97798,10 +97429,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *191 - - *192 - - *121 - - *194 + - *185 + - *186 + - *115 + - *188 responses: '204': description: Response @@ -97833,10 +97464,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *191 - - *192 - - *121 - - *194 + - *185 + - *186 + - *115 + - *188 responses: '204': description: Response @@ -97859,7 +97490,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-user-projects parameters: - - *121 + - *115 - name: state description: Indicates the state of the projects to return. in: query @@ -97880,7 +97511,7 @@ paths: application/json: schema: type: array - items: *202 + items: *196 examples: default: value: @@ -97916,7 +97547,7 @@ paths: created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' headers: - Link: *37 + Link: *50 '422': *15 x-github: githubCloudOnly: false @@ -97939,7 +97570,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -97949,7 +97580,7 @@ paths: application/json: schema: type: array - items: *83 + items: *78 examples: default: value: @@ -98028,7 +97659,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -98038,7 +97669,7 @@ paths: application/json: schema: type: array - items: *83 + items: *78 examples: default: value: @@ -98115,7 +97746,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *121 + - *115 - name: type description: Limit results to repositories of the specified type. in: query @@ -98158,11 +97789,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98184,15 +97815,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *121 + - *115 responses: '200': description: Response content: application/json: - schema: *586 + schema: *585 examples: - default: *587 + default: *586 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98214,15 +97845,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *121 + - *115 responses: '200': description: Response content: application/json: - schema: *588 + schema: *587 examples: - default: *589 + default: *588 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98244,15 +97875,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *121 + - *115 responses: '200': description: Response content: application/json: - schema: *590 + schema: *589 examples: - default: *591 + default: *590 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98270,7 +97901,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -98280,11 +97911,11 @@ paths: application/json: schema: type: array - items: *575 + items: *574 examples: - default: *576 + default: *575 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98302,7 +97933,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -98312,11 +97943,11 @@ paths: application/json: schema: type: array - items: *577 + items: *576 examples: - default: *592 + default: *591 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98338,9 +97969,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *121 - - *593 - - *40 + - *115 + - *592 + - *37 - *17 - *18 responses: @@ -98351,13 +97982,13 @@ paths: schema: anyOf: - type: array - items: *594 + items: *593 - type: array - items: *57 + items: *52 examples: - default-response: *580 + default-response: *579 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98374,7 +98005,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -98384,11 +98015,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98515,7 +98146,7 @@ webhooks: type: string enum: - disabled - enterprise: &595 + enterprise: &594 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -98584,7 +98215,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &596 + installation: &595 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -98605,7 +98236,7 @@ webhooks: required: - id - node_id - organization: &597 + organization: &596 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -98678,7 +98309,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &598 + repository: &597 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -98707,7 +98338,7 @@ webhooks: license: anyOf: - type: 'null' - - *73 + - *68 organization: anyOf: - type: 'null' @@ -99591,10 +99222,10 @@ webhooks: type: string enum: - enabled - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -99670,11 +99301,11 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - rule: &599 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + rule: &598 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) @@ -99897,11 +99528,11 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - rule: *599 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + rule: *598 sender: *4 required: - action @@ -100089,11 +99720,11 @@ webhooks: - everyone required: - from - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - rule: *599 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + rule: *598 sender: *4 required: - action @@ -100177,7 +99808,7 @@ webhooks: type: string enum: - completed - check_run: &601 + check_run: &600 title: CheckRun description: A check performed on the code of a given code change type: object @@ -100245,8 +99876,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *321 - repository: *108 + items: *320 + repository: *102 status: type: string enum: @@ -100290,7 +99921,7 @@ webhooks: - examples: - neutral - deployment: *600 + deployment: *599 details_url: type: string examples: @@ -100350,7 +99981,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *321 + items: *320 started_at: type: string format: date-time @@ -100388,9 +100019,9 @@ webhooks: - output - app - pull_requests - installation: *596 - organization: *597 - repository: *598 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - check_run @@ -100783,10 +100414,10 @@ webhooks: type: string enum: - created - check_run: *601 - installation: *596 - organization: *597 - repository: *598 + check_run: *600 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - check_run @@ -101182,10 +100813,10 @@ webhooks: type: string enum: - requested_action - check_run: *601 - installation: *596 - organization: *597 - repository: *598 + check_run: *600 + installation: *595 + organization: *596 + repository: *597 requested_action: description: The action requested by the user. type: object @@ -101590,10 +101221,10 @@ webhooks: type: string enum: - rerequested - check_run: *601 - installation: *596 - organization: *597 - repository: *598 + check_run: *600 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - check_run @@ -102585,10 +102216,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -103273,10 +102904,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -103955,10 +103586,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -104265,20 +103896,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &602 + commit_oid: &601 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: *595 - installation: *596 - organization: *597 - ref: &603 + enterprise: *594 + installation: *595 + organization: *596 + ref: &602 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: *598 + repository: *597 sender: *4 required: - action @@ -104606,12 +104237,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *602 - enterprise: *595 - installation: *596 - organization: *597 - ref: *603 - repository: *598 + commit_oid: *601 + enterprise: *594 + installation: *595 + organization: *596 + ref: *602 + repository: *597 sender: *4 required: - action @@ -104709,7 +104340,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *336 + dismissed_comment: *335 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -104884,12 +104515,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *602 - enterprise: *595 - installation: *596 - organization: *597 - ref: *603 - repository: *598 + commit_oid: *601 + enterprise: *594 + installation: *595 + organization: *596 + ref: *602 + repository: *597 sender: *4 required: - action @@ -105221,12 +104852,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *602 - enterprise: *595 - installation: *596 - organization: *597 - ref: *603 - repository: *598 + commit_oid: *601 + enterprise: *594 + installation: *595 + organization: *596 + ref: *602 + repository: *597 sender: *4 required: - action @@ -105495,9 +105126,9 @@ webhooks: type: - string - 'null' - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -105505,7 +105136,7 @@ webhooks: type: - string - 'null' - repository: *598 + repository: *597 sender: *4 required: - action @@ -105737,12 +105368,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *602 - enterprise: *595 - installation: *596 - organization: *597 - ref: *603 - repository: *598 + commit_oid: *601 + enterprise: *594 + installation: *595 + organization: *596 + ref: *602 + repository: *597 sender: *4 required: - action @@ -106004,10 +105635,10 @@ webhooks: - updated_at - author_association - body - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -106088,18 +105719,18 @@ webhooks: type: - string - 'null' - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *597 - pusher_type: &604 + organization: *596 + pusher_type: &603 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &605 + ref: &604 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -106109,7 +105740,7 @@ webhooks: enum: - tag - branch - repository: *598 + repository: *597 sender: *4 required: - ref @@ -106191,10 +105822,10 @@ webhooks: type: string enum: - created - definition: *203 - enterprise: *595 - installation: *596 - organization: *597 + definition: *197 + enterprise: *594 + installation: *595 + organization: *596 sender: *4 required: - action @@ -106279,9 +105910,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 sender: *4 required: - action @@ -106358,10 +105989,10 @@ webhooks: type: string enum: - updated - definition: *203 - enterprise: *595 - installation: *596 - organization: *597 + definition: *197 + enterprise: *594 + installation: *595 + organization: *596 sender: *4 required: - action @@ -106438,19 +106069,19 @@ webhooks: type: string enum: - updated - enterprise: *595 - installation: *596 - repository: *598 - organization: *597 + enterprise: *594 + installation: *595 + repository: *597 + organization: *596 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *207 + items: *201 old_property_values: type: array description: The old custom property values for the repository. - items: *207 + items: *201 required: - action - repository @@ -106526,18 +106157,18 @@ webhooks: title: delete event type: object properties: - enterprise: *595 - installation: *596 - organization: *597 - pusher_type: *604 - ref: *605 + enterprise: *594 + installation: *595 + organization: *596 + pusher_type: *603 + ref: *604 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *598 + repository: *597 sender: *4 required: - ref @@ -106621,11 +106252,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *385 - installation: *596 - organization: *597 - enterprise: *595 - repository: *598 + alert: *384 + installation: *595 + organization: *596 + enterprise: *594 + repository: *597 sender: *4 required: - action @@ -106709,11 +106340,11 @@ webhooks: type: string enum: - auto_reopened - alert: *385 - installation: *596 - organization: *597 - enterprise: *595 - repository: *598 + alert: *384 + installation: *595 + organization: *596 + enterprise: *594 + repository: *597 sender: *4 required: - action @@ -106797,11 +106428,11 @@ webhooks: type: string enum: - created - alert: *385 - installation: *596 - organization: *597 - enterprise: *595 - repository: *598 + alert: *384 + installation: *595 + organization: *596 + enterprise: *594 + repository: *597 sender: *4 required: - action @@ -106883,11 +106514,11 @@ webhooks: type: string enum: - dismissed - alert: *385 - installation: *596 - organization: *597 - enterprise: *595 - repository: *598 + alert: *384 + installation: *595 + organization: *596 + enterprise: *594 + repository: *597 sender: *4 required: - action @@ -106969,11 +106600,11 @@ webhooks: type: string enum: - fixed - alert: *385 - installation: *596 - organization: *597 - enterprise: *595 - repository: *598 + alert: *384 + installation: *595 + organization: *596 + enterprise: *594 + repository: *597 sender: *4 required: - action @@ -107056,11 +106687,11 @@ webhooks: type: string enum: - reintroduced - alert: *385 - installation: *596 - organization: *597 - enterprise: *595 - repository: *598 + alert: *384 + installation: *595 + organization: *596 + enterprise: *594 + repository: *597 sender: *4 required: - action @@ -107142,11 +106773,11 @@ webhooks: type: string enum: - reopened - alert: *385 - installation: *596 - organization: *597 - enterprise: *595 - repository: *598 + alert: *384 + installation: *595 + organization: *596 + enterprise: *594 + repository: *597 sender: *4 required: - action @@ -107223,9 +106854,9 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - key: &606 + enterprise: *594 + installation: *595 + key: &605 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -107263,8 +106894,8 @@ webhooks: - verified - created_at - read_only - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -107341,11 +106972,11 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - key: *606 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + key: *605 + organization: *596 + repository: *597 sender: *4 required: - action @@ -107917,12 +107548,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - workflow: &610 + workflow: &609 title: Workflow type: - object @@ -108660,13 +108291,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *391 + deployment: *390 pull_requests: type: array - items: *473 - repository: *598 - organization: *597 - installation: *596 + items: *472 + repository: *597 + organization: *596 + installation: *595 sender: *4 responses: '200': @@ -108737,7 +108368,7 @@ webhooks: type: string enum: - approved - approver: &607 + approver: &606 type: object properties: avatar_url: @@ -108780,11 +108411,11 @@ webhooks: type: string comment: type: string - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - reviewers: &608 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + reviewers: &607 type: array items: type: object @@ -108865,7 +108496,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &609 + workflow_job_run: &608 type: object properties: conclusion: @@ -109611,18 +109242,18 @@ webhooks: type: string enum: - rejected - approver: *607 + approver: *606 comment: type: string - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - reviewers: *608 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + reviewers: *607 sender: *4 since: type: string - workflow_job_run: *609 + workflow_job_run: *608 workflow_job_runs: type: array items: @@ -110339,13 +109970,13 @@ webhooks: type: string enum: - requested - enterprise: *595 + enterprise: *594 environment: type: string - installation: *596 - organization: *597 - repository: *598 - requestor: &615 + installation: *595 + organization: *596 + repository: *597 + requestor: &614 title: User type: - object @@ -112288,12 +111919,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - workflow: *610 + workflow: *609 workflow_run: title: Deployment Workflow Run type: @@ -112984,7 +112615,7 @@ webhooks: type: string enum: - answered - answer: &613 + answer: &612 type: object properties: author_association: @@ -113144,7 +112775,7 @@ webhooks: - created_at - updated_at - body - discussion: &611 + discussion: &610 title: Discussion description: A Discussion in a repository. type: object @@ -113440,7 +113071,7 @@ webhooks: - id labels: type: array - items: *436 + items: *435 required: - repository_url - category @@ -113462,10 +113093,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -113592,11 +113223,11 @@ webhooks: - from required: - category - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -113679,11 +113310,11 @@ webhooks: type: string enum: - closed - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -113765,7 +113396,7 @@ webhooks: type: string enum: - created - comment: &612 + comment: &611 type: object properties: author_association: @@ -113925,11 +113556,11 @@ webhooks: - updated_at - body - reactions - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114012,12 +113643,12 @@ webhooks: type: string enum: - deleted - comment: *612 - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + comment: *611 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114112,12 +113743,12 @@ webhooks: - from required: - body - comment: *612 - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + comment: *611 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114201,11 +113832,11 @@ webhooks: type: string enum: - created - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114287,11 +113918,11 @@ webhooks: type: string enum: - deleted - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114391,11 +114022,11 @@ webhooks: type: string required: - from - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114477,10 +114108,10 @@ webhooks: type: string enum: - labeled - discussion: *611 - enterprise: *595 - installation: *596 - label: &614 + discussion: *610 + enterprise: *594 + installation: *595 + label: &613 title: Label type: object properties: @@ -114513,8 +114144,8 @@ webhooks: - color - default - description - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114597,11 +114228,11 @@ webhooks: type: string enum: - locked - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114683,11 +114314,11 @@ webhooks: type: string enum: - pinned - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114769,11 +114400,11 @@ webhooks: type: string enum: - reopened - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114858,16 +114489,16 @@ webhooks: changes: type: object properties: - new_discussion: *611 - new_repository: *598 + new_discussion: *610 + new_repository: *597 required: - new_discussion - new_repository - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114950,10 +114581,10 @@ webhooks: type: string enum: - unanswered - discussion: *611 - old_answer: *613 - organization: *597 - repository: *598 + discussion: *610 + old_answer: *612 + organization: *596 + repository: *597 sender: *4 required: - action @@ -115035,12 +114666,12 @@ webhooks: type: string enum: - unlabeled - discussion: *611 - enterprise: *595 - installation: *596 - label: *614 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + label: *613 + organization: *596 + repository: *597 sender: *4 required: - action @@ -115123,11 +114754,11 @@ webhooks: type: string enum: - unlocked - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -115209,11 +114840,11 @@ webhooks: type: string enum: - unpinned - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -115286,7 +114917,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *595 + enterprise: *594 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -115964,9 +115595,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *596 - organization: *597 - repository: *598 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - forkee @@ -116112,9 +115743,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 pages: description: The pages that were updated. type: array @@ -116152,7 +115783,7 @@ webhooks: - action - sha - html_url - repository: *598 + repository: *597 sender: *4 required: - pages @@ -116228,10 +115859,10 @@ webhooks: type: string enum: - created - enterprise: *595 + enterprise: *594 installation: *20 - organization: *597 - repositories: &616 + organization: *596 + repositories: &615 description: An array of repository objects that the installation can access. type: array @@ -116257,8 +115888,8 @@ webhooks: - name - full_name - private - repository: *598 - requester: *615 + repository: *597 + requester: *614 sender: *4 required: - action @@ -116333,11 +115964,11 @@ webhooks: type: string enum: - deleted - enterprise: *595 + enterprise: *594 installation: *20 - organization: *597 - repositories: *616 - repository: *598 + organization: *596 + repositories: *615 + repository: *597 requester: type: - 'null' @@ -116414,11 +116045,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *595 + enterprise: *594 installation: *20 - organization: *597 - repositories: *616 - repository: *598 + organization: *596 + repositories: *615 + repository: *597 requester: type: - 'null' @@ -116495,10 +116126,10 @@ webhooks: type: string enum: - added - enterprise: *595 + enterprise: *594 installation: *20 - organization: *597 - repositories_added: &617 + organization: *596 + repositories_added: &616 description: An array of repository objects, which were added to the installation. type: array @@ -116544,15 +116175,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *598 - repository_selection: &618 + repository: *597 + repository_selection: &617 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *615 + requester: *614 sender: *4 required: - action @@ -116631,10 +116262,10 @@ webhooks: type: string enum: - removed - enterprise: *595 + enterprise: *594 installation: *20 - organization: *597 - repositories_added: *617 + organization: *596 + repositories_added: *616 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -116661,9 +116292,9 @@ webhooks: - name - full_name - private - repository: *598 - repository_selection: *618 - requester: *615 + repository: *597 + repository_selection: *617 + requester: *614 sender: *4 required: - action @@ -116742,11 +116373,11 @@ webhooks: type: string enum: - suspend - enterprise: *595 + enterprise: *594 installation: *20 - organization: *597 - repositories: *616 - repository: *598 + organization: *596 + repositories: *615 + repository: *597 requester: type: - 'null' @@ -116928,10 +116559,10 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 target_type: type: string @@ -117010,11 +116641,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *595 + enterprise: *594 installation: *20 - organization: *597 - repositories: *616 - repository: *598 + organization: *596 + repositories: *615 + repository: *597 requester: type: - 'null' @@ -117262,8 +116893,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -118453,8 +118084,8 @@ webhooks: - state - locked - assignee - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -118534,7 +118165,7 @@ webhooks: type: string enum: - deleted - comment: &619 + comment: &618 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -118701,8 +118332,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -119890,8 +119521,8 @@ webhooks: - state - locked - assignee - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -119971,7 +119602,7 @@ webhooks: type: string enum: - edited - changes: &644 + changes: &643 description: The changes to the comment. type: object properties: @@ -119983,9 +119614,9 @@ webhooks: type: string required: - from - comment: *619 - enterprise: *595 - installation: *596 + comment: *618 + enterprise: *594 + installation: *595 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -121174,8 +120805,8 @@ webhooks: - state - locked - assignee - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -121257,10 +120888,10 @@ webhooks: type: string enum: - assigned - assignee: *615 - enterprise: *595 - installation: *596 - issue: &622 + assignee: *614 + enterprise: *594 + installation: *595 + issue: &621 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -122204,8 +121835,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -122285,8 +121916,8 @@ webhooks: type: string enum: - closed - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -123378,8 +123009,8 @@ webhooks: required: - state - closed_at - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -123458,8 +123089,8 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -124396,8 +124027,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -124476,8 +124107,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -125418,7 +125049,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &620 + milestone: &619 title: Milestone description: A collection of related issues and pull requests. type: object @@ -125561,8 +125192,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -125661,8 +125292,8 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -126606,9 +126237,9 @@ webhooks: - active_lock_reason - body - reactions - label: *614 - organization: *597 - repository: *598 + label: *613 + organization: *596 + repository: *597 sender: *4 required: - action @@ -126688,8 +126319,8 @@ webhooks: type: string enum: - labeled - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -127632,9 +127263,9 @@ webhooks: - active_lock_reason - body - reactions - label: *614 - organization: *597 - repository: *598 + label: *613 + organization: *596 + repository: *597 sender: *4 required: - action @@ -127714,8 +127345,8 @@ webhooks: type: string enum: - locked - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -128660,8 +128291,8 @@ webhooks: format: uri user_view_type: type: string - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -128740,8 +128371,8 @@ webhooks: type: string enum: - milestoned - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -129680,9 +129311,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *620 - organization: *597 - repository: *598 + milestone: *619 + organization: *596 + repository: *597 sender: *4 required: - action @@ -131182,8 +130813,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -132126,8 +131757,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -132207,9 +131838,9 @@ webhooks: type: string enum: - pinned - enterprise: *595 - installation: *596 - issue: &621 + enterprise: *594 + installation: *595 + issue: &620 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -133146,8 +132777,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -133226,8 +132857,8 @@ webhooks: type: string enum: - reopened - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134171,8 +133802,8 @@ webhooks: format: uri user_view_type: type: string - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -135672,11 +135303,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *595 - installation: *596 - issue: *621 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + issue: *620 + organization: *596 + repository: *597 sender: *4 required: - action @@ -135757,7 +135388,7 @@ webhooks: type: string enum: - unassigned - assignee: &647 + assignee: &646 title: User type: - object @@ -135829,11 +135460,11 @@ webhooks: required: - login - id - enterprise: *595 - installation: *596 - issue: *622 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + issue: *621 + organization: *596 + repository: *597 sender: *4 required: - action @@ -135912,12 +135543,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *595 - installation: *596 - issue: *622 - label: *614 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + issue: *621 + label: *613 + organization: *596 + repository: *597 sender: *4 required: - action @@ -135997,8 +135628,8 @@ webhooks: type: string enum: - unlocked - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136941,8 +136572,8 @@ webhooks: format: uri user_view_type: type: string - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -137022,11 +136653,11 @@ webhooks: type: string enum: - unpinned - enterprise: *595 - installation: *596 - issue: *621 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + issue: *620 + organization: *596 + repository: *597 sender: *4 required: - action @@ -137105,11 +136736,11 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - label: *614 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + label: *613 + organization: *596 + repository: *597 sender: *4 required: - action @@ -137187,11 +136818,11 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - label: *614 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + label: *613 + organization: *596 + repository: *597 sender: *4 required: - action @@ -137301,11 +136932,11 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 - label: *614 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + label: *613 + organization: *596 + repository: *597 sender: *4 required: - action @@ -137387,9 +137018,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *595 - installation: *596 - marketplace_purchase: &623 + enterprise: *594 + installation: *595 + marketplace_purchase: &622 title: Marketplace Purchase type: object required: @@ -137477,8 +137108,8 @@ webhooks: type: integer unit_count: type: integer - organization: *597 - previous_marketplace_purchase: &624 + organization: *596 + previous_marketplace_purchase: &623 title: Marketplace Purchase type: object properties: @@ -137562,7 +137193,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *598 + repository: *597 sender: *4 required: - action @@ -137642,10 +137273,10 @@ webhooks: - changed effective_date: type: string - enterprise: *595 - installation: *596 - marketplace_purchase: *623 - organization: *597 + enterprise: *594 + installation: *595 + marketplace_purchase: *622 + organization: *596 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -137733,7 +137364,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *598 + repository: *597 sender: *4 required: - action @@ -137815,10 +137446,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *595 - installation: *596 - marketplace_purchase: *623 - organization: *597 + enterprise: *594 + installation: *595 + marketplace_purchase: *622 + organization: *596 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -137904,7 +137535,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *598 + repository: *597 sender: *4 required: - action @@ -137985,8 +137616,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 marketplace_purchase: title: Marketplace Purchase type: object @@ -138072,9 +137703,9 @@ webhooks: type: integer unit_count: type: integer - organization: *597 - previous_marketplace_purchase: *624 - repository: *598 + organization: *596 + previous_marketplace_purchase: *623 + repository: *597 sender: *4 required: - action @@ -138154,12 +137785,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *595 - installation: *596 - marketplace_purchase: *623 - organization: *597 - previous_marketplace_purchase: *624 - repository: *598 + enterprise: *594 + installation: *595 + marketplace_purchase: *622 + organization: *596 + previous_marketplace_purchase: *623 + repository: *597 sender: *4 required: - action @@ -138261,11 +137892,11 @@ webhooks: type: string required: - to - enterprise: *595 - installation: *596 - member: *615 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + member: *614 + organization: *596 + repository: *597 sender: *4 required: - action @@ -138367,11 +137998,11 @@ webhooks: type: - string - 'null' - enterprise: *595 - installation: *596 - member: *615 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + member: *614 + organization: *596 + repository: *597 sender: *4 required: - action @@ -138450,11 +138081,11 @@ webhooks: type: string enum: - removed - enterprise: *595 - installation: *596 - member: *615 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + member: *614 + organization: *596 + repository: *597 sender: *4 required: - action @@ -138532,11 +138163,11 @@ webhooks: type: string enum: - added - enterprise: *595 - installation: *596 - member: *615 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + member: *614 + organization: *596 + repository: *597 scope: description: The scope of the membership. Currently, can only be `team`. @@ -138614,7 +138245,7 @@ webhooks: required: - login - id - team: &625 + team: &624 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -138807,11 +138438,11 @@ webhooks: type: string enum: - removed - enterprise: *595 - installation: *596 - member: *615 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + member: *614 + organization: *596 + repository: *597 scope: description: The scope of the membership. Currently, can only be `team`. @@ -138890,7 +138521,7 @@ webhooks: required: - login - id - team: *625 + team: *624 required: - action - scope @@ -138972,8 +138603,8 @@ webhooks: type: string enum: - checks_requested - installation: *596 - merge_group: &626 + installation: *595 + merge_group: &625 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -138992,15 +138623,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *325 + head_commit: *324 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -139086,10 +138717,10 @@ webhooks: - merged - invalidated - dequeued - installation: *596 - merge_group: *626 - organization: *597 - repository: *598 + installation: *595 + merge_group: *625 + organization: *596 + repository: *597 sender: *4 required: - action @@ -139162,7 +138793,7 @@ webhooks: type: string enum: - deleted - enterprise: *595 + enterprise: *594 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -139270,12 +138901,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *596 - organization: *597 + installation: *595 + organization: *596 repository: anyOf: - type: 'null' - - *598 + - *597 sender: *4 required: - action @@ -139355,11 +138986,11 @@ webhooks: type: string enum: - closed - enterprise: *595 - installation: *596 - milestone: *620 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + milestone: *619 + organization: *596 + repository: *597 sender: *4 required: - action @@ -139438,9 +139069,9 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - milestone: &627 + enterprise: *594 + installation: *595 + milestone: &626 title: Milestone description: A collection of related issues and pull requests. type: object @@ -139582,8 +139213,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -139662,11 +139293,11 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - milestone: *620 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + milestone: *619 + organization: *596 + repository: *597 sender: *4 required: - action @@ -139776,11 +139407,11 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 - milestone: *620 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + milestone: *619 + organization: *596 + repository: *597 sender: *4 required: - action @@ -139860,11 +139491,11 @@ webhooks: type: string enum: - opened - enterprise: *595 - installation: *596 - milestone: *627 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + milestone: *626 + organization: *596 + repository: *597 sender: *4 required: - action @@ -139943,11 +139574,11 @@ webhooks: type: string enum: - blocked - blocked_user: *615 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + blocked_user: *614 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -140026,11 +139657,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *615 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + blocked_user: *614 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -140109,9 +139740,9 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - membership: &628 + enterprise: *594 + installation: *595 + membership: &627 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -140205,8 +139836,8 @@ webhooks: - role - organization_url - user - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -140284,11 +139915,11 @@ webhooks: type: string enum: - member_added - enterprise: *595 - installation: *596 - membership: *628 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + membership: *627 + organization: *596 + repository: *597 sender: *4 required: - action @@ -140367,8 +139998,8 @@ webhooks: type: string enum: - member_invited - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -140490,10 +140121,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 - user: *615 + user: *614 required: - action - invitation @@ -140571,11 +140202,11 @@ webhooks: type: string enum: - member_removed - enterprise: *595 - installation: *596 - membership: *628 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + membership: *627 + organization: *596 + repository: *597 sender: *4 required: - action @@ -140662,11 +140293,11 @@ webhooks: properties: from: type: string - enterprise: *595 - installation: *596 - membership: *628 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + membership: *627 + organization: *596 + repository: *597 sender: *4 required: - action @@ -140742,9 +140373,9 @@ webhooks: type: string enum: - published - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 package: description: Information about the package. type: object @@ -141267,7 +140898,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &629 + items: &628 title: Ruby Gems metadata type: object properties: @@ -141364,7 +140995,7 @@ webhooks: - owner - package_version - registry - repository: *598 + repository: *597 sender: *4 required: - action @@ -141440,9 +141071,9 @@ webhooks: type: string enum: - updated - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 package: description: Information about the package. type: object @@ -141804,7 +141435,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *629 + items: *628 source_url: type: string format: uri @@ -141875,7 +141506,7 @@ webhooks: - owner - package_version - registry - repository: *598 + repository: *597 sender: *4 required: - action @@ -142056,12 +141687,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *595 + enterprise: *594 id: type: integer - installation: *596 - organization: *597 - repository: *598 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - id @@ -142141,7 +141772,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &630 + personal_access_token_request: &629 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -142291,10 +141922,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *595 - organization: *597 + enterprise: *594 + organization: *596 sender: *4 - installation: *596 + installation: *595 required: - action - personal_access_token_request @@ -142373,11 +142004,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *630 - enterprise: *595 - organization: *597 + personal_access_token_request: *629 + enterprise: *594 + organization: *596 sender: *4 - installation: *596 + installation: *595 required: - action - personal_access_token_request @@ -142455,11 +142086,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *630 - enterprise: *595 - organization: *597 + personal_access_token_request: *629 + enterprise: *594 + organization: *596 sender: *4 - installation: *596 + installation: *595 required: - action - personal_access_token_request @@ -142536,11 +142167,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *630 - organization: *597 - enterprise: *595 + personal_access_token_request: *629 + organization: *596 + enterprise: *594 sender: *4 - installation: *596 + installation: *595 required: - action - personal_access_token_request @@ -142644,7 +142275,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *631 + last_response: *630 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -142676,8 +142307,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 zen: description: Random string of GitHub zen. @@ -142922,10 +142553,10 @@ webhooks: - from required: - note - enterprise: *595 - installation: *596 - organization: *597 - project_card: &632 + enterprise: *594 + installation: *595 + organization: *596 + project_card: &631 title: Project Card type: object properties: @@ -143048,7 +142679,7 @@ webhooks: - creator - created_at - updated_at - repository: *598 + repository: *597 sender: *4 required: - action @@ -143129,11 +142760,11 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - project_card: *632 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + project_card: *631 + repository: *597 sender: *4 required: - action @@ -143213,9 +142844,9 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 project_card: title: Project Card type: object @@ -143345,7 +142976,7 @@ webhooks: repository: anyOf: - type: 'null' - - *598 + - *597 sender: *4 required: - action @@ -143439,11 +143070,11 @@ webhooks: - from required: - note - enterprise: *595 - installation: *596 - organization: *597 - project_card: *632 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + project_card: *631 + repository: *597 sender: *4 required: - action @@ -143537,9 +143168,9 @@ webhooks: - from required: - column_id - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 project_card: allOf: - title: Project Card @@ -143736,7 +143367,7 @@ webhooks: type: string required: - after_id - repository: *598 + repository: *597 sender: *4 required: - action @@ -143816,10 +143447,10 @@ webhooks: type: string enum: - closed - enterprise: *595 - installation: *596 - organization: *597 - project: &634 + enterprise: *594 + installation: *595 + organization: *596 + project: &633 title: Project type: object properties: @@ -143946,7 +143577,7 @@ webhooks: - creator - created_at - updated_at - repository: *598 + repository: *597 sender: *4 required: - action @@ -144026,10 +143657,10 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - project_column: &633 + enterprise: *594 + installation: *595 + organization: *596 + project_column: &632 title: Project Column type: object properties: @@ -144069,7 +143700,7 @@ webhooks: - name - created_at - updated_at - repository: *598 + repository: *597 sender: *4 required: - action @@ -144148,14 +143779,14 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 - project_column: *633 + enterprise: *594 + installation: *595 + organization: *596 + project_column: *632 repository: anyOf: - type: 'null' - - *598 + - *597 sender: *4 required: - action @@ -144244,11 +143875,11 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 - organization: *597 - project_column: *633 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + project_column: *632 + repository: *597 sender: *4 required: - action @@ -144328,11 +143959,11 @@ webhooks: type: string enum: - moved - enterprise: *595 - installation: *596 - organization: *597 - project_column: *633 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + project_column: *632 + repository: *597 sender: *4 required: - action @@ -144412,11 +144043,11 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - project: *634 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + project: *633 + repository: *597 sender: *4 required: - action @@ -144496,14 +144127,14 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 - project: *634 + enterprise: *594 + installation: *595 + organization: *596 + project: *633 repository: anyOf: - type: 'null' - - *598 + - *597 sender: *4 required: - action @@ -144604,11 +144235,11 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 - organization: *597 - project: *634 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + project: *633 + repository: *597 sender: *4 required: - action @@ -144687,11 +144318,11 @@ webhooks: type: string enum: - reopened - enterprise: *595 - installation: *596 - organization: *597 - project: *634 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + project: *633 + repository: *597 sender: *4 required: - action @@ -144772,9 +144403,9 @@ webhooks: type: string enum: - closed - installation: *596 - organization: *597 - projects_v2: &635 + installation: *595 + organization: *596 + projects_v2: &634 title: Projects v2 Project description: A projects v2 project type: object @@ -144922,9 +144553,9 @@ webhooks: type: string enum: - created - installation: *596 - organization: *597 - projects_v2: *635 + installation: *595 + organization: *596 + projects_v2: *634 sender: *4 required: - action @@ -145005,9 +144636,9 @@ webhooks: type: string enum: - deleted - installation: *596 - organization: *597 - projects_v2: *635 + installation: *595 + organization: *596 + projects_v2: *634 sender: *4 required: - action @@ -145128,9 +144759,9 @@ webhooks: type: string to: type: string - installation: *596 - organization: *597 - projects_v2: *635 + installation: *595 + organization: *596 + projects_v2: *634 sender: *4 required: - action @@ -145213,7 +144844,7 @@ webhooks: type: string enum: - archived - changes: &639 + changes: &638 type: object properties: archived_at: @@ -145229,9 +144860,9 @@ webhooks: - string - 'null' format: date-time - installation: *596 - organization: *597 - projects_v2_item: &636 + installation: *595 + organization: *596 + projects_v2_item: &635 title: Projects v2 Item description: An item belonging to a project type: object @@ -145370,9 +145001,9 @@ webhooks: - 'null' to: type: string - installation: *596 - organization: *597 - projects_v2_item: *636 + installation: *595 + organization: *596 + projects_v2_item: *635 sender: *4 required: - action @@ -145454,9 +145085,9 @@ webhooks: type: string enum: - created - installation: *596 - organization: *597 - projects_v2_item: *636 + installation: *595 + organization: *596 + projects_v2_item: *635 sender: *4 required: - action @@ -145537,9 +145168,9 @@ webhooks: type: string enum: - deleted - installation: *596 - organization: *597 - projects_v2_item: *636 + installation: *595 + organization: *596 + projects_v2_item: *635 sender: *4 required: - action @@ -145644,7 +145275,7 @@ webhooks: oneOf: - type: string - type: integer - - &637 + - &636 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -145664,7 +145295,7 @@ webhooks: required: - id - name - - &638 + - &637 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -145693,8 +145324,8 @@ webhooks: oneOf: - type: string - type: integer + - *636 - *637 - - *638 type: - 'null' - string @@ -145717,9 +145348,9 @@ webhooks: - 'null' required: - body - installation: *596 - organization: *597 - projects_v2_item: *636 + installation: *595 + organization: *596 + projects_v2_item: *635 sender: *4 required: - action @@ -145816,9 +145447,9 @@ webhooks: type: - string - 'null' - installation: *596 - organization: *597 - projects_v2_item: *636 + installation: *595 + organization: *596 + projects_v2_item: *635 sender: *4 required: - action @@ -145901,10 +145532,10 @@ webhooks: type: string enum: - restored - changes: *639 - installation: *596 - organization: *597 - projects_v2_item: *636 + changes: *638 + installation: *595 + organization: *596 + projects_v2_item: *635 sender: *4 required: - action @@ -145986,9 +145617,9 @@ webhooks: type: string enum: - reopened - installation: *596 - organization: *597 - projects_v2: *635 + installation: *595 + organization: *596 + projects_v2: *634 sender: *4 required: - action @@ -146069,9 +145700,9 @@ webhooks: type: string enum: - created - installation: *596 - organization: *597 - projects_v2_status_update: &640 + installation: *595 + organization: *596 + projects_v2_status_update: &639 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -146206,9 +145837,9 @@ webhooks: type: string enum: - deleted - installation: *596 - organization: *597 - projects_v2_status_update: *640 + installation: *595 + organization: *596 + projects_v2_status_update: *639 sender: *4 required: - action @@ -146354,9 +145985,9 @@ webhooks: - string - 'null' format: date - installation: *596 - organization: *597 - projects_v2_status_update: *640 + installation: *595 + organization: *596 + projects_v2_status_update: *639 sender: *4 required: - action @@ -146427,10 +146058,10 @@ webhooks: title: public event type: object properties: - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - repository @@ -146507,13 +146138,13 @@ webhooks: type: string enum: - assigned - assignee: *615 - enterprise: *595 - installation: *596 - number: &641 + assignee: *614 + enterprise: *594 + installation: *595 + number: &640 description: The pull request number. type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -148862,7 +148493,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -148944,11 +148575,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 number: type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -151290,7 +150921,7 @@ webhooks: - draft reason: type: string - repository: *598 + repository: *597 sender: *4 required: - action @@ -151372,11 +151003,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 number: type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -153718,7 +153349,7 @@ webhooks: - draft reason: type: string - repository: *598 + repository: *597 sender: *4 required: - action @@ -153800,13 +153431,13 @@ webhooks: type: string enum: - closed - enterprise: *595 - installation: *596 - number: *641 - organization: *597 - pull_request: &642 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 + pull_request: &641 allOf: - - *473 + - *472 - type: object properties: allow_auto_merge: @@ -153868,7 +153499,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *598 + repository: *597 sender: *4 required: - action @@ -153949,12 +153580,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *595 - installation: *596 - number: *641 - organization: *597 - pull_request: *642 - repository: *598 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 + pull_request: *641 + repository: *597 sender: *4 required: - action @@ -154034,11 +153665,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *595 - milestone: *371 - number: *641 - organization: *597 - pull_request: &643 + enterprise: *594 + milestone: *370 + number: *640 + organization: *596 + pull_request: &642 title: Pull Request type: object properties: @@ -156365,7 +155996,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -156444,11 +156075,11 @@ webhooks: type: string enum: - dequeued - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 number: type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -158794,7 +158425,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *598 + repository: *597 sender: *4 required: - action @@ -158918,12 +158549,12 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 - number: *641 - organization: *597 - pull_request: *642 - repository: *598 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 + pull_request: *641 + repository: *597 sender: *4 required: - action @@ -159003,11 +158634,11 @@ webhooks: type: string enum: - enqueued - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 number: type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -161338,7 +160969,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -161418,11 +161049,11 @@ webhooks: type: string enum: - labeled - enterprise: *595 - installation: *596 - label: *614 - number: *641 - organization: *597 + enterprise: *594 + installation: *595 + label: *613 + number: *640 + organization: *596 pull_request: title: Pull Request type: object @@ -163770,7 +163401,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -163851,10 +163482,10 @@ webhooks: type: string enum: - locked - enterprise: *595 - installation: *596 - number: *641 - organization: *597 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 pull_request: title: Pull Request type: object @@ -166200,7 +165831,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -166280,12 +165911,12 @@ webhooks: type: string enum: - milestoned - enterprise: *595 - milestone: *371 - number: *641 - organization: *597 - pull_request: *643 - repository: *598 + enterprise: *594 + milestone: *370 + number: *640 + organization: *596 + pull_request: *642 + repository: *597 sender: *4 required: - action @@ -166364,12 +165995,12 @@ webhooks: type: string enum: - opened - enterprise: *595 - installation: *596 - number: *641 - organization: *597 - pull_request: *642 - repository: *598 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 + pull_request: *641 + repository: *597 sender: *4 required: - action @@ -166450,12 +166081,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *595 - installation: *596 - number: *641 - organization: *597 - pull_request: *642 - repository: *598 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 + pull_request: *641 + repository: *597 sender: *4 required: - action @@ -166535,12 +166166,12 @@ webhooks: type: string enum: - reopened - enterprise: *595 - installation: *596 - number: *641 - organization: *597 - pull_request: *642 - repository: *598 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 + pull_request: *641 + repository: *597 sender: *4 required: - action @@ -166915,9 +166546,9 @@ webhooks: - start_side - side - reactions - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 pull_request: type: object properties: @@ -169147,7 +168778,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *598 + repository: *597 sender: *4 required: - action @@ -169227,7 +168858,7 @@ webhooks: type: string enum: - deleted - comment: &645 + comment: &644 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -169520,9 +169151,9 @@ webhooks: - start_side - side - reactions - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 pull_request: type: object properties: @@ -171740,7 +171371,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *598 + repository: *597 sender: *4 required: - action @@ -171820,11 +171451,11 @@ webhooks: type: string enum: - edited - changes: *644 - comment: *645 - enterprise: *595 - installation: *596 - organization: *597 + changes: *643 + comment: *644 + enterprise: *594 + installation: *595 + organization: *596 pull_request: type: object properties: @@ -174045,7 +173676,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *598 + repository: *597 sender: *4 required: - action @@ -174126,9 +173757,9 @@ webhooks: type: string enum: - dismissed - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 pull_request: title: Simple Pull Request type: object @@ -176361,7 +175992,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *598 + repository: *597 review: description: The review that was affected. type: object @@ -176607,9 +176238,9 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 pull_request: title: Simple Pull Request type: object @@ -178723,8 +178354,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *598 - review: &646 + repository: *597 + review: &645 description: The review that was affected. type: object properties: @@ -178957,12 +178588,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 number: description: The pull request number. type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -181309,7 +180940,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 requested_reviewer: title: User type: @@ -181395,12 +181026,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 number: description: The pull request number. type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -183754,7 +183385,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 requested_team: title: Team description: Groups of organization members that gives permissions @@ -183949,12 +183580,12 @@ webhooks: type: string enum: - review_requested - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 number: description: The pull request number. type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -186303,7 +185934,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 requested_reviewer: title: User type: @@ -186390,12 +186021,12 @@ webhooks: type: string enum: - review_requested - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 number: description: The pull request number. type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -188735,7 +188366,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 requested_team: title: Team description: Groups of organization members that gives permissions @@ -188919,9 +188550,9 @@ webhooks: type: string enum: - submitted - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 pull_request: title: Simple Pull Request type: object @@ -191157,8 +190788,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *598 - review: *646 + repository: *597 + review: *645 sender: *4 required: - action @@ -191238,9 +190869,9 @@ webhooks: type: string enum: - resolved - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 pull_request: title: Simple Pull Request type: object @@ -193371,7 +193002,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *598 + repository: *597 sender: *4 thread: type: object @@ -193763,9 +193394,9 @@ webhooks: type: string enum: - unresolved - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 pull_request: title: Simple Pull Request type: object @@ -195879,7 +195510,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *598 + repository: *597 sender: *4 thread: type: object @@ -196273,10 +195904,10 @@ webhooks: type: string before: type: string - enterprise: *595 - installation: *596 - number: *641 - organization: *597 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 pull_request: title: Pull Request type: object @@ -198611,7 +198242,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -198693,11 +198324,11 @@ webhooks: type: string enum: - unassigned - assignee: *647 - enterprise: *595 - installation: *596 - number: *641 - organization: *597 + assignee: *646 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 pull_request: title: Pull Request type: object @@ -201047,7 +200678,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -201126,11 +200757,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *595 - installation: *596 - label: *614 - number: *641 - organization: *597 + enterprise: *594 + installation: *595 + label: *613 + number: *640 + organization: *596 pull_request: title: Pull Request type: object @@ -203469,7 +203100,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -203550,10 +203181,10 @@ webhooks: type: string enum: - unlocked - enterprise: *595 - installation: *596 - number: *641 - organization: *597 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 pull_request: title: Pull Request type: object @@ -205882,7 +205513,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -206085,7 +205716,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *595 + enterprise: *594 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -206180,8 +205811,8 @@ webhooks: - url - author - committer - installation: *596 - organization: *597 + installation: *595 + organization: *596 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -206769,9 +206400,9 @@ webhooks: type: string enum: - published - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 registry_package: type: object properties: @@ -207248,7 +206879,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *629 + items: *628 summary: type: string tag_name: @@ -207304,7 +206935,7 @@ webhooks: - owner - package_version - registry - repository: *598 + repository: *597 sender: *4 required: - action @@ -207382,9 +207013,9 @@ webhooks: type: string enum: - updated - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 registry_package: type: object properties: @@ -207696,7 +207327,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *629 + items: *628 summary: type: string tag_name: @@ -207746,7 +207377,7 @@ webhooks: - owner - package_version - registry - repository: *598 + repository: *597 sender: *4 required: - action @@ -207823,10 +207454,10 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - release: &648 + enterprise: *594 + installation: *595 + organization: *596 + release: &647 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -208142,7 +207773,7 @@ webhooks: - tarball_url - zipball_url - body - repository: *598 + repository: *597 sender: *4 required: - action @@ -208219,11 +207850,11 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 - release: *648 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + release: *647 + repository: *597 sender: *4 required: - action @@ -208331,11 +207962,11 @@ webhooks: type: boolean required: - to - enterprise: *595 - installation: *596 - organization: *597 - release: *648 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + release: *647 + repository: *597 sender: *4 required: - action @@ -208413,9 +208044,9 @@ webhooks: type: string enum: - prereleased - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -208736,7 +208367,7 @@ webhooks: - string - 'null' format: uri - repository: *598 + repository: *597 sender: *4 required: - action @@ -208812,10 +208443,10 @@ webhooks: type: string enum: - published - enterprise: *595 - installation: *596 - organization: *597 - release: &649 + enterprise: *594 + installation: *595 + organization: *596 + release: &648 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -209133,7 +208764,7 @@ webhooks: - string - 'null' format: uri - repository: *598 + repository: *597 sender: *4 required: - action @@ -209209,11 +208840,11 @@ webhooks: type: string enum: - released - enterprise: *595 - installation: *596 - organization: *597 - release: *648 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + release: *647 + repository: *597 sender: *4 required: - action @@ -209289,11 +208920,11 @@ webhooks: type: string enum: - unpublished - enterprise: *595 - installation: *596 - organization: *597 - release: *649 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + release: *648 + repository: *597 sender: *4 required: - action @@ -209369,11 +209000,11 @@ webhooks: type: string enum: - published - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - repository_advisory: *527 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + repository_advisory: *526 sender: *4 required: - action @@ -209449,11 +209080,11 @@ webhooks: type: string enum: - reported - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - repository_advisory: *527 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + repository_advisory: *526 sender: *4 required: - action @@ -209529,10 +209160,10 @@ webhooks: type: string enum: - archived - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -209609,10 +209240,10 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -209690,10 +209321,10 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -209778,10 +209409,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -209896,10 +209527,10 @@ webhooks: - 'null' items: type: string - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -209971,10 +209602,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 status: type: string @@ -210055,10 +209686,10 @@ webhooks: type: string enum: - privatized - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -210135,10 +209766,10 @@ webhooks: type: string enum: - publicized - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -210232,10 +209863,10 @@ webhooks: - name required: - repository - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -210315,11 +209946,11 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - repository_ruleset: *215 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + repository_ruleset: *209 sender: *4 required: - action @@ -210397,11 +210028,11 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - repository_ruleset: *215 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + repository_ruleset: *209 sender: *4 required: - action @@ -210479,11 +210110,11 @@ webhooks: type: string enum: - edited - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - repository_ruleset: *215 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + repository_ruleset: *209 changes: type: object properties: @@ -210502,16 +210133,16 @@ webhooks: properties: added: type: array - items: *209 + items: *203 deleted: type: array - items: *209 + items: *203 updated: type: array items: type: object properties: - condition: *209 + condition: *203 changes: type: object properties: @@ -210544,16 +210175,16 @@ webhooks: properties: added: type: array - items: *214 + items: *208 deleted: type: array - items: *214 + items: *208 updated: type: array items: type: object properties: - rule: *214 + rule: *208 changes: type: object properties: @@ -210790,10 +210421,10 @@ webhooks: - from required: - owner - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -210871,10 +210502,10 @@ webhooks: type: string enum: - unarchived - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -210952,7 +210583,7 @@ webhooks: type: string enum: - create - alert: &650 + alert: &649 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -211076,10 +210707,10 @@ webhooks: type: string enum: - open - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -211289,10 +210920,10 @@ webhooks: type: string enum: - dismissed - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -211370,11 +211001,11 @@ webhooks: type: string enum: - reopen - alert: *650 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + alert: *649 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -211576,10 +211207,10 @@ webhooks: enum: - fixed - open - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -211657,17 +211288,17 @@ webhooks: type: string enum: - created - alert: &651 + alert: &650 type: object properties: - number: *46 - created_at: *47 + number: *44 + created_at: *45 updated_at: anyOf: - type: 'null' - - *48 - url: *49 - html_url: *50 + - *46 + url: *47 + html_url: *48 locations_url: type: string format: uri @@ -211738,6 +211369,12 @@ webhooks: anyOf: - type: 'null' - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. push_protection_bypass_request_comment: type: - string @@ -211761,10 +211398,10 @@ webhooks: - 'null' description: Whether the detected secret was found in multiple repositories in the same organization or business. - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -211845,11 +211482,11 @@ webhooks: type: string enum: - created - alert: *651 - installation: *596 - location: *652 - organization: *597 - repository: *598 + alert: *650 + installation: *595 + location: *651 + organization: *596 + repository: *597 sender: *4 required: - location @@ -212087,11 +211724,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *651 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + alert: *650 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -212169,11 +211806,11 @@ webhooks: type: string enum: - reopened - alert: *651 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + alert: *650 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -212251,11 +211888,11 @@ webhooks: type: string enum: - resolved - alert: *651 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + alert: *650 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -212333,11 +211970,11 @@ webhooks: type: string enum: - validated - alert: *651 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + alert: *650 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -212413,11 +212050,11 @@ webhooks: type: string enum: - published - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - security_advisory: &653 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + security_advisory: &652 description: The details of the security advisory, including summary, description, and severity. type: object @@ -212434,7 +212071,7 @@ webhooks: required: - vector_string - score - cvss_severities: *44 + cvss_severities: *41 cwes: type: array items: @@ -212603,11 +212240,11 @@ webhooks: type: string enum: - updated - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - security_advisory: *653 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + security_advisory: *652 sender: *4 required: - action @@ -212680,10 +212317,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -212701,7 +212338,7 @@ webhooks: required: - vector_string - score - cvss_severities: *44 + cvss_severities: *41 cwes: type: array items: @@ -212869,11 +212506,11 @@ webhooks: from: type: object properties: - security_and_analysis: *208 - enterprise: *595 - installation: *596 - organization: *597 - repository: *253 + security_and_analysis: *202 + enterprise: *594 + installation: *595 + organization: *596 + repository: *252 sender: *4 required: - changes @@ -212951,12 +212588,12 @@ webhooks: type: string enum: - cancelled - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - sponsorship: &654 + sponsorship: &653 type: object properties: created_at: @@ -213261,12 +212898,12 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - sponsorship: *654 + sponsorship: *653 required: - action - sponsorship @@ -213354,12 +212991,12 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - sponsorship: *654 + sponsorship: *653 required: - action - changes @@ -213436,17 +213073,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &655 + effective_date: &654 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: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - sponsorship: *654 + sponsorship: *653 required: - action - sponsorship @@ -213520,7 +213157,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &656 + changes: &655 type: object properties: tier: @@ -213564,13 +213201,13 @@ webhooks: - from required: - tier - effective_date: *655 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + effective_date: *654 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - sponsorship: *654 + sponsorship: *653 required: - action - changes @@ -213647,13 +213284,13 @@ webhooks: type: string enum: - tier_changed - changes: *656 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + changes: *655 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - sponsorship: *654 + sponsorship: *653 required: - action - changes @@ -213727,10 +213364,10 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -213814,10 +213451,10 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -214250,15 +213887,15 @@ webhooks: type: - string - 'null' - enterprise: *595 + enterprise: *594 id: description: The unique identifier of the status. type: integer - installation: *596 + installation: *595 name: type: string - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 sha: description: The Commit SHA. @@ -214368,15 +214005,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *72 - parent_issue_repo: *57 + parent_issue: *67 + parent_issue_repo: *52 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *72 - installation: *596 - organization: *597 - repository: *598 + sub_issue: *67 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -214460,15 +214097,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *72 - parent_issue_repo: *57 + parent_issue: *67 + parent_issue_repo: *52 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *72 - installation: *596 - organization: *597 - repository: *598 + sub_issue: *67 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -214552,15 +214189,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *72 - sub_issue_repo: *57 + sub_issue: *67 + sub_issue_repo: *52 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *72 - installation: *596 - organization: *597 - repository: *598 + parent_issue: *67 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -214644,15 +214281,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *72 - sub_issue_repo: *57 + sub_issue: *67 + sub_issue_repo: *52 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *72 - installation: *596 - organization: *597 - repository: *598 + parent_issue: *67 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -214729,12 +214366,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - team: &657 + team: &656 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -214927,9 +214564,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 repository: title: Repository description: A git repository @@ -215399,7 +215036,7 @@ webhooks: - topics - visibility sender: *4 - team: *657 + team: *656 required: - action - team @@ -215475,9 +215112,9 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 repository: title: Repository description: A git repository @@ -215947,7 +215584,7 @@ webhooks: - topics - visibility sender: *4 - team: *657 + team: *656 required: - action - team @@ -216024,9 +215661,9 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 repository: title: Repository description: A git repository @@ -216496,7 +216133,7 @@ webhooks: - topics - visibility sender: *4 - team: *657 + team: *656 required: - action - team @@ -216640,9 +216277,9 @@ webhooks: - from required: - permissions - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 repository: title: Repository description: A git repository @@ -217112,7 +216749,7 @@ webhooks: - topics - visibility sender: *4 - team: *657 + team: *656 required: - action - changes @@ -217190,9 +216827,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 repository: title: Repository description: A git repository @@ -217662,7 +217299,7 @@ webhooks: - topics - visibility sender: *4 - team: *657 + team: *656 required: - action - team @@ -217738,10 +217375,10 @@ webhooks: type: string enum: - started - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -217814,17 +217451,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *595 + enterprise: *594 inputs: type: - object - 'null' additionalProperties: true - installation: *596 - organization: *597 + installation: *595 + organization: *596 ref: type: string - repository: *598 + repository: *597 sender: *4 workflow: type: string @@ -217906,10 +217543,10 @@ webhooks: type: string enum: - completed - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 workflow_job: allOf: @@ -218165,7 +217802,7 @@ webhooks: type: string required: - conclusion - deployment: *391 + deployment: *390 required: - action - repository @@ -218244,10 +217881,10 @@ webhooks: type: string enum: - in_progress - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 workflow_job: allOf: @@ -218529,7 +218166,7 @@ webhooks: required: - status - steps - deployment: *391 + deployment: *390 required: - action - repository @@ -218608,10 +218245,10 @@ webhooks: type: string enum: - queued - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 workflow_job: type: object @@ -218757,7 +218394,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *391 + deployment: *390 required: - action - repository @@ -218836,10 +218473,10 @@ webhooks: type: string enum: - waiting - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 workflow_job: type: object @@ -218986,7 +218623,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *391 + deployment: *390 required: - action - repository @@ -219066,12 +218703,12 @@ webhooks: type: string enum: - completed - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - workflow: *610 + workflow: *609 workflow_run: title: Workflow Run type: object @@ -220090,12 +219727,12 @@ webhooks: type: string enum: - in_progress - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - workflow: *610 + workflow: *609 workflow_run: title: Workflow Run type: object @@ -221099,12 +220736,12 @@ webhooks: type: string enum: - requested - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - workflow: *610 + workflow: *609 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index ceb51d774..7c85add84 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -17808,1896 +17808,6 @@ } } }, - "/enterprises/{enterprise}/copilot/billing/seats": { - "get": { - "summary": "List all Copilot seat assignments for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nLists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription.\n\nUsers with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once.\n\nFor each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array.\nEach seat object contains information about the assigned user's most recent Copilot activity. Users must have\ntelemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data,\nsee \"[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization).\"\n\nOnly enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams.\n\nPersonal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/list-copilot-seats-for-enterprise", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-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": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 50 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "total_seats": { - "type": "integer", - "description": "The total number of Copilot seats the enterprise is being billed for. Users with access through multiple organizations or enterprise teams are only counted once." - }, - "seats": { - "type": "array", - "items": { - "title": "Copilot Business Seat Detail", - "description": "Information about a Copilot Business seat assignment for a user, team, or organization.", - "type": "object", - "properties": { - "assignee": { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - }, - "organization": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Organization Simple", - "description": "A GitHub organization.", - "type": "object", - "properties": { - "login": { - "type": "string", - "examples": [ - "github" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEyOk9yZ2FuaXphdGlvbjE=" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/repos" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/orgs/github/events" - ] - }, - "hooks_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/hooks" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/issues" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/members{/member}" - ] - }, - "public_members_url": { - "type": "string", - "examples": [ - "https://api.github.com/orgs/github/public_members{/member}" - ] - }, - "avatar_url": { - "type": "string", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "A great organization" - ] - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - } - ] - }, - "assigning_team": { - "description": "The team through which the assignee is granted access to GitHub Copilot, if applicable.", - "oneOf": [ - { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": [ - "string", - "null" - ] - }, - "privacy": { - "type": "string" - }, - "notification_setting": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } - }, - "required": [ - "pull", - "triage", - "push", - "maintain", - "admin" - ] - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VGVhbTE=" - ] - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1" - ] - }, - "members_url": { - "type": "string", - "examples": [ - "https://api.github.com/organizations/1/team/1/members{/member}" - ] - }, - "name": { - "description": "Name of the team", - "type": "string", - "examples": [ - "Justice League" - ] - }, - "description": { - "description": "Description of the team", - "type": [ - "string", - "null" - ], - "examples": [ - "A great team." - ] - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "examples": [ - "admin" - ] - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "examples": [ - "closed" - ] - }, - "notification_setting": { - "description": "The notification setting the team has set", - "type": "string", - "examples": [ - "notifications_enabled" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/orgs/rails/teams/core" - ] - }, - "repositories_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/organizations/1/team/1/repos" - ] - }, - "slug": { - "type": "string", - "examples": [ - "justice-league" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "type": "string", - "examples": [ - "uid=example,ou=users,dc=github,dc=com" - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "parent" - ] - }, - { - "title": "Enterprise Team", - "description": "Group of enterprise owners and/or members", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "sync_to_organizations": { - "type": "string", - "examples": [ - "disabled | all" - ] - }, - "group_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "62ab9291-fae2-468e-974b-7e45096d5021" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/enterprises/dc/teams/justice-league" - ] - }, - "members_url": { - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "id", - "url", - "members_url", - "sync_to_organizations", - "name", - "html_url", - "slug", - "created_at", - "updated_at" - ] - } - ], - "type": [ - "null", - "object" - ] - }, - "pending_cancellation_date": { - "type": [ - "string", - "null" - ], - "format": "date", - "description": "The pending cancellation date for the seat, in `YYYY-MM-DD` format. This will be null unless the assignee's Copilot access has been canceled during the current billing cycle. If the seat has been cancelled, this corresponds to the start of the organization's next billing cycle." - }, - "last_activity_at": { - "type": [ - "string", - "null" - ], - "format": "date-time", - "description": "Timestamp of user's last GitHub Copilot activity, in ISO 8601 format." - }, - "last_activity_editor": { - "type": [ - "string", - "null" - ], - "description": "Last editor that was used by the user for a GitHub Copilot completion." - }, - "created_at": { - "type": "string", - "format": "date-time", - "description": "Timestamp of when the assignee was last granted access to GitHub Copilot, in ISO 8601 format." - }, - "updated_at": { - "type": "string", - "format": "date-time", - "deprecated": true, - "description": "**Closing down notice:** This field is no longer relevant and is closing down. Use the `created_at` field to determine when the assignee was last granted access to GitHub Copilot. Timestamp of when the assignee's GitHub Copilot access was last updated, in ISO 8601 format." - }, - "plan_type": { - "type": "string", - "description": "The Copilot plan of the organization, or the parent enterprise, when applicable.", - "enum": [ - "business", - "enterprise", - "unknown" - ] - } - }, - "required": [ - "assignee", - "created_at" - ], - "additionalProperties": false - } - } - } - }, - "examples": { - "default": { - "value": { - "total_seats": 2, - "seats": [ - { - "created_at": "2021-08-03T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": null, - "last_activity_at": "2021-10-14T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "plan_type": "business", - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "assigning_team": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "notification_setting": "notifications_enabled", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null - } - }, - { - "created_at": "2021-09-23T18:00:00-06:00", - "updated_at": "2021-09-23T15:00:00-06:00", - "pending_cancellation_date": "2021-11-01", - "last_activity_at": "2021-10-13T00:53:32-06:00", - "last_activity_editor": "vscode/1.77.3/copilot/1.86.82", - "assignee": { - "login": "octokitten", - "id": 1, - "node_id": "MDQ76VNlcjE=", - "avatar_url": "https://github.com/images/error/octokitten_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octokitten", - "html_url": "https://github.com/octokitten", - "followers_url": "https://api.github.com/users/octokitten/followers", - "following_url": "https://api.github.com/users/octokitten/following{/other_user}", - "gists_url": "https://api.github.com/users/octokitten/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octokitten/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octokitten/subscriptions", - "organizations_url": "https://api.github.com/users/octokitten/orgs", - "repos_url": "https://api.github.com/users/octokitten/repos", - "events_url": "https://api.github.com/users/octokitten/events{/privacy}", - "received_events_url": "https://api.github.com/users/octokitten/received_events", - "type": "User", - "site_admin": false - } - } - ] - } - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "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.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly enterprise owners and billing managers can view Copilot metrics for the enterprise.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/copilot-metrics-for-enterprise", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "until", - "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 28 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Copilot Usage Metrics", - "description": "Copilot usage metrics for a given day.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "total_engaged_users": { - "type": "integer", - "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "copilot_ide_code_completions": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot_ide_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot_dotcom_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in github.com", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." - }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model (if applicable)." - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot_dotcom_pull_requests": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot for pull requests.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." - }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } - } - } - } - } - } - } - }, - "required": [ - "date" - ], - "additionalProperties": true - } - }, - "examples": { - "default": { - "value": [ - { - "date": "2024-06-24", - "total_active_users": 24, - "total_engaged_users": 20, - "copilot_ide_code_completions": { - "total_engaged_users": 20, - "languages": [ - { - "name": "python", - "total_engaged_users": 10 - }, - { - "name": "ruby", - "total_engaged_users": 10 - } - ], - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 13, - "languages": [ - { - "name": "python", - "total_engaged_users": 6, - "total_code_suggestions": 249, - "total_code_acceptances": 123, - "total_code_lines_suggested": 225, - "total_code_lines_accepted": 135 - }, - { - "name": "ruby", - "total_engaged_users": 7, - "total_code_suggestions": 496, - "total_code_acceptances": 253, - "total_code_lines_suggested": 520, - "total_code_lines_accepted": 270 - } - ] - } - ] - }, - { - "name": "neovim", - "total_engaged_users": 7, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "languages": [ - { - "name": "typescript", - "total_engaged_users": 3, - "total_code_suggestions": 112, - "total_code_acceptances": 56, - "total_code_lines_suggested": 143, - "total_code_lines_accepted": 61 - }, - { - "name": "go", - "total_engaged_users": 4, - "total_code_suggestions": 132, - "total_code_acceptances": 67, - "total_code_lines_suggested": 154, - "total_code_lines_accepted": 72 - } - ] - } - ] - } - ] - }, - "copilot_ide_chat": { - "total_engaged_users": 13, - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 12, - "total_chats": 45, - "total_chat_insertion_events": 12, - "total_chat_copy_events": 16 - }, - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_engaged_users": 1, - "total_chats": 10, - "total_chat_insertion_events": 11, - "total_chat_copy_events": 3 - } - ] - } - ] - }, - "copilot_dotcom_chat": { - "total_engaged_users": 14, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 14, - "total_chats": 38 - } - ] - }, - "copilot_dotcom_pull_requests": { - "total_engaged_users": 12, - "repositories": [ - { - "name": "demo/repo1", - "total_engaged_users": 8, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_pr_summaries_created": 6, - "total_engaged_users": 8 - } - ] - }, - { - "name": "demo/repo2", - "total_engaged_users": 4, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_pr_summaries_created": 10, - "total_engaged_users": 4 - } - ] - } - ] - } - } - ] - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-metrics" - } - } - }, - "/enterprises/{enterprise}/copilot/usage": { - "get": { - "summary": "Get a summary of Copilot usage for enterprise members", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor all users across organizations with access to Copilot within your enterprise, with a further breakdown of suggestions, acceptances,\nand number of active users by editor and language for each day. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage 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\nThe time zone in the response is in UTC time, that means that the cutoff time for the \"day\" is UTC time.\n\nOnly owners and billing managers can view Copilot usage 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/usage-metrics-for-enterprise", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-enterprise-members" - }, - "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": "Summary of Copilot usage.", - "type": "object", - "properties": { - "day": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." - }, - "total_suggestions_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions shown to users." - }, - "total_acceptances_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions accepted by users." - }, - "total_lines_suggested": { - "type": "integer", - "description": "The total number of lines of code completions suggested by Copilot." - }, - "total_lines_accepted": { - "type": "integer", - "description": "The total number of lines of code completions accepted by users." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." - }, - "total_chat_acceptances": { - "type": "integer", - "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." - }, - "total_chat_turns": { - "type": "integer", - "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." - }, - "total_active_chat_users": { - "type": "integer", - "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." - }, - "breakdown": { - "type": [ - "array", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "items": { - "type": "object", - "description": "Breakdown of Copilot usage by editor for this language", - "additionalProperties": true, - "properties": { - "language": { - "type": "string", - "description": "The language in which Copilot suggestions were shown to users in the specified editor." - }, - "editor": { - "type": "string", - "description": "The editor in which Copilot suggestions were shown to users for the specified language." - }, - "suggestions_count": { - "type": "integer", - "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." - }, - "acceptances_count": { - "type": "integer", - "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." - }, - "lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." - }, - "lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted by users in the editor specified during the day specified." - }, - "active_users": { - "type": "integer", - "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." - } - } - } - } - }, - "required": [ - "day", - "breakdown" - ], - "additionalProperties": false - } - }, - "examples": { - "default": { - "value": [ - { - "day": "2023-10-15", - "total_suggestions_count": 5000, - "total_acceptances_count": 3000, - "total_lines_suggested": 7000, - "total_lines_accepted": 3500, - "total_active_users": 15, - "total_chat_acceptances": 45, - "total_chat_turns": 350, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 3000, - "acceptances_count": 2000, - "lines_suggested": 3000, - "lines_accepted": 1500, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 1000, - "acceptances_count": 500, - "lines_suggested": 2000, - "lines_accepted": 1000, - "active_users": 5 - }, - { - "language": "javascript", - "editor": "vscode", - "suggestions_count": 1000, - "acceptances_count": 500, - "lines_suggested": 2000, - "lines_accepted": 1000, - "active_users": 5 - } - ] - }, - { - "day": "2023-10-16", - "total_suggestions_count": 5200, - "total_acceptances_count": 5100, - "total_lines_suggested": 5300, - "total_lines_accepted": 5000, - "total_active_users": 15, - "total_chat_acceptances": 57, - "total_chat_turns": 455, - "total_active_chat_users": 12, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 3100, - "acceptances_count": 3000, - "lines_suggested": 3200, - "lines_accepted": 3100, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 1100, - "acceptances_count": 1000, - "lines_suggested": 1200, - "lines_accepted": 1100, - "active_users": 5 - }, - { - "language": "javascript", - "editor": "vscode", - "suggestions_count": 1000, - "acceptances_count": 900, - "lines_suggested": 1100, - "lines_accepted": 1000, - "active_users": 5 - } - ] - } - ] - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage" - } - } - }, "/enterprises/{enterprise}/dependabot/alerts": { "get": { "summary": "List Dependabot alerts for an enterprise", @@ -22948,6 +21058,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -23140,6 +21257,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -23231,6 +21349,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -23308,1040 +21427,6 @@ } } }, - "/enterprises/{enterprise}/team/{team_slug}/copilot/metrics": { - "get": { - "summary": "Get Copilot metrics for an enterprise team", - "description": "> [!NOTE]\n> This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nUse this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day,\nand the response will only include data up until yesterday. In order for an end user to be counted towards these metrics,\nthey must have telemetry enabled in their IDE.\n\n> [!NOTE]\n> This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day.\n\nTo access this endpoint, the Copilot Metrics API access policy must be enabled or set to \"no policy\" for the enterprise within GitHub settings.\nOnly owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team.\n\nOAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint.", - "tags": [ - "copilot" - ], - "operationId": "copilot/copilot-metrics-for-enterprise-team", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team" - }, - "parameters": [ - { - "name": "enterprise", - "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "The slug of the enterprise team name.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "since", - "description": "Show usage metrics since this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). Maximum value is 28 days ago.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "until", - "description": "Show usage metrics until this date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) and should not preceed the `since` date if it is passed.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "page", - "description": "The page number of the results to fetch. For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - }, - { - "name": "per_page", - "description": "The number of days of metrics to display per page (max 28). For more information, see \"[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 28 - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Copilot Usage Metrics", - "description": "Copilot usage metrics for a given day.", - "type": "object", - "properties": { - "date": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are aggregated, in `YYYY-MM-DD` format." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of Copilot users with activity belonging to any Copilot feature, globally, for the given day. Includes passive activity such as receiving a code suggestion, as well as engagement activity such as accepting a code suggestion or prompting chat. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "total_engaged_users": { - "type": "integer", - "description": "The total number of Copilot users who engaged with any Copilot feature, for the given day. Examples include but are not limited to accepting a code suggestion, prompting Copilot chat, or triggering a PR Summary. Does not include authentication events. Is not limited to the individual features detailed on the endpoint." - }, - "copilot_ide_code_completions": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot editor code completions in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code suggestion, across all active editors. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given language. Includes both full and partial acceptances." - } - } - } - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot code completion metrics for active editors.", - "additionalProperties": true, - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor. Includes both full and partial acceptances." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language and model. Includes both full and partial acceptances." - }, - "languages": { - "type": "array", - "description": "Code completion metrics for active languages, for the given editor.", - "items": { - "type": "object", - "description": "Usage metrics for a given language for the given editor for Copilot code completions.", - "properties": { - "name": { - "type": "string", - "description": "Name of the language used for Copilot code completion suggestions, for the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "Number of users who accepted at least one Copilot code completion suggestion for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_suggestions": { - "type": "integer", - "description": "The number of Copilot code suggestions generated for the given editor, for the given language." - }, - "total_code_acceptances": { - "type": "integer", - "description": "The number of Copilot code suggestions accepted for the given editor, for the given language. Includes both full and partial acceptances." - }, - "total_code_lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot code completions for the given editor, for the given language." - }, - "total_code_lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted from Copilot code suggestions for the given editor, for the given language." - } - } - } - } - } - } - } - } - } - } - } - }, - "copilot_ide_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in the IDE.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat in the IDE." - }, - "editors": { - "type": "array", - "items": { - "type": "object", - "description": "Copilot Chat metrics, for active editors.", - "properties": { - "name": { - "type": "string", - "description": "Name of the given editor." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the specified editor." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who prompted Copilot Chat in the given editor and model." - }, - "total_chats": { - "type": "integer", - "description": "The total number of chats initiated by users in the given editor and model." - }, - "total_chat_insertion_events": { - "type": "integer", - "description": "The number of times users accepted a code suggestion from Copilot Chat using the 'Insert Code' UI element, for the given editor." - }, - "total_chat_copy_events": { - "type": "integer", - "description": "The number of times users copied a code suggestion from Copilot Chat using the keyboard, or the 'Copy' UI element, for the given editor." - } - } - } - } - } - } - } - } - }, - "copilot_dotcom_chat": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot Chat in github.com", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once." - }, - "models": { - "type": "array", - "description": "List of model metrics for a custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model (if applicable)." - }, - "total_engaged_users": { - "type": "integer", - "description": "Total number of users who prompted Copilot Chat on github.com at least once for each model." - }, - "total_chats": { - "type": "integer", - "description": "Total number of chats initiated by users on github.com." - } - } - } - } - } - }, - "copilot_dotcom_pull_requests": { - "type": [ - "object", - "null" - ], - "description": "Usage metrics for Copilot for pull requests.", - "additionalProperties": true, - "properties": { - "total_engaged_users": { - "type": "integer", - "description": "The number of users who used Copilot for Pull Requests on github.com to generate a pull request summary at least once." - }, - "repositories": { - "type": "array", - "description": "Repositories in which users used Copilot for Pull Requests to generate pull request summaries", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Repository name" - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository." - }, - "models": { - "type": "array", - "description": "List of model metrics for custom models and the default model.", - "items": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Name of the model used for Copilot code completion suggestions. If the default model is used will appear as 'default'." - }, - "is_custom_model": { - "type": "boolean", - "description": "Indicates whether a model is custom or default." - }, - "custom_model_training_date": { - "type": [ - "string", - "null" - ], - "description": "The training date for the custom model." - }, - "total_pr_summaries_created": { - "type": "integer", - "description": "The number of pull request summaries generated using Copilot for Pull Requests in the given repository." - }, - "total_engaged_users": { - "type": "integer", - "description": "The number of users who generated pull request summaries using Copilot for Pull Requests in the given repository and model." - } - } - } - } - } - } - } - } - } - }, - "required": [ - "date" - ], - "additionalProperties": true - } - }, - "examples": { - "default": { - "value": [ - { - "date": "2024-06-24", - "total_active_users": 24, - "total_engaged_users": 20, - "copilot_ide_code_completions": { - "total_engaged_users": 20, - "languages": [ - { - "name": "python", - "total_engaged_users": 10 - }, - { - "name": "ruby", - "total_engaged_users": 10 - } - ], - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 13, - "languages": [ - { - "name": "python", - "total_engaged_users": 6, - "total_code_suggestions": 249, - "total_code_acceptances": 123, - "total_code_lines_suggested": 225, - "total_code_lines_accepted": 135 - }, - { - "name": "ruby", - "total_engaged_users": 7, - "total_code_suggestions": 496, - "total_code_acceptances": 253, - "total_code_lines_suggested": 520, - "total_code_lines_accepted": 270 - } - ] - } - ] - }, - { - "name": "neovim", - "total_engaged_users": 7, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "languages": [ - { - "name": "typescript", - "total_engaged_users": 3, - "total_code_suggestions": 112, - "total_code_acceptances": 56, - "total_code_lines_suggested": 143, - "total_code_lines_accepted": 61 - }, - { - "name": "go", - "total_engaged_users": 4, - "total_code_suggestions": 132, - "total_code_acceptances": 67, - "total_code_lines_suggested": 154, - "total_code_lines_accepted": 72 - } - ] - } - ] - } - ] - }, - "copilot_ide_chat": { - "total_engaged_users": 13, - "editors": [ - { - "name": "vscode", - "total_engaged_users": 13, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 12, - "total_chats": 45, - "total_chat_insertion_events": 12, - "total_chat_copy_events": 16 - }, - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_engaged_users": 1, - "total_chats": 10, - "total_chat_insertion_events": 11, - "total_chat_copy_events": 3 - } - ] - } - ] - }, - "copilot_dotcom_chat": { - "total_engaged_users": 14, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_engaged_users": 14, - "total_chats": 38 - } - ] - }, - "copilot_dotcom_pull_requests": { - "total_engaged_users": 12, - "repositories": [ - { - "name": "demo/repo1", - "total_engaged_users": 8, - "models": [ - { - "name": "default", - "is_custom_model": false, - "custom_model_training_date": null, - "total_pr_summaries_created": 6, - "total_engaged_users": 8 - } - ] - }, - { - "name": "demo/repo2", - "total_engaged_users": 4, - "models": [ - { - "name": "a-custom-model", - "is_custom_model": true, - "custom_model_training_date": "2024-02-01", - "total_pr_summaries_created": 10, - "total_engaged_users": 4 - } - ] - } - ] - } - } - ] - } - } - } - } - }, - "500": { - "description": "Internal Error", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Copilot Usage Merics API setting is disabled at the organization or enterprise level.", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-metrics" - } - } - }, - "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": { - "get": { - "summary": "Get a summary of Copilot usage for an enterprise team", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See \"[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business).\"\n\nYou can use this endpoint to see a daily breakdown of aggregated usage metrics for Copilot completions and Copilot Chat in the IDE\nfor users within an enterprise team, with a further breakdown of suggestions, acceptances, and number of active users by editor and language for each day.\nSee the response schema tab for detailed metrics definitions.\n\nThe response contains metrics for up to 28 days prior. Usage 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, as evaluated at the end of that day.\n\nOwners and billing managers for the enterprise that contains the enterprise team can view Copilot usage 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/usage-metrics-for-enterprise-team", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-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 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": "Summary of Copilot usage.", - "type": "object", - "properties": { - "day": { - "type": "string", - "format": "date", - "description": "The date for which the usage metrics are reported, in `YYYY-MM-DD` format." - }, - "total_suggestions_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions shown to users." - }, - "total_acceptances_count": { - "type": "integer", - "description": "The total number of Copilot code completion suggestions accepted by users." - }, - "total_lines_suggested": { - "type": "integer", - "description": "The total number of lines of code completions suggested by Copilot." - }, - "total_lines_accepted": { - "type": "integer", - "description": "The total number of lines of code completions accepted by users." - }, - "total_active_users": { - "type": "integer", - "description": "The total number of users who were shown Copilot code completion suggestions during the day specified." - }, - "total_chat_acceptances": { - "type": "integer", - "description": "The total instances of users who accepted code suggested by Copilot Chat in the IDE (panel and inline)." - }, - "total_chat_turns": { - "type": "integer", - "description": "The total number of chat turns (prompt and response pairs) sent between users and Copilot Chat in the IDE." - }, - "total_active_chat_users": { - "type": "integer", - "description": "The total number of users who interacted with Copilot Chat in the IDE during the day specified." - }, - "breakdown": { - "type": [ - "array", - "null" - ], - "description": "Breakdown of Copilot code completions usage by language and editor", - "items": { - "type": "object", - "description": "Breakdown of Copilot usage by editor for this language", - "additionalProperties": true, - "properties": { - "language": { - "type": "string", - "description": "The language in which Copilot suggestions were shown to users in the specified editor." - }, - "editor": { - "type": "string", - "description": "The editor in which Copilot suggestions were shown to users for the specified language." - }, - "suggestions_count": { - "type": "integer", - "description": "The number of Copilot suggestions shown to users in the editor specified during the day specified." - }, - "acceptances_count": { - "type": "integer", - "description": "The number of Copilot suggestions accepted by users in the editor specified during the day specified." - }, - "lines_suggested": { - "type": "integer", - "description": "The number of lines of code suggested by Copilot in the editor specified during the day specified." - }, - "lines_accepted": { - "type": "integer", - "description": "The number of lines of code accepted by users in the editor specified during the day specified." - }, - "active_users": { - "type": "integer", - "description": "The number of users who were shown Copilot completion suggestions in the editor specified during the day specified." - } - } - } - } - }, - "required": [ - "day", - "breakdown" - ], - "additionalProperties": false - } - }, - "examples": { - "default": { - "value": [ - { - "day": "2023-10-15", - "total_suggestions_count": 1000, - "total_acceptances_count": 800, - "total_lines_suggested": 1800, - "total_lines_accepted": 1200, - "total_active_users": 10, - "total_chat_acceptances": 32, - "total_chat_turns": 200, - "total_active_chat_users": 4, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 250, - "lines_suggested": 900, - "lines_accepted": 700, - "active_users": 5 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 400, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 400, - "acceptances_count": 350, - "lines_suggested": 500, - "lines_accepted": 200, - "active_users": 3 - } - ] - }, - { - "day": "2023-10-16", - "total_suggestions_count": 800, - "total_acceptances_count": 600, - "total_lines_suggested": 1100, - "total_lines_accepted": 700, - "total_active_users": 12, - "total_chat_acceptances": 57, - "total_chat_turns": 426, - "total_active_chat_users": 8, - "breakdown": [ - { - "language": "python", - "editor": "vscode", - "suggestions_count": 300, - "acceptances_count": 200, - "lines_suggested": 600, - "lines_accepted": 300, - "active_users": 2 - }, - { - "language": "python", - "editor": "jetbrains", - "suggestions_count": 300, - "acceptances_count": 150, - "lines_suggested": 300, - "lines_accepted": 250, - "active_users": 6 - }, - { - "language": "ruby", - "editor": "vscode", - "suggestions_count": 200, - "acceptances_count": 150, - "lines_suggested": 200, - "lines_accepted": 150, - "active_users": 3 - } - ] - } - ] - } - } - } - } - }, - "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" - } - } - } - } - } - }, - "401": { - "description": "Requires authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage" - } - } - }, "/events": { "get": { "summary": "List public events", @@ -69581,6 +66666,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -128134,6 +125222,8 @@ "content": { "application/json": { "schema": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", "type": "object", "properties": { "value_type": { @@ -135439,7 +132529,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -135447,7 +132538,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -135573,7 +132665,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -136044,6 +133136,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -136788,7 +133887,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ], "default": "branch" }, @@ -136845,7 +133945,7 @@ "conditions": { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -137311,6 +134411,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -137984,7 +135091,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -137992,7 +135100,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -138118,7 +135227,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -138589,6 +135698,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -139920,7 +137036,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -139928,7 +137045,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -140054,7 +137172,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -140525,6 +137643,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -141295,7 +138420,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "enforcement": { @@ -141351,7 +138477,7 @@ "conditions": { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -141817,6 +138943,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -142486,7 +139619,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -142494,7 +139628,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -142620,7 +139755,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -143091,6 +140226,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -145233,6 +142375,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -145425,6 +142574,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -145516,6 +142666,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -170088,7 +167239,31 @@ "used" ] }, - "code_scanning_upload": { + "code_scanning_upload": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] + }, + "actions_runner_registration": { "title": "Rate Limit", "type": "object", "properties": { @@ -170112,7 +167287,7 @@ "used" ] }, - "actions_runner_registration": { + "scim": { "title": "Rate Limit", "type": "object", "properties": { @@ -170136,7 +167311,7 @@ "used" ] }, - "scim": { + "dependency_snapshots": { "title": "Rate Limit", "type": "object", "properties": { @@ -170160,7 +167335,7 @@ "used" ] }, - "dependency_snapshots": { + "code_scanning_autofix": { "title": "Rate Limit", "type": "object", "properties": { @@ -170283,6 +167458,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -205781,6 +202962,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -462023,6 +459207,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -462895,7 +460086,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -462903,7 +460095,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -463029,7 +460222,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -463500,6 +460693,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -464558,6 +461758,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -465221,7 +462428,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -465229,7 +462437,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -465355,7 +462564,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -465826,6 +463035,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -467176,7 +464392,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -467184,7 +464401,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -467310,7 +464528,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -467781,6 +464999,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -468854,6 +466079,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -469513,7 +466745,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -469521,7 +466754,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -469647,7 +466881,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -470118,6 +467352,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -471724,6 +468965,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -471842,6 +469090,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -471866,6 +469115,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -472410,188 +469660,195 @@ } ] }, - "push_protection_bypassed_at": { + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "title": "Simple User", + "description": "A GitHub user.", + "type": "object", + "properties": { + "name": { + "type": [ + "string", + "null" + ] + }, + "email": { + "type": [ + "string", + "null" + ] + }, + "login": { + "type": "string", + "examples": [ + "octocat" + ] + }, + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDQ6VXNlcjE=" + ] + }, + "avatar_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/images/error/octocat_happy.gif" + ] + }, + "gravatar_id": { + "type": [ + "string", + "null" + ], + "examples": [ + "41d064eb2195891e12d0413f63227ea7" + ] + }, + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat" + ] + }, + "followers_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/followers" + ] + }, + "following_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/following{/other_user}" + ] + }, + "gists_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/gists{/gist_id}" + ] + }, + "starred_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/starred{/owner}{/repo}" + ] + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/subscriptions" + ] + }, + "organizations_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/orgs" + ] + }, + "repos_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/repos" + ] + }, + "events_url": { + "type": "string", + "examples": [ + "https://api.github.com/users/octocat/events{/privacy}" + ] + }, + "received_events_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/users/octocat/received_events" + ] + }, + "type": { + "type": "string", + "examples": [ + "User" + ] + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "examples": [ + "\"2020-07-09T00:17:55Z\"" + ] + }, + "user_view_type": { + "type": "string", + "examples": [ + "public" + ] + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ] + } + ] + }, + "push_protection_bypass_request_reviewer_comment": { "type": [ "string", "null" ], - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "push_protection_bypass_request_reviewer": { - "anyOf": [ - { - "type": "null" - }, - { - "title": "Simple User", - "description": "A GitHub user.", - "type": "object", - "properties": { - "name": { - "type": [ - "string", - "null" - ] - }, - "email": { - "type": [ - "string", - "null" - ] - }, - "login": { - "type": "string", - "examples": [ - "octocat" - ] - }, - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDQ6VXNlcjE=" - ] - }, - "avatar_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/images/error/octocat_happy.gif" - ] - }, - "gravatar_id": { - "type": [ - "string", - "null" - ], - "examples": [ - "41d064eb2195891e12d0413f63227ea7" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat" - ] - }, - "followers_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/followers" - ] - }, - "following_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/following{/other_user}" - ] - }, - "gists_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/gists{/gist_id}" - ] - }, - "starred_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/starred{/owner}{/repo}" - ] - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/subscriptions" - ] - }, - "organizations_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/orgs" - ] - }, - "repos_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/repos" - ] - }, - "events_url": { - "type": "string", - "examples": [ - "https://api.github.com/users/octocat/events{/privacy}" - ] - }, - "received_events_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/users/octocat/received_events" - ] - }, - "type": { - "type": "string", - "examples": [ - "User" - ] - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "examples": [ - "\"2020-07-09T00:17:55Z\"" - ] - }, - "user_view_type": { - "type": "string", - "examples": [ - "public" - ] - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ] - } - ] + "description": "An optional comment when reviewing a push protection bypass." }, "push_protection_bypass_request_comment": { "type": [ @@ -472652,6 +469909,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -473431,6 +470689,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -473509,6 +470774,7 @@ "push_protection_bypassed_by": null, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": "Example comment", @@ -589419,6 +586685,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -1208464,7 +1205733,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1208472,7 +1205742,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1208598,7 +1205869,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -1209069,6 +1206340,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1211670,7 +1208948,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1211678,7 +1208957,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1211804,7 +1209084,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -1212275,6 +1209555,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1214876,7 +1212163,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1214884,7 +1212172,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1215010,7 +1212299,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -1215481,6 +1212770,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1216465,6 +1213761,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1217277,6 +1214580,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1218092,6 +1215402,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1232386,6 +1229703,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1235027,6 +1232351,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1238102,6 +1235433,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1240743,6 +1238081,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1243384,6 +1240729,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1246025,6 +1243377,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 2cff46e55..3e24f41de 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -428,7 +428,7 @@ paths: The EPSS percentile represents the relative rank of the CVE's likelihood of being exploited compared to other CVEs. schema: type: string - - &41 + - &38 name: before description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results before this cursor. For @@ -437,7 +437,7 @@ paths: required: false schema: type: string - - &42 + - &39 name: after description: A cursor, as given in the [Link header](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api#using-link-headers). If specified, the query only searches for results after this cursor. For @@ -446,7 +446,7 @@ paths: required: false schema: type: string - - &40 + - &37 name: direction description: The direction to sort the results by. in: query @@ -685,7 +685,7 @@ paths: required: - vector_string - score - cvss_severities: &44 + cvss_severities: &41 type: - object - 'null' @@ -888,7 +888,7 @@ paths: - subscriptions_url - type - url - type: &226 + type: &220 type: string description: The type of credit the user is receiving. enum: @@ -1021,7 +1021,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &93 + schema: &87 title: Validation Error Simple description: Validation Error Simple type: object @@ -1054,7 +1054,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &529 + - &528 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1585,7 +1585,7 @@ paths: schema: type: integer default: 30 - - &151 + - &144 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 @@ -1601,7 +1601,7 @@ paths: application/json: schema: type: array - items: &152 + items: &145 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1694,7 +1694,7 @@ paths: - installation_id - repository_id examples: - default: &153 + default: &146 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1757,7 +1757,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &92 + schema: &86 title: Validation Error description: Validation Error type: object @@ -1829,7 +1829,7 @@ paths: description: Response content: application/json: - schema: &154 + schema: &147 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1964,7 +1964,7 @@ paths: - request - response examples: - default: &155 + default: &148 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2024,7 +2024,7 @@ paths: parameters: - *16 responses: - '202': &94 + '202': &88 description: Accepted content: application/json: @@ -2233,7 +2233,7 @@ paths: parameters: - *17 - *18 - - &62 + - &57 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) @@ -2778,7 +2778,7 @@ paths: suspended_at: suspended_by: headers: - Link: &37 + Link: &50 example: ; rel="next", ; rel="last" schema: @@ -2968,7 +2968,7 @@ paths: - selected repositories: type: array - items: &57 + items: &52 title: Repository description: A repository on GitHub. type: object @@ -2995,7 +2995,7 @@ paths: license: anyOf: - type: 'null' - - &73 + - &68 title: License Simple description: License Simple type: object @@ -7219,1189 +7219,6 @@ paths: enabledForGitHubApps: true category: emojis subcategory: emojis - "/enterprises/{enterprise}/copilot/billing/seats": - get: - summary: List all Copilot seat assignments for an enterprise - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. - - Lists all Copilot seats currently being billed for across organizations or enterprise teams for an enterprise with a Copilot Business or Copilot Enterprise subscription. - - Users with access through multiple organizations or enterprise teams will only be counted toward `total_seats` once. - - For each organization or enterprise team which grants Copilot access to a user, a seat detail object will appear in the `seats` array. - Each seat object contains information about the assigned user's most recent Copilot activity. Users must have - telemetry enabled in their IDE for Copilot in the IDE activity to be reflected in `last_activity_at`. For more information about activity data, - see "[Reviewing user activity data for Copilot in your organization](https://docs.github.com/copilot/managing-copilot/managing-github-copilot-in-your-organization/reviewing-activity-related-to-github-copilot-in-your-organization/reviewing-user-activity-data-for-copilot-in-your-organization)." - - Only enterprise owners and billing managers can view assigned Copilot seats across their child organizations or enterprise teams. - - Personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/list-copilot-seats-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-user-management#list-all-copilot-seat-assignments-for-an-enterprise - parameters: - - &38 - 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 - - *18 - - name: per_page - description: The number of results per page (max 100). For more information, - see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 50 - responses: - '200': - description: Response - content: - application/json: - schema: - type: object - properties: - total_seats: - type: integer - description: The total number of Copilot seats the enterprise - is being billed for. Users with access through multiple organizations - or enterprise teams are only counted once. - seats: - type: array - items: &134 - title: Copilot Business Seat Detail - description: Information about a Copilot Business seat assignment - for a user, team, or organization. - type: object - properties: - assignee: *4 - organization: - anyOf: - - type: 'null' - - &88 - title: Organization Simple - description: A GitHub organization. - type: object - properties: - login: - type: string - examples: - - github - id: - type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDEyOk9yZ2FuaXphdGlvbjE= - url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github - repos_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/repos - events_url: - type: string - format: uri - examples: - - https://api.github.com/orgs/github/events - hooks_url: - type: string - examples: - - https://api.github.com/orgs/github/hooks - issues_url: - type: string - examples: - - https://api.github.com/orgs/github/issues - members_url: - type: string - examples: - - https://api.github.com/orgs/github/members{/member} - public_members_url: - type: string - examples: - - https://api.github.com/orgs/github/public_members{/member} - avatar_url: - type: string - examples: - - https://github.com/images/error/octocat_happy.gif - description: - type: - - string - - 'null' - examples: - - A great organization - required: - - login - - url - - id - - node_id - - repos_url - - events_url - - hooks_url - - issues_url - - members_url - - public_members_url - - avatar_url - - description - assigning_team: - description: The team through which the assignee is granted - access to GitHub Copilot, if applicable. - oneOf: - - &173 - title: Team - description: Groups of organization members that gives - permissions on specified repositories. - type: object - properties: - id: - type: integer - node_id: - type: string - name: - type: string - slug: - type: string - description: - type: - - string - - 'null' - privacy: - type: string - notification_setting: - type: string - permission: - type: string - permissions: - type: object - properties: - pull: - type: boolean - triage: - type: boolean - push: - type: boolean - maintain: - type: boolean - admin: - type: boolean - required: - - pull - - triage - - push - - maintain - - admin - url: - type: string - format: uri - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/rails/teams/core - members_url: - type: string - repositories_url: - type: string - format: uri - parent: - anyOf: - - type: 'null' - - &187 - title: Team Simple - description: Groups of organization members that - gives permissions on specified repositories. - type: object - properties: - id: - description: Unique identifier of the team - type: integer - examples: - - 1 - node_id: - type: string - examples: - - MDQ6VGVhbTE= - url: - description: URL for the team - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/1 - members_url: - type: string - examples: - - https://api.github.com/organizations/1/team/1/members{/member} - name: - description: Name of the team - type: string - examples: - - Justice League - description: - description: Description of the team - type: - - string - - 'null' - examples: - - A great team. - permission: - description: Permission that the team will have - for its repositories - type: string - examples: - - admin - privacy: - description: The level of privacy this team - should have - type: string - examples: - - closed - notification_setting: - description: The notification setting the team - has set - type: string - examples: - - notifications_enabled - html_url: - type: string - format: uri - examples: - - https://github.com/orgs/rails/teams/core - repositories_url: - type: string - format: uri - examples: - - https://api.github.com/organizations/1/team/1/repos - slug: - type: string - examples: - - justice-league - ldap_dn: - description: Distinguished Name (DN) that team - maps to within LDAP environment - type: string - examples: - - uid=example,ou=users,dc=github,dc=com - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - required: - - id - - node_id - - url - - members_url - - name - - description - - permission - - html_url - - repositories_url - - slug - - parent - - title: Enterprise Team - description: Group of enterprise owners and/or members - type: object - properties: - id: - type: integer - format: int64 - name: - type: string - slug: - type: string - url: - type: string - format: uri - sync_to_organizations: - type: string - examples: - - disabled | all - group_id: - type: - - string - - 'null' - examples: - - 62ab9291-fae2-468e-974b-7e45096d5021 - html_url: - type: string - format: uri - examples: - - https://github.com/enterprises/dc/teams/justice-league - members_url: - type: string - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time - required: - - id - - url - - members_url - - sync_to_organizations - - name - - html_url - - slug - - created_at - - updated_at - type: - - 'null' - - object - pending_cancellation_date: - type: - - string - - 'null' - format: date - description: The pending cancellation date for the seat, - in `YYYY-MM-DD` format. This will be null unless the assignee's - Copilot access has been canceled during the current billing - cycle. If the seat has been cancelled, this corresponds - to the start of the organization's next billing cycle. - last_activity_at: - type: - - string - - 'null' - format: date-time - description: Timestamp of user's last GitHub Copilot activity, - in ISO 8601 format. - last_activity_editor: - type: - - string - - 'null' - description: Last editor that was used by the user for a - GitHub Copilot completion. - created_at: - type: string - format: date-time - description: Timestamp of when the assignee was last granted - access to GitHub Copilot, in ISO 8601 format. - updated_at: - type: string - format: date-time - deprecated: true - description: "**Closing down notice:** This field is no - longer relevant and is closing down. Use the `created_at` - field to determine when the assignee was last granted - access to GitHub Copilot. Timestamp of when the assignee's - GitHub Copilot access was last updated, in ISO 8601 format." - plan_type: - type: string - description: The Copilot plan of the organization, or the - parent enterprise, when applicable. - enum: - - business - - enterprise - - unknown - required: - - assignee - - created_at - additionalProperties: false - examples: - default: &135 - value: - total_seats: 2 - seats: - - created_at: '2021-08-03T18:00:00-06:00' - updated_at: '2021-09-23T15:00:00-06:00' - pending_cancellation_date: - last_activity_at: '2021-10-14T00:53:32-06:00' - last_activity_editor: vscode/1.77.3/copilot/1.86.82 - plan_type: business - assignee: - login: octocat - id: 1 - node_id: MDQ6VXNlcjE= - avatar_url: https://github.com/images/error/octocat_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octocat - html_url: https://github.com/octocat - followers_url: https://api.github.com/users/octocat/followers - following_url: https://api.github.com/users/octocat/following{/other_user} - gists_url: https://api.github.com/users/octocat/gists{/gist_id} - starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octocat/subscriptions - organizations_url: https://api.github.com/users/octocat/orgs - repos_url: https://api.github.com/users/octocat/repos - events_url: https://api.github.com/users/octocat/events{/privacy} - received_events_url: https://api.github.com/users/octocat/received_events - type: User - site_admin: false - assigning_team: - id: 1 - node_id: MDQ6VGVhbTE= - url: https://api.github.com/teams/1 - html_url: https://github.com/orgs/github/teams/justice-league - name: Justice League - slug: justice-league - description: A great team. - privacy: closed - notification_setting: notifications_enabled - permission: admin - members_url: https://api.github.com/teams/1/members{/member} - repositories_url: https://api.github.com/teams/1/repos - parent: - - created_at: '2021-09-23T18:00:00-06:00' - updated_at: '2021-09-23T15:00:00-06:00' - pending_cancellation_date: '2021-11-01' - last_activity_at: '2021-10-13T00:53:32-06:00' - last_activity_editor: vscode/1.77.3/copilot/1.86.82 - assignee: - login: octokitten - id: 1 - node_id: MDQ76VNlcjE= - avatar_url: https://github.com/images/error/octokitten_happy.gif - gravatar_id: '' - url: https://api.github.com/users/octokitten - html_url: https://github.com/octokitten - followers_url: https://api.github.com/users/octokitten/followers - following_url: https://api.github.com/users/octokitten/following{/other_user} - gists_url: https://api.github.com/users/octokitten/gists{/gist_id} - starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} - subscriptions_url: https://api.github.com/users/octokitten/subscriptions - organizations_url: https://api.github.com/users/octokitten/orgs - repos_url: https://api.github.com/users/octokitten/repos - events_url: https://api.github.com/users/octokitten/events{/privacy} - received_events_url: https://api.github.com/users/octokitten/received_events - type: User - site_admin: false - headers: - Link: *37 - '500': &39 - description: Internal Error - content: - application/json: - schema: *3 - '401': *23 - '403': *27 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-user-management - "/enterprises/{enterprise}/copilot/metrics": - get: - summary: Get Copilot metrics for an enterprise - description: |- - Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - - The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - they must have telemetry enabled in their IDE. - - To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - Only enterprise owners and billing managers can view Copilot metrics for the enterprise. - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/copilot-metrics-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise - parameters: - - *38 - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - *18 - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &52 - title: Copilot Usage Metrics - description: Copilot usage metrics for a given day. - type: object - properties: - date: - type: string - format: date - description: The date for which the usage metrics are aggregated, - in `YYYY-MM-DD` format. - total_active_users: - type: integer - description: The total number of Copilot users with activity - belonging to any Copilot feature, globally, for the given - day. Includes passive activity such as receiving a code suggestion, - as well as engagement activity such as accepting a code suggestion - or prompting chat. Does not include authentication events. - Is not limited to the individual features detailed on the - endpoint. - total_engaged_users: - type: integer - description: The total number of Copilot users who engaged with - any Copilot feature, for the given day. Examples include but - are not limited to accepting a code suggestion, prompting - Copilot chat, or triggering a PR Summary. Does not include - authentication events. Is not limited to the individual features - detailed on the endpoint. - copilot_ide_code_completions: - type: - - object - - 'null' - description: Usage metrics for Copilot editor code completions - in the IDE. - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Number of users who accepted at least one Copilot - code suggestion, across all active editors. Includes both - full and partial acceptances. - languages: - type: array - description: Code completion metrics for active languages. - items: - type: object - description: Usage metrics for a given language for the - given editor for Copilot code completions. - properties: - name: - type: string - description: Name of the language used for Copilot - code completion suggestions. - total_engaged_users: - type: integer - description: Number of users who accepted at least - one Copilot code completion suggestion for the given - language. Includes both full and partial acceptances. - editors: - type: array - items: - type: object - description: Copilot code completion metrics for active - editors. - additionalProperties: true - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted at least - one Copilot code completion suggestion for the given - editor. Includes both full and partial acceptances. - models: - type: array - description: List of model metrics for custom models - and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot - code completion suggestions. If the default - model is used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom - or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom - model. - total_engaged_users: - type: integer - description: Number of users who accepted at - least one Copilot code completion suggestion - for the given editor, for the given language - and model. Includes both full and partial - acceptances. - languages: - type: array - description: Code completion metrics for active - languages, for the given editor. - items: - type: object - description: Usage metrics for a given language - for the given editor for Copilot code completions. - properties: - name: - type: string - description: Name of the language used - for Copilot code completion suggestions, - for the given editor. - total_engaged_users: - type: integer - description: Number of users who accepted - at least one Copilot code completion - suggestion for the given editor, for - the given language. Includes both full - and partial acceptances. - total_code_suggestions: - type: integer - description: The number of Copilot code - suggestions generated for the given - editor, for the given language. - total_code_acceptances: - type: integer - description: The number of Copilot code - suggestions accepted for the given editor, - for the given language. Includes both - full and partial acceptances. - total_code_lines_suggested: - type: integer - description: The number of lines of code - suggested by Copilot code completions - for the given editor, for the given - language. - total_code_lines_accepted: - type: integer - description: The number of lines of code - accepted from Copilot code suggestions - for the given editor, for the given - language. - copilot_ide_chat: - type: - - object - - 'null' - description: Usage metrics for Copilot Chat in the IDE. - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot - Chat in the IDE. - editors: - type: array - items: - type: object - description: Copilot Chat metrics, for active editors. - properties: - name: - type: string - description: Name of the given editor. - total_engaged_users: - type: integer - description: The number of users who prompted Copilot - Chat in the specified editor. - models: - type: array - description: List of model metrics for custom models - and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot - code completion suggestions. If the default - model is used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom - or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom - model. - total_engaged_users: - type: integer - description: The number of users who prompted - Copilot Chat in the given editor and model. - total_chats: - type: integer - description: The total number of chats initiated - by users in the given editor and model. - total_chat_insertion_events: - type: integer - description: The number of times users accepted - a code suggestion from Copilot Chat using - the 'Insert Code' UI element, for the given - editor. - total_chat_copy_events: - type: integer - description: The number of times users copied - a code suggestion from Copilot Chat using - the keyboard, or the 'Copy' UI element, for - the given editor. - copilot_dotcom_chat: - type: - - object - - 'null' - description: Usage metrics for Copilot Chat in github.com - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot - Chat on github.com at least once. - models: - type: array - description: List of model metrics for a custom models and - the default model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot code - completion suggestions. If the default model is - used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom or - default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom model - (if applicable). - total_engaged_users: - type: integer - description: Total number of users who prompted Copilot - Chat on github.com at least once for each model. - total_chats: - type: integer - description: Total number of chats initiated by users - on github.com. - copilot_dotcom_pull_requests: - type: - - object - - 'null' - description: Usage metrics for Copilot for pull requests. - additionalProperties: true - properties: - total_engaged_users: - type: integer - description: The number of users who used Copilot for Pull - Requests on github.com to generate a pull request summary - at least once. - repositories: - type: array - description: Repositories in which users used Copilot for - Pull Requests to generate pull request summaries - items: - type: object - properties: - name: - type: string - description: Repository name - total_engaged_users: - type: integer - description: The number of users who generated pull - request summaries using Copilot for Pull Requests - in the given repository. - models: - type: array - description: List of model metrics for custom models - and the default model. - items: - type: object - properties: - name: - type: string - description: Name of the model used for Copilot - code completion suggestions. If the default - model is used will appear as 'default'. - is_custom_model: - type: boolean - description: Indicates whether a model is custom - or default. - custom_model_training_date: - type: - - string - - 'null' - description: The training date for the custom - model. - total_pr_summaries_created: - type: integer - description: The number of pull request summaries - generated using Copilot for Pull Requests - in the given repository. - total_engaged_users: - type: integer - description: The number of users who generated - pull request summaries using Copilot for Pull - Requests in the given repository and model. - required: - - date - additionalProperties: true - examples: - default: &53 - value: - - date: '2024-06-24' - total_active_users: 24 - total_engaged_users: 20 - copilot_ide_code_completions: - total_engaged_users: 20 - languages: - - name: python - total_engaged_users: 10 - - name: ruby - total_engaged_users: 10 - editors: - - name: vscode - total_engaged_users: 13 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 13 - languages: - - name: python - total_engaged_users: 6 - total_code_suggestions: 249 - total_code_acceptances: 123 - total_code_lines_suggested: 225 - total_code_lines_accepted: 135 - - name: ruby - total_engaged_users: 7 - total_code_suggestions: 496 - total_code_acceptances: 253 - total_code_lines_suggested: 520 - total_code_lines_accepted: 270 - - name: neovim - total_engaged_users: 7 - models: - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - languages: - - name: typescript - total_engaged_users: 3 - total_code_suggestions: 112 - total_code_acceptances: 56 - total_code_lines_suggested: 143 - total_code_lines_accepted: 61 - - name: go - total_engaged_users: 4 - total_code_suggestions: 132 - total_code_acceptances: 67 - total_code_lines_suggested: 154 - total_code_lines_accepted: 72 - copilot_ide_chat: - total_engaged_users: 13 - editors: - - name: vscode - total_engaged_users: 13 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 12 - total_chats: 45 - total_chat_insertion_events: 12 - total_chat_copy_events: 16 - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - total_engaged_users: 1 - total_chats: 10 - total_chat_insertion_events: 11 - total_chat_copy_events: 3 - copilot_dotcom_chat: - total_engaged_users: 14 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_engaged_users: 14 - total_chats: 38 - copilot_dotcom_pull_requests: - total_engaged_users: 12 - repositories: - - name: demo/repo1 - total_engaged_users: 8 - models: - - name: default - is_custom_model: false - custom_model_training_date: - total_pr_summaries_created: 6 - total_engaged_users: 8 - - name: demo/repo2 - total_engaged_users: 4 - models: - - name: a-custom-model - is_custom_model: true - custom_model_training_date: '2024-02-01' - total_pr_summaries_created: 10 - total_engaged_users: 4 - '500': *39 - '403': *27 - '404': *6 - '422': &54 - description: Copilot Usage Merics API setting is disabled at the organization - or enterprise level. - content: - application/json: - schema: *3 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-metrics - "/enterprises/{enterprise}/copilot/usage": - get: - summary: Get a summary of Copilot usage for enterprise members - 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 all users across organizations with access to Copilot within your enterprise, 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. - - The time zone in the response is in UTC time, that means that the cutoff time for the "day" is UTC time. - - Only owners and billing managers can view Copilot usage 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/usage-metrics-for-enterprise - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-enterprise-members - parameters: - - *38 - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - *18 - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: &55 - title: Copilot Usage Metrics - description: Summary of Copilot usage. - type: object - properties: - day: - type: string - format: date - description: The date for which the usage metrics are reported, - in `YYYY-MM-DD` format. - total_suggestions_count: - type: integer - description: The total number of Copilot code completion suggestions - shown to users. - total_acceptances_count: - type: integer - description: The total number of Copilot code completion suggestions - accepted by users. - total_lines_suggested: - type: integer - description: The total number of lines of code completions suggested - by Copilot. - total_lines_accepted: - type: integer - description: The total number of lines of code completions accepted - by users. - total_active_users: - type: integer - description: The total number of users who were shown Copilot - code completion suggestions during the day specified. - total_chat_acceptances: - type: integer - description: The total instances of users who accepted code - suggested by Copilot Chat in the IDE (panel and inline). - total_chat_turns: - type: integer - description: The total number of chat turns (prompt and response - pairs) sent between users and Copilot Chat in the IDE. - total_active_chat_users: - type: integer - description: The total number of users who interacted with Copilot - Chat in the IDE during the day specified. - breakdown: - type: - - array - - 'null' - description: Breakdown of Copilot code completions usage by - language and editor - items: - type: object - description: Breakdown of Copilot usage by editor for this - language - additionalProperties: true - properties: - language: - type: string - description: The language in which Copilot suggestions - were shown to users in the specified editor. - editor: - type: string - description: The editor in which Copilot suggestions were - shown to users for the specified language. - suggestions_count: - type: integer - description: The number of Copilot suggestions shown to - users in the editor specified during the day specified. - acceptances_count: - type: integer - description: The number of Copilot suggestions accepted - by users in the editor specified during the day specified. - lines_suggested: - type: integer - description: The number of lines of code suggested by - Copilot in the editor specified during the day specified. - lines_accepted: - type: integer - description: The number of lines of code accepted by users - in the editor specified during the day specified. - active_users: - type: integer - description: The number of users who were shown Copilot - completion suggestions in the editor specified during - the day specified. - required: - - day - - breakdown - additionalProperties: false - examples: - default: - value: - - day: '2023-10-15' - total_suggestions_count: 5000 - total_acceptances_count: 3000 - total_lines_suggested: 7000 - total_lines_accepted: 3500 - total_active_users: 15 - total_chat_acceptances: 45 - total_chat_turns: 350 - total_active_chat_users: 8 - breakdown: - - language: python - editor: vscode - suggestions_count: 3000 - acceptances_count: 2000 - lines_suggested: 3000 - lines_accepted: 1500 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 1000 - acceptances_count: 500 - lines_suggested: 2000 - lines_accepted: 1000 - active_users: 5 - - language: javascript - editor: vscode - suggestions_count: 1000 - acceptances_count: 500 - lines_suggested: 2000 - lines_accepted: 1000 - active_users: 5 - - day: '2023-10-16' - total_suggestions_count: 5200 - total_acceptances_count: 5100 - total_lines_suggested: 5300 - total_lines_accepted: 5000 - total_active_users: 15 - total_chat_acceptances: 57 - total_chat_turns: 455 - total_active_chat_users: 12 - breakdown: - - language: python - editor: vscode - suggestions_count: 3100 - acceptances_count: 3000 - lines_suggested: 3200 - lines_accepted: 3100 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 1100 - acceptances_count: 1000 - lines_suggested: 1200 - lines_accepted: 1100 - active_users: 5 - - language: javascript - editor: vscode - suggestions_count: 1000 - acceptances_count: 900 - lines_suggested: 1100 - lines_accepted: 1000 - active_users: 5 - '500': *39 - '401': *23 - '403': *27 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage "/enterprises/{enterprise}/dependabot/alerts": get: summary: List Dependabot alerts for an enterprise @@ -8420,8 +7237,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - - *38 - - &137 + - &43 + 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 + - &130 name: state in: query description: |- @@ -8430,7 +7254,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &138 + - &131 name: severity in: query description: |- @@ -8439,7 +7263,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &139 + - &132 name: ecosystem in: query description: |- @@ -8448,14 +7272,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &140 + - &133 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 - - &141 + - &134 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -8465,7 +7289,7 @@ paths: enum: - development - runtime - - &142 + - &135 name: sort in: query description: |- @@ -8478,10 +7302,10 @@ paths: - created - updated default: created - - *40 - - *41 - - *42 - - &143 + - *37 + - *38 + - *39 + - &136 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -8494,7 +7318,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &144 + - &137 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -8514,11 +7338,11 @@ paths: application/json: schema: type: array - items: &145 + items: &138 type: object description: A Dependabot alert. properties: - number: &46 + number: &44 type: integer description: The security alert number. readOnly: true @@ -8536,7 +7360,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: &43 + package: &40 type: object description: Details for the vulnerable package. readOnly: true @@ -8569,7 +7393,7 @@ paths: - development - runtime - - security_advisory: &383 + security_advisory: &382 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -8600,13 +7424,13 @@ paths: description: Vulnerable version range information for the advisory. readOnly: true - items: &45 + items: &42 type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: - package: *43 + package: *40 severity: type: string description: The severity of the vulnerability. @@ -8674,7 +7498,7 @@ paths: - score - vector_string additionalProperties: false - cvss_severities: *44 + cvss_severities: *41 cwes: type: array description: Details for the advisory pertaining to Common @@ -8774,30 +7598,30 @@ paths: - updated_at - withdrawn_at additionalProperties: false - security_vulnerability: *45 - url: &49 + security_vulnerability: *42 + url: &47 type: string description: The REST API URL of the alert resource. format: uri readOnly: true - html_url: &50 + html_url: &48 type: string description: The GitHub URL of the alert resource. format: uri readOnly: true - created_at: &47 + created_at: &45 type: string description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - updated_at: &48 + updated_at: &46 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: &123 + dismissed_at: &117 type: - string - 'null' @@ -8828,7 +7652,7 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: &122 + fixed_at: &116 type: - string - 'null' @@ -8836,7 +7660,7 @@ paths: and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - auto_dismissed_at: &384 + auto_dismissed_at: &383 type: - string - 'null' @@ -8844,7 +7668,7 @@ paths: ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - repository: &51 + repository: &49 title: Simple Repository description: A GitHub repository. type: object @@ -9184,7 +8008,7 @@ paths: - repository additionalProperties: false examples: - default: &146 + default: &139 value: - number: 2 state: dismissed @@ -9527,8 +8351,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - - *38 - - &217 + - *43 + - &211 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -9539,7 +8363,7 @@ paths: enum: - open - resolved - - &218 + - &212 name: secret_type in: query description: |- @@ -9549,7 +8373,7 @@ paths: required: false schema: type: string - - &219 + - &213 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -9558,7 +8382,7 @@ paths: required: false schema: type: string - - &220 + - &214 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. @@ -9570,11 +8394,11 @@ paths: - created - updated default: created - - *40 + - *37 - *17 - - *41 - - *42 - - &221 + - *38 + - *39 + - &215 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -9583,7 +8407,7 @@ paths: required: false schema: type: string - - &222 + - &216 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -9592,7 +8416,7 @@ paths: schema: type: boolean default: false - - &223 + - &217 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -9608,30 +8432,30 @@ paths: application/json: schema: type: array - items: &224 + items: &218 type: object properties: - number: *46 - created_at: *47 + number: *44 + created_at: *45 updated_at: anyOf: - type: 'null' - - *48 - url: *49 - html_url: *50 + - *46 + url: *47 + html_url: *48 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: &521 + state: &520 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: &522 + resolution: &521 type: - string - 'null' @@ -9665,7 +8489,7 @@ paths: secret: type: string description: The secret that was detected. - repository: *51 + repository: *49 push_protection_bypassed: type: - boolean @@ -9687,6 +8511,12 @@ paths: anyOf: - type: 'null' - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. push_protection_bypass_request_comment: type: - string @@ -9724,7 +8554,7 @@ paths: description: Whether the detected secret was found in multiple repositories in the same organization or enterprise. examples: - default: &225 + default: &219 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -9861,6 +8691,7 @@ paths: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true + push_protection_bypass_request_reviewer_comment: Example response push_protection_bypass_request_comment: Example comment push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment @@ -9948,6 +8779,7 @@ paths: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -9955,9 +8787,9 @@ paths: publicly_leaked: false multi_repo: false headers: - Link: *37 + Link: *50 '404': *6 - '503': &60 + '503': &55 description: Service unavailable content: application/json: @@ -9975,225 +8807,6 @@ 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: |- - > [!NOTE] - > This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." - - Use this endpoint to see a breakdown of aggregated metrics for various GitHub Copilot features. See the response schema tab for detailed metrics definitions. - - The response contains metrics for up to 28 days prior. Metrics are processed once per day for the previous day, - and the response will only include data up until yesterday. In order for an end user to be counted towards these metrics, - they must have telemetry enabled in their IDE. - - > [!NOTE] - > This endpoint will only return results for a given day if the enterprise team had **five or more members with active Copilot licenses** on that day, as evaluated at the end of that day. - - To access this endpoint, the Copilot Metrics API access policy must be enabled or set to "no policy" for the enterprise within GitHub settings. - Only owners and billing managers for the enterprise that contains the enterprise team can view Copilot metrics for the enterprise team. - - OAuth app tokens and personal access tokens (classic) need either the `manage_billing:copilot` or `read:enterprise` scopes to use this endpoint. - tags: - - copilot - operationId: copilot/copilot-metrics-for-enterprise-team - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-enterprise-team - parameters: - - *38 - - name: team_slug - description: The slug of the enterprise team name. - in: path - required: true - schema: - type: string - - name: since - description: Show usage metrics since this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`). - Maximum value is 28 days ago. - in: query - required: false - schema: - type: string - - name: until - description: Show usage metrics until this date. This is a timestamp in [ISO - 8601](https://en.wikipedia.org/wiki/ISO_8601) format (`YYYY-MM-DDTHH:MM:SSZ`) - and should not preceed the `since` date if it is passed. - in: query - required: false - schema: - type: string - - *18 - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *52 - examples: - default: *53 - '500': *39 - '403': *27 - '404': *6 - '422': *54 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-metrics - "/enterprises/{enterprise}/team/{team_slug}/copilot/usage": - get: - summary: Get a summary of Copilot usage for an enterprise team - description: |- - > [!NOTE] - > This endpoint is in public preview and is subject to change. This endpoint is only applicable to dedicated enterprise accounts for Copilot Business. See "[About enterprise accounts for Copilot Business](https://docs.github.com/admin/copilot-business-only/about-enterprise-accounts-for-copilot-business)." - - 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 an enterprise 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 enterprise team had five or more members with active Copilot licenses, as evaluated at the end of that day. - - Owners and billing managers for the enterprise that contains the enterprise team can view Copilot usage 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/usage-metrics-for-enterprise-team - externalDocs: - description: API method documentation - url: https://docs.github.com/rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team - parameters: - - *38 - - &184 - 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 - - *18 - - name: per_page - description: The number of days of metrics to display per page (max 28). For - more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." - in: query - schema: - type: integer - default: 28 - responses: - '200': - description: Response - content: - application/json: - schema: - type: array - items: *55 - examples: - default: &136 - value: - - day: '2023-10-15' - total_suggestions_count: 1000 - total_acceptances_count: 800 - total_lines_suggested: 1800 - total_lines_accepted: 1200 - total_active_users: 10 - total_chat_acceptances: 32 - total_chat_turns: 200 - total_active_chat_users: 4 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 250 - lines_suggested: 900 - lines_accepted: 700 - active_users: 5 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 400 - lines_accepted: 300 - active_users: 2 - - language: ruby - editor: vscode - suggestions_count: 400 - acceptances_count: 350 - lines_suggested: 500 - lines_accepted: 200 - active_users: 3 - - day: '2023-10-16' - total_suggestions_count: 800 - total_acceptances_count: 600 - total_lines_suggested: 1100 - total_lines_accepted: 700 - total_active_users: 12 - total_chat_acceptances: 57 - total_chat_turns: 426 - total_active_chat_users: 8 - breakdown: - - language: python - editor: vscode - suggestions_count: 300 - acceptances_count: 200 - lines_suggested: 600 - lines_accepted: 300 - active_users: 2 - - language: python - editor: jetbrains - suggestions_count: 300 - acceptances_count: 150 - lines_suggested: 300 - lines_accepted: 250 - active_users: 6 - - language: ruby - editor: vscode - suggestions_count: 200 - acceptances_count: 150 - lines_suggested: 200 - lines_accepted: 150 - active_users: 3 - '500': *39 - '401': *23 - '403': *27 - '404': *6 - x-github: - githubCloudOnly: false - enabledForGitHubApps: true - category: copilot - subcategory: copilot-usage "/events": get: summary: List public events @@ -10216,7 +8829,7 @@ paths: application/json: schema: type: array - items: &83 + items: &78 title: Event description: Event type: object @@ -10227,7 +8840,7 @@ paths: type: - string - 'null' - actor: &56 + actor: &51 title: Actor description: Actor type: object @@ -10268,13 +8881,13 @@ paths: - id - name - url - org: *56 + org: *51 payload: type: object properties: action: type: string - issue: &72 + issue: &67 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -10394,7 +9007,7 @@ paths: milestone: anyOf: - type: 'null' - - &371 + - &370 title: Milestone description: A collection of related issues and pull requests. @@ -10566,12 +9179,12 @@ paths: timeline_url: type: string format: uri - repository: *57 + repository: *52 performed_via_github_app: anyOf: - type: 'null' - *5 - author_association: &58 + author_association: &53 title: author_association type: string description: How the author is associated with the repository. @@ -10586,7 +9199,7 @@ paths: - OWNER examples: - OWNER - reactions: &59 + reactions: &54 title: Reaction Rollup type: object properties: @@ -10658,7 +9271,7 @@ paths: - author_association - created_at - updated_at - comment: &430 + comment: &429 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -10708,12 +9321,12 @@ paths: issue_url: type: string format: uri - author_association: *58 + author_association: *53 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *59 + reactions: *54 required: - id - node_id @@ -10810,7 +9423,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *35 '403': *27 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -10900,7 +9513,7 @@ paths: _links: type: object properties: - timeline: &61 + timeline: &56 title: Link With Type description: Hypermedia Link with Type type: object @@ -10912,17 +9525,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: *56 + security_advisories: *56 + current_user: *56 + current_user_public: *56 + current_user_actor: *56 + current_user_organization: *56 current_user_organizations: type: array - items: *61 - repository_discussions: *61 - repository_discussions_category: *61 + items: *56 + repository_discussions: *56 + repository_discussions_category: *56 required: - timeline - user @@ -10984,7 +9597,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *62 + - *57 - *17 - *18 responses: @@ -10994,7 +9607,7 @@ paths: application/json: schema: type: array - items: &63 + items: &58 title: Base Gist description: Base Gist type: object @@ -11089,7 +9702,7 @@ paths: - created_at - updated_at examples: - default: &64 + default: &59 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -11134,7 +9747,7 @@ paths: site_admin: false truncated: false headers: - Link: *37 + Link: *50 '304': *35 '403': *27 x-github: @@ -11213,7 +9826,7 @@ paths: description: Response content: application/json: - schema: &65 + schema: &60 title: Gist Simple description: Gist Simple type: object @@ -11231,7 +9844,7 @@ paths: url: type: string format: uri - user: &552 + user: &551 title: Public User description: Public User type: object @@ -11601,7 +10214,7 @@ paths: truncated: type: boolean examples: - default: &66 + default: &61 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -11704,7 +10317,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-public-gists parameters: - - *62 + - *57 - *17 - *18 responses: @@ -11714,11 +10327,11 @@ paths: application/json: schema: type: array - items: *63 + items: *58 examples: - default: *64 + default: *59 headers: - Link: *37 + Link: *50 '422': *15 '304': *35 '403': *27 @@ -11738,7 +10351,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-starred-gists parameters: - - *62 + - *57 - *17 - *18 responses: @@ -11748,11 +10361,11 @@ paths: application/json: schema: type: array - items: *63 + items: *58 examples: - default: *64 + default: *59 headers: - Link: *37 + Link: *50 '401': *23 '304': *35 '403': *27 @@ -11778,7 +10391,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist parameters: - - &67 + - &62 name: gist_id description: The unique identifier of the gist. in: path @@ -11790,10 +10403,10 @@ paths: description: Response content: application/json: - schema: *65 + schema: *60 examples: - default: *66 - '403': &70 + default: *61 + '403': &65 description: Forbidden Gist content: application/json: @@ -11842,7 +10455,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#update-a-gist parameters: - - *67 + - *62 requestBody: required: true content: @@ -11906,9 +10519,9 @@ paths: description: Response content: application/json: - schema: *65 + schema: *60 examples: - updateGist: *66 + updateGist: *61 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -12066,7 +10679,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#delete-a-gist parameters: - - *67 + - *62 responses: '204': description: Response @@ -12095,7 +10708,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#list-gist-comments parameters: - - *67 + - *62 - *17 - *18 responses: @@ -12105,7 +10718,7 @@ paths: application/json: schema: type: array - items: &68 + items: &63 title: Gist Comment description: A comment made to a gist. type: object @@ -12143,7 +10756,7 @@ paths: format: date-time examples: - '2011-04-18T23:23:56Z' - author_association: *58 + author_association: *53 required: - url - id @@ -12183,7 +10796,7 @@ paths: updated_at: '2011-04-18T23:23:56Z' author_association: COLLABORATOR headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -12208,7 +10821,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#create-a-gist-comment parameters: - - *67 + - *62 requestBody: required: true content: @@ -12234,9 +10847,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *63 examples: - default: &69 + default: &64 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -12294,8 +10907,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#get-a-gist-comment parameters: - - *67 - - &71 + - *62 + - &66 name: comment_id description: The unique identifier of the comment. in: path @@ -12308,12 +10921,12 @@ paths: description: Response content: application/json: - schema: *68 + schema: *63 examples: - default: *69 + default: *64 '304': *35 '404': *6 - '403': *70 + '403': *65 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -12335,8 +10948,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#update-a-gist-comment parameters: - - *67 - - *71 + - *62 + - *66 requestBody: required: true content: @@ -12362,9 +10975,9 @@ paths: description: Response content: application/json: - schema: *68 + schema: *63 examples: - default: *69 + default: *64 '404': *6 x-github: githubCloudOnly: false @@ -12381,8 +10994,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/comments#delete-a-gist-comment parameters: - - *67 - - *71 + - *62 + - *66 responses: '204': description: Response @@ -12405,7 +11018,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-commits parameters: - - *67 + - *62 - *17 - *18 responses: @@ -12506,7 +11119,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gist-forks parameters: - - *67 + - *62 - *17 - *18 responses: @@ -12516,7 +11129,7 @@ paths: application/json: schema: type: array - items: *65 + items: *60 examples: default: value: @@ -12562,7 +11175,7 @@ paths: type: User site_admin: false headers: - Link: *37 + Link: *50 '404': *6 '304': *35 '403': *27 @@ -12581,13 +11194,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#fork-a-gist parameters: - - *67 + - *62 responses: '201': description: Response content: application/json: - schema: *63 + schema: *58 examples: default: value: @@ -12658,7 +11271,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#check-if-a-gist-is-starred parameters: - - *67 + - *62 responses: '204': description: Response if gist is starred @@ -12688,7 +11301,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#star-a-gist parameters: - - *67 + - *62 responses: '204': description: Response @@ -12710,7 +11323,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#unstar-a-gist parameters: - - *67 + - *62 responses: '204': description: Response @@ -12739,7 +11352,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#get-a-gist-revision parameters: - - *67 + - *62 - name: sha in: path required: true @@ -12750,9 +11363,9 @@ paths: description: Response content: application/json: - schema: *65 + schema: *60 examples: - default: *66 + default: *61 '422': *15 '404': *6 '403': *27 @@ -12913,7 +11526,7 @@ paths: type: integer repositories: type: array - items: *57 + items: *52 repository_selection: type: string examples: @@ -13037,7 +11650,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *37 + Link: *50 '403': *27 '304': *35 '401': *23 @@ -13121,7 +11734,7 @@ paths: - closed - all default: open - - &174 + - &167 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -13139,8 +11752,8 @@ paths: - updated - comments default: created - - *40 - - *62 + - *37 + - *57 - name: collab in: query required: false @@ -13170,9 +11783,9 @@ paths: application/json: schema: type: array - items: *72 + items: *67 examples: - default: &175 + default: &168 value: - id: 1 node_id: MDU6SXNzdWUx @@ -13417,7 +12030,7 @@ paths: watchers: 1 author_association: COLLABORATOR headers: - Link: *37 + Link: *50 '422': *15 '304': *35 '404': *6 @@ -13452,7 +12065,7 @@ paths: application/json: schema: type: array - items: *73 + items: *68 examples: default: value: @@ -13749,7 +12362,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &74 + X-CommonMarker-Version: &69 example: 0.17.4 schema: type: string @@ -13804,7 +12417,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *74 + X-CommonMarker-Version: *69 content: text/html: schema: @@ -13833,7 +12446,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account parameters: - - &77 + - &72 name: account_id description: account_id parameter in: path @@ -13845,7 +12458,7 @@ paths: description: Response content: application/json: - schema: &76 + schema: &71 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -13879,7 +12492,7 @@ paths: - 'null' id: type: integer - plan: &75 + plan: &70 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -13982,7 +12595,7 @@ paths: - 'null' updated_at: type: string - plan: *75 + plan: *70 required: - url - id @@ -13990,7 +12603,7 @@ paths: - login - marketplace_purchase examples: - default: &78 + default: &73 value: url: https://api.github.com/orgs/github type: Organization @@ -14075,9 +12688,9 @@ paths: application/json: schema: type: array - items: *75 + items: *70 examples: - default: &79 + default: &74 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -14095,7 +12708,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *37 + Link: *50 '404': *6 '401': *23 x-github: @@ -14117,14 +12730,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &80 + - &75 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &81 + - &76 name: sort description: The property to sort the results by. in: query @@ -14154,9 +12767,9 @@ paths: application/json: schema: type: array - items: *76 + items: *71 examples: - default: &82 + default: &77 value: - url: https://api.github.com/orgs/github type: Organization @@ -14207,7 +12820,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *37 + Link: *50 '404': *6 '422': *15 '401': *23 @@ -14230,15 +12843,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#get-a-subscription-plan-for-an-account-stubbed parameters: - - *77 + - *72 responses: '200': description: Response content: application/json: - schema: *76 + schema: *71 examples: - default: *78 + default: *73 '404': description: Not Found when the account has not purchased the listing '401': *23 @@ -14270,11 +12883,11 @@ paths: application/json: schema: type: array - items: *75 + items: *70 examples: - default: *79 + default: *74 headers: - Link: *37 + Link: *50 '401': *23 x-github: githubCloudOnly: false @@ -14295,8 +12908,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *80 - - *81 + - *75 + - *76 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -14316,11 +12929,11 @@ paths: application/json: schema: type: array - items: *76 + items: *71 examples: - default: *82 + default: *77 headers: - Link: *37 + Link: *50 '401': *23 x-github: githubCloudOnly: false @@ -14568,14 +13181,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-network-of-repositories parameters: - - &242 + - &241 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &243 + - &242 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -14592,7 +13205,7 @@ paths: application/json: schema: type: array - items: *83 + items: *78 examples: default: value: @@ -14646,7 +13259,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &254 + '301': &253 description: Moved permanently content: application/json: @@ -14668,7 +13281,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &459 + - &458 name: all description: If `true`, show notifications marked as read. in: query @@ -14676,7 +13289,7 @@ paths: schema: type: boolean default: false - - &460 + - &459 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -14685,8 +13298,8 @@ paths: schema: type: boolean default: false - - *62 - - &461 + - *57 + - &460 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: @@ -14711,14 +13324,14 @@ paths: application/json: schema: type: array - items: &84 + items: &79 title: Thread description: Thread type: object properties: id: type: string - repository: &108 + repository: &102 title: Minimal Repository description: Minimal Repository type: object @@ -15057,7 +13670,7 @@ paths: type: boolean examples: - false - security_and_analysis: &208 + security_and_analysis: &202 type: - object - 'null' @@ -15204,7 +13817,7 @@ paths: - url - subscription_url examples: - default: &462 + default: &461 value: - id: '1' repository: @@ -15286,7 +13899,7 @@ paths: url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -15370,7 +13983,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread parameters: - - &85 + - &80 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 @@ -15384,7 +13997,7 @@ paths: description: Response content: application/json: - schema: *84 + schema: *79 examples: default: value: @@ -15486,7 +14099,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-read parameters: - - *85 + - *80 responses: '205': description: Reset Content @@ -15508,7 +14121,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-a-thread-as-done parameters: - - *85 + - *80 responses: '204': description: No content @@ -15531,13 +14144,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - - *85 + - *80 responses: '200': description: Response content: application/json: - schema: &86 + schema: &81 title: Thread Subscription description: Thread Subscription type: object @@ -15581,7 +14194,7 @@ paths: - url - subscribed examples: - default: &87 + default: &82 value: subscribed: true ignored: false @@ -15612,7 +14225,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#set-a-thread-subscription parameters: - - *85 + - *80 requestBody: required: false content: @@ -15633,9 +14246,9 @@ paths: description: Response content: application/json: - schema: *86 + schema: *81 examples: - default: *87 + default: *82 '304': *35 '403': *27 '401': *23 @@ -15658,7 +14271,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#delete-a-thread-subscription parameters: - - *85 + - *80 responses: '204': description: Response @@ -15753,9 +14366,79 @@ paths: application/json: schema: type: array - items: *88 + items: &129 + title: Organization Simple + description: A GitHub organization. + type: object + properties: + login: + type: string + examples: + - github + id: + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDEyOk9yZ2FuaXphdGlvbjE= + url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github + repos_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/repos + events_url: + type: string + format: uri + examples: + - https://api.github.com/orgs/github/events + hooks_url: + type: string + examples: + - https://api.github.com/orgs/github/hooks + issues_url: + type: string + examples: + - https://api.github.com/orgs/github/issues + members_url: + type: string + examples: + - https://api.github.com/orgs/github/members{/member} + public_members_url: + type: string + examples: + - https://api.github.com/orgs/github/public_members{/member} + avatar_url: + type: string + examples: + - https://github.com/images/error/octocat_happy.gif + description: + type: + - string + - 'null' + examples: + - A great organization + required: + - login + - url + - id + - node_id + - repos_url + - events_url + - hooks_url + - issues_url + - members_url + - public_members_url + - avatar_url + - description examples: - default: &569 + default: &568 value: - login: github id: 1 @@ -15794,7 +14477,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - &89 + - &83 name: org description: The organization name. The name is not case sensitive. in: path @@ -15904,8 +14587,12 @@ paths: repositoryName: github/example '400': *14 '403': *27 - '500': *39 - '503': *60 + '500': &127 + description: Internal Error + content: + application/json: + schema: *3 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15931,13 +14618,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#get-an-organization parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &90 + schema: &84 title: Organization Full description: Organization Full type: object @@ -16292,7 +14979,7 @@ paths: - updated_at - archived_at examples: - default-response: &91 + default-response: &85 value: login: github id: 1 @@ -16383,7 +15070,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#update-an-organization parameters: - - *89 + - *83 requestBody: required: false content: @@ -16600,18 +15287,18 @@ paths: description: Response content: application/json: - schema: *90 + schema: *84 examples: - default: *91 + default: *85 '422': description: Validation failed content: application/json: schema: oneOf: - - *92 - - *93 - '409': &128 + - *86 + - *87 + '409': &122 description: Conflict content: application/json: @@ -16638,9 +15325,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#delete-an-organization parameters: - - *89 + - *83 responses: - '202': *94 + '202': *88 '404': *6 '403': *27 x-github: @@ -16663,7 +15350,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response @@ -16689,7 +15376,7 @@ paths: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16710,7 +15397,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: - - *89 + - *83 - *17 - *18 responses: @@ -16728,7 +15415,7 @@ paths: type: integer repository_cache_usages: type: array - items: &259 + items: &258 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -16766,7 +15453,7 @@ paths: active_caches_size_in_bytes: 1022142 active_caches_count: 2 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -16786,13 +15473,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: - - *89 + - *83 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &95 + schema: &89 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -16806,7 +15493,7 @@ paths: required: - include_claim_keys examples: - default: &96 + default: &90 value: include_claim_keys: - repo @@ -16828,20 +15515,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: - - *89 + - *83 requestBody: required: true content: application/json: - schema: *95 + schema: *89 examples: - default: *96 + default: *90 responses: '201': description: Empty response content: application/json: - schema: &117 + schema: &111 title: Empty Object description: An object without any properties. type: object @@ -16871,7 +15558,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response @@ -16880,7 +15567,7 @@ paths: schema: type: object properties: - enabled_repositories: &97 + enabled_repositories: &91 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -16893,7 +15580,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: &98 + allowed_actions: &92 type: string description: The permissions policy that controls the actions and reusable workflows that are allowed to run. @@ -16901,7 +15588,7 @@ paths: - all - local_only - selected - selected_actions_url: &265 + selected_actions_url: &264 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` @@ -16932,7 +15619,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-an-organization parameters: - - *89 + - *83 responses: '204': description: Response @@ -16943,8 +15630,8 @@ paths: schema: type: object properties: - enabled_repositories: *97 - allowed_actions: *98 + enabled_repositories: *91 + allowed_actions: *92 required: - enabled_repositories examples: @@ -16971,7 +15658,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: - - *89 + - *83 - *17 - *18 responses: @@ -16989,9 +15676,9 @@ paths: type: number repositories: type: array - items: *57 + items: *52 examples: - default: &563 + default: &562 value: total_count: 1 repositories: @@ -17131,7 +15818,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: - - *89 + - *83 responses: '204': description: Response @@ -17175,8 +15862,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: - - *89 - - &99 + - *83 + - &93 name: repository_id description: The unique identifier of the repository. in: path @@ -17204,8 +15891,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: - - *89 - - *99 + - *83 + - *93 responses: '204': description: Response @@ -17228,13 +15915,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &100 + schema: &94 type: object properties: github_owned_allowed: @@ -17256,7 +15943,7 @@ paths: items: type: string examples: - default: &101 + default: &95 value: github_owned_allowed: true verified_allowed: false @@ -17281,7 +15968,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-an-organization parameters: - - *89 + - *83 responses: '204': description: Response @@ -17289,9 +15976,9 @@ paths: required: false content: application/json: - schema: *100 + schema: *94 examples: - selected_actions: *101 + selected_actions: *95 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -17313,23 +16000,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &269 + schema: &268 type: object properties: - default_workflow_permissions: &102 + default_workflow_permissions: &96 type: string description: The default workflow permissions granted to the GITHUB_TOKEN when running workflows. enum: - read - write - can_approve_pull_request_reviews: &103 + can_approve_pull_request_reviews: &97 type: boolean description: Whether GitHub Actions can approve pull requests. Enabling this can be a security risk. @@ -17337,7 +16024,7 @@ paths: - default_workflow_permissions - can_approve_pull_request_reviews examples: - default: &104 + default: &98 summary: Give read-only permission, and allow approving PRs. value: default_workflow_permissions: read @@ -17362,7 +16049,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-an-organization parameters: - - *89 + - *83 responses: '204': description: Success response @@ -17370,13 +16057,13 @@ paths: required: false content: application/json: - schema: &270 + schema: &269 type: object properties: - default_workflow_permissions: *102 - can_approve_pull_request_reviews: *103 + default_workflow_permissions: *96 + can_approve_pull_request_reviews: *97 examples: - default: *104 + default: *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -17396,7 +16083,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: - - *89 + - *83 - *17 - *18 - name: visible_to_repository @@ -17421,7 +16108,7 @@ paths: type: number runner_groups: type: array - items: &105 + items: &99 type: object properties: id: @@ -17534,7 +16221,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: - - *89 + - *83 requestBody: required: true content: @@ -17604,9 +16291,9 @@ paths: description: Response content: application/json: - schema: *105 + schema: *99 examples: - default: &107 + default: &101 value: id: 2 name: octo-runner-group @@ -17641,8 +16328,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: - - *89 - - &106 + - *83 + - &100 name: runner_group_id description: Unique identifier of the self-hosted runner group. in: path @@ -17654,7 +16341,7 @@ paths: description: Response content: application/json: - schema: *105 + schema: *99 examples: default: value: @@ -17690,8 +16377,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: - - *89 - - *106 + - *83 + - *100 requestBody: required: true content: @@ -17742,9 +16429,9 @@ paths: description: Response content: application/json: - schema: *105 + schema: *99 examples: - default: *107 + default: *101 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -17763,8 +16450,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: - - *89 - - *106 + - *83 + - *100 responses: '204': description: Response @@ -17787,8 +16474,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: - - *89 - - *106 + - *83 + - *100 - *18 - *17 responses: @@ -17806,9 +16493,9 @@ paths: type: number repositories: type: array - items: *108 + items: *102 examples: - default: &555 + default: &554 value: total_count: 1 repositories: @@ -18060,8 +16747,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: - - *89 - - *106 + - *83 + - *100 requestBody: required: true content: @@ -18105,9 +16792,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: - - *89 - - *106 - - *99 + - *83 + - *100 + - *93 responses: '204': description: Response @@ -18129,9 +16816,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: - - *89 - - *106 - - *99 + - *83 + - *100 + - *93 responses: '204': description: Response @@ -18154,8 +16841,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: - - *89 - - *106 + - *83 + - *100 - *17 - *18 responses: @@ -18173,7 +16860,7 @@ paths: type: number runners: type: array - items: &110 + items: &104 title: Self hosted runners description: A self hosted runner type: object @@ -18207,7 +16894,7 @@ paths: type: boolean labels: type: array - items: &113 + items: &107 title: Self hosted runner label description: A label for a self hosted runner type: object @@ -18235,7 +16922,7 @@ paths: - busy - labels examples: - default: &111 + default: &105 value: total_count: 2 runners: @@ -18273,7 +16960,7 @@ paths: name: no-gpu type: custom headers: - Link: *37 + Link: *50 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -18292,8 +16979,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: - - *89 - - *106 + - *83 + - *100 requestBody: required: true content: @@ -18337,9 +17024,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: - - *89 - - *106 - - &109 + - *83 + - *100 + - &103 name: runner_id description: Unique identifier of the self-hosted runner. in: path @@ -18367,9 +17054,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: - - *89 - - *106 - - *109 + - *83 + - *100 + - *103 responses: '204': description: Response @@ -18399,7 +17086,7 @@ paths: in: query schema: type: string - - *89 + - *83 - *17 - *18 responses: @@ -18417,11 +17104,11 @@ paths: type: integer runners: type: array - items: *110 + items: *104 examples: - default: *111 + default: *105 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -18443,7 +17130,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response @@ -18451,7 +17138,7 @@ paths: application/json: schema: type: array - items: &271 + items: &270 title: Runner Application description: Runner Application type: object @@ -18476,7 +17163,7 @@ paths: - download_url - filename examples: - default: &272 + default: &271 value: - os: osx architecture: x64 @@ -18519,7 +17206,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: - - *89 + - *83 requestBody: required: true content: @@ -18562,7 +17249,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &273 + '201': &272 description: Response content: application/json: @@ -18572,7 +17259,7 @@ paths: - runner - encoded_jit_config properties: - runner: *110 + runner: *104 encoded_jit_config: type: string description: The base64 encoded runner configuration. @@ -18628,13 +17315,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-an-organization parameters: - - *89 + - *83 responses: '201': description: Response content: application/json: - schema: &112 + schema: &106 title: Authentication Token description: Authentication Token type: object @@ -18658,7 +17345,7 @@ paths: repositories: description: The repositories this token has access to type: array - items: *57 + items: *52 single_file: type: - string @@ -18676,7 +17363,7 @@ paths: - token - expires_at examples: - default: &274 + default: &273 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -18707,15 +17394,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-an-organization parameters: - - *89 + - *83 responses: '201': description: Response content: application/json: - schema: *112 + schema: *106 examples: - default: &275 + default: &274 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -18740,16 +17427,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: - - *89 - - *109 + - *83 + - *103 responses: '200': description: Response content: application/json: - schema: *110 + schema: *104 examples: - default: &276 + default: &275 value: id: 23 name: MBP @@ -18789,8 +17476,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: - - *89 - - *109 + - *83 + - *103 responses: '204': description: Response @@ -18815,10 +17502,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: - - *89 - - *109 + - *83 + - *103 responses: - '200': &114 + '200': &108 description: Response content: application/json: @@ -18832,7 +17519,7 @@ paths: type: integer labels: type: array - items: *113 + items: *107 examples: default: value: @@ -18871,8 +17558,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: - - *89 - - *109 + - *83 + - *103 requestBody: required: true content: @@ -18896,7 +17583,7 @@ paths: - gpu - accelerated responses: - '200': *114 + '200': *108 '404': *6 '422': *7 x-github: @@ -18920,8 +17607,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: - - *89 - - *109 + - *83 + - *103 requestBody: required: true content: @@ -18946,7 +17633,7 @@ paths: - gpu - accelerated responses: - '200': *114 + '200': *108 '404': *6 '422': *7 x-github: @@ -18970,10 +17657,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: - - *89 - - *109 + - *83 + - *103 responses: - '200': &277 + '200': &276 description: Response content: application/json: @@ -18987,7 +17674,7 @@ paths: type: integer labels: type: array - items: *113 + items: *107 examples: default: value: @@ -19028,9 +17715,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: - - *89 - - *109 - - &278 + - *83 + - *103 + - &277 name: name description: The name of a self-hosted runner's custom label. in: path @@ -19038,7 +17725,7 @@ paths: schema: type: string responses: - '200': *114 + '200': *108 '404': *6 '422': *7 x-github: @@ -19063,7 +17750,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-organization-secrets parameters: - - *89 + - *83 - *17 - *18 responses: @@ -19081,7 +17768,7 @@ paths: type: integer secrets: type: array - items: &115 + items: &109 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -19133,7 +17820,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19156,13 +17843,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-public-key parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &290 + schema: &289 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -19197,7 +17884,7 @@ paths: - key_id - key examples: - default: &291 + default: &290 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -19222,8 +17909,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-organization-secret parameters: - - *89 - - &116 + - *83 + - &110 name: secret_name description: The name of the secret. in: path @@ -19235,7 +17922,7 @@ paths: description: Response content: application/json: - schema: *115 + schema: *109 examples: default: value: @@ -19265,8 +17952,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 requestBody: required: true content: @@ -19321,7 +18008,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -19347,8 +18034,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 responses: '204': description: Response @@ -19374,8 +18061,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - *18 - *17 responses: @@ -19393,9 +18080,9 @@ paths: type: integer repositories: type: array - items: *108 + items: *102 examples: - default: &120 + default: &114 value: total_count: 1 repositories: @@ -19487,8 +18174,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 requestBody: required: true content: @@ -19540,8 +18227,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#add-selected-repository-to-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - name: repository_id in: path required: true @@ -19574,8 +18261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - name: repository_id in: path required: true @@ -19607,8 +18294,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-organization-variables parameters: - - *89 - - &264 + - *83 + - &263 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)." @@ -19632,7 +18319,7 @@ paths: type: integer variables: type: array - items: &118 + items: &112 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -19701,7 +18388,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/actions/variables/ADMIN_EMAIL/repositories headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -19722,7 +18409,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-organization-variable parameters: - - *89 + - *83 requestBody: required: true content: @@ -19770,7 +18457,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -19795,8 +18482,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-organization-variable parameters: - - *89 - - &119 + - *83 + - &113 name: name description: The name of the variable. in: path @@ -19808,7 +18495,7 @@ paths: description: Response content: application/json: - schema: *118 + schema: *112 examples: default: value: @@ -19838,8 +18525,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-organization-variable parameters: - - *89 - - *119 + - *83 + - *113 requestBody: required: true content: @@ -19901,8 +18588,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-organization-variable parameters: - - *89 - - *119 + - *83 + - *113 responses: '204': description: Response @@ -19928,8 +18615,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-selected-repositories-for-an-organization-variable parameters: - - *89 - - *119 + - *83 + - *113 - *18 - *17 responses: @@ -19947,9 +18634,9 @@ paths: type: integer repositories: type: array - items: *108 + items: *102 examples: - default: *120 + default: *114 '409': description: Response when the visibility of the variable is not set to `selected` @@ -19975,8 +18662,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#set-selected-repositories-for-an-organization-variable parameters: - - *89 - - *119 + - *83 + - *113 requestBody: required: true content: @@ -20025,8 +18712,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#add-selected-repository-to-an-organization-variable parameters: - - *89 - - *119 + - *83 + - *113 - name: repository_id in: path required: true @@ -20060,8 +18747,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#remove-selected-repository-from-an-organization-variable parameters: - - *89 - - *119 + - *83 + - *113 - name: repository_id in: path required: true @@ -20095,9 +18782,9 @@ paths: url: https://docs.github.com/rest/orgs/orgs#list-attestations parameters: - *17 - - *41 - - *42 - - *89 + - *38 + - *39 + - *83 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -20137,8 +18824,10 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: - default: &304 + default: &303 value: attestations: - bundle: @@ -20245,7 +18934,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *89 + - *83 - *17 - *18 responses: @@ -20257,7 +18946,7 @@ paths: type: array items: *4 examples: - default: &176 + default: &169 value: - login: octocat id: 1 @@ -20295,8 +18984,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#check-if-a-user-is-blocked-by-an-organization parameters: - - *89 - - &121 + - *83 + - &115 name: username description: The handle for the GitHub user account. in: path @@ -20327,8 +19016,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response @@ -20348,8 +19037,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response @@ -20374,18 +19063,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization parameters: - - *89 - - &329 + - *83 + - &328 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: &124 + schema: &118 type: string description: The name of the tool used to generate the code scanning analysis. - - &330 + - &329 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 @@ -20393,23 +19082,23 @@ paths: or `tool_name`, but not both. in: query required: false - schema: &125 + schema: &119 type: - string - 'null' description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data. - - *41 - - *42 + - *38 + - *39 - *18 - *17 - - *40 + - *37 - name: state description: If specified, only code scanning alerts with this state will be returned. in: query required: false - schema: &332 + schema: &331 type: string description: State of a code scanning alert. enum: @@ -20432,7 +19121,7 @@ paths: be returned. in: query required: false - schema: &333 + schema: &332 type: string description: Severity of a code scanning alert. enum: @@ -20453,18 +19142,18 @@ paths: items: type: object properties: - number: *46 - created_at: *47 - updated_at: *48 - url: *49 - html_url: *50 - instances_url: &334 + number: *44 + created_at: *45 + updated_at: *46 + url: *47 + html_url: *48 + instances_url: &333 type: string description: The REST API URL for fetching the list of instances for an alert. format: uri readOnly: true - state: &126 + state: &120 type: - string - 'null' @@ -20474,13 +19163,13 @@ paths: - dismissed - fixed - - fixed_at: *122 + fixed_at: *116 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *123 - dismissed_reason: &335 + dismissed_at: *117 + dismissed_reason: &334 type: - string - 'null' @@ -20491,14 +19180,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &336 + dismissed_comment: &335 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &337 + rule: &336 type: object properties: id: @@ -20559,26 +19248,26 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &338 + tool: &337 type: object properties: - name: *124 + name: *118 version: type: - string - 'null' description: The version of the tool used to generate the code scanning analysis. - guid: *125 - most_recent_instance: &339 + guid: *119 + most_recent_instance: &338 type: object properties: - ref: &331 + ref: &330 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &345 + analysis_key: &344 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -20589,13 +19278,13 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &346 + category: &345 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: *126 + state: *120 commit_sha: type: string message: @@ -20636,7 +19325,7 @@ paths: - test - library - - repository: *51 + repository: *49 required: - number - created_at @@ -20881,9 +19570,9 @@ paths: trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha} hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks headers: - Link: *37 + Link: *50 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -20905,7 +19594,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-code-security-configurations-for-an-organization parameters: - - *89 + - *83 - name: target_type in: query description: The target type of the code security configuration @@ -20924,8 +19613,8 @@ paths: schema: type: integer default: 30 - - *41 - - *42 + - *38 + - *39 responses: '200': description: Response @@ -20933,7 +19622,7 @@ paths: application/json: schema: type: array - items: &127 + items: &121 type: object description: A code security configuration properties: @@ -21195,7 +19884,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#create-a-code-security-configuration parameters: - - *89 + - *83 requestBody: required: true content: @@ -21268,7 +19957,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &131 + code_scanning_default_setup_options: &125 type: - object - 'null' @@ -21387,9 +20076,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *127 + schema: *121 examples: - default: &129 + default: &123 value: id: 1325 target_type: organization @@ -21438,7 +20127,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-default-code-security-configurations parameters: - - *89 + - *83 responses: '200': description: Response @@ -21458,7 +20147,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *127 + configuration: *121 examples: default: value: @@ -21548,7 +20237,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *89 + - *83 requestBody: required: true content: @@ -21571,12 +20260,12 @@ paths: - 32 - 91 responses: - '204': &132 + '204': &126 description: A header with no content is returned. '400': *14 '403': *27 '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21598,8 +20287,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-a-code-security-configuration parameters: - - *89 - - &130 + - *83 + - &124 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -21611,9 +20300,9 @@ paths: description: Response content: application/json: - schema: *127 + schema: *121 examples: - default: *129 + default: *123 '304': *35 '403': *27 '404': *6 @@ -21637,8 +20326,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#update-a-code-security-configuration parameters: - - *89 - - *130 + - *83 + - *124 requestBody: required: true content: @@ -21704,7 +20393,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *131 + code_scanning_default_setup_options: *125 secret_scanning: type: string description: The enablement status of secret scanning @@ -21791,7 +20480,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *127 + schema: *121 examples: default: value: @@ -21845,14 +20534,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *89 - - *130 + - *83 + - *124 responses: - '204': *132 + '204': *126 '400': *14 '403': *27 '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21876,8 +20565,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *89 - - *130 + - *83 + - *124 requestBody: required: true content: @@ -21916,7 +20605,7 @@ paths: - 32 - 91 responses: - '202': *94 + '202': *88 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21940,8 +20629,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: - - *89 - - *130 + - *83 + - *124 requestBody: required: true content: @@ -21981,12 +20670,12 @@ paths: - none - private_and_internal - public - configuration: *127 + configuration: *121 examples: default: value: default_for_new_repos: all - configuration: *129 + configuration: *123 '403': *27 '404': *6 x-github: @@ -22010,8 +20699,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-security/configurations#get-repositories-associated-with-a-code-security-configuration parameters: - - *89 - - *130 + - *83 + - *124 - 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)." @@ -22020,8 +20709,8 @@ paths: schema: type: integer default: 30 - - *41 - - *42 + - *38 + - *39 - name: status description: |- A comma-separated list of statuses. If specified, only repositories with these attachment statuses will be returned. @@ -22057,7 +20746,7 @@ paths: - failed - updating - removed_by_enterprise - repository: *51 + repository: *49 examples: default: summary: Example of code security configuration repositories @@ -22154,7 +20843,7 @@ paths: parameters: - *17 - *18 - - *89 + - *83 responses: '200': description: Response @@ -22170,7 +20859,7 @@ paths: type: integer codespaces: type: array - items: &177 + items: &170 type: object title: Codespace description: A codespace. @@ -22201,11 +20890,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *108 + repository: *102 machine: anyOf: - type: 'null' - - &359 + - &358 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -22492,7 +21181,7 @@ paths: - pulls_url - recent_folders examples: - default: &178 + default: &171 value: total_count: 3 codespaces: @@ -22902,7 +21591,7 @@ paths: stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop recent_folders: [] '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -22924,7 +21613,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *89 + - *83 deprecated: true requestBody: required: true @@ -22968,7 +21657,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -22991,7 +21680,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#add-users-to-codespaces-access-for-an-organization parameters: - - *89 + - *83 deprecated: true requestBody: required: true @@ -23023,7 +21712,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23046,7 +21735,7 @@ paths: url: https://docs.github.com/rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *89 + - *83 requestBody: required: true content: @@ -23077,7 +21766,7 @@ paths: description: Users are neither members nor collaborators of this organization. '404': *6 '422': *15 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23098,7 +21787,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *89 + - *83 - *17 - *18 responses: @@ -23116,7 +21805,7 @@ paths: type: integer secrets: type: array - items: &133 + items: &128 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -23157,7 +21846,7 @@ paths: - updated_at - visibility examples: - default: &360 + default: &359 value: total_count: 2 secrets: @@ -23170,7 +21859,7 @@ paths: updated_at: '2020-01-11T11:59:22Z' visibility: all headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23189,13 +21878,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &361 + schema: &360 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -23230,7 +21919,7 @@ paths: - key_id - key examples: - default: &362 + default: &361 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -23253,23 +21942,23 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 responses: '200': description: Response content: application/json: - schema: *133 + schema: *128 examples: - default: &364 + default: &363 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' updated_at: '2020-01-10T14:59:22Z' visibility: all headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -23289,8 +21978,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#create-or-update-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 requestBody: required: true content: @@ -23345,7 +22034,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -23371,8 +22060,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 responses: '204': description: Response @@ -23397,8 +22086,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#list-selected-repositories-for-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - *18 - *17 responses: @@ -23416,9 +22105,9 @@ paths: type: integer repositories: type: array - items: *108 + items: *102 examples: - default: *120 + default: *114 '404': *6 x-github: githubCloudOnly: false @@ -23440,8 +22129,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#set-selected-repositories-for-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 requestBody: required: true content: @@ -23491,8 +22180,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#add-selected-repository-to-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - name: repository_id in: path required: true @@ -23525,8 +22214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organization-secrets#remove-selected-repository-from-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - name: repository_id in: path required: true @@ -23565,7 +22254,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: - - *89 + - *83 responses: '200': description: OK @@ -23676,7 +22365,7 @@ paths: cli: enabled public_code_suggestions: block plan_type: business - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -23708,7 +22397,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: - - *89 + - *83 - *18 - name: per_page description: The number of results per page (max 100). For more information, @@ -23731,12 +22420,348 @@ paths: currently being billed. seats: type: array - items: *134 + items: &173 + title: Copilot Business Seat Detail + description: Information about a Copilot Business seat assignment + for a user, team, or organization. + type: object + properties: + assignee: *4 + organization: + anyOf: + - type: 'null' + - *129 + assigning_team: + description: The team through which the assignee is granted + access to GitHub Copilot, if applicable. + oneOf: + - &166 + title: Team + description: Groups of organization members that gives + permissions on specified repositories. + type: object + properties: + id: + type: integer + node_id: + type: string + name: + type: string + slug: + type: string + description: + type: + - string + - 'null' + privacy: + type: string + notification_setting: + type: string + permission: + type: string + permissions: + type: object + properties: + pull: + type: boolean + triage: + type: boolean + push: + type: boolean + maintain: + type: boolean + admin: + type: boolean + required: + - pull + - triage + - push + - maintain + - admin + url: + type: string + format: uri + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + members_url: + type: string + repositories_url: + type: string + format: uri + parent: + anyOf: + - type: 'null' + - &181 + title: Team Simple + description: Groups of organization members that + gives permissions on specified repositories. + type: object + properties: + id: + description: Unique identifier of the team + type: integer + examples: + - 1 + node_id: + type: string + examples: + - MDQ6VGVhbTE= + url: + description: URL for the team + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1 + members_url: + type: string + examples: + - https://api.github.com/organizations/1/team/1/members{/member} + name: + description: Name of the team + type: string + examples: + - Justice League + description: + description: Description of the team + type: + - string + - 'null' + examples: + - A great team. + permission: + description: Permission that the team will have + for its repositories + type: string + examples: + - admin + privacy: + description: The level of privacy this team + should have + type: string + examples: + - closed + notification_setting: + description: The notification setting the team + has set + type: string + examples: + - notifications_enabled + html_url: + type: string + format: uri + examples: + - https://github.com/orgs/rails/teams/core + repositories_url: + type: string + format: uri + examples: + - https://api.github.com/organizations/1/team/1/repos + slug: + type: string + examples: + - justice-league + ldap_dn: + description: Distinguished Name (DN) that team + maps to within LDAP environment + type: string + examples: + - uid=example,ou=users,dc=github,dc=com + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + required: + - id + - node_id + - url + - members_url + - name + - description + - permission + - html_url + - repositories_url + - slug + - parent + - title: Enterprise Team + description: Group of enterprise owners and/or members + type: object + properties: + id: + type: integer + format: int64 + name: + type: string + slug: + type: string + url: + type: string + format: uri + sync_to_organizations: + type: string + examples: + - disabled | all + group_id: + type: + - string + - 'null' + examples: + - 62ab9291-fae2-468e-974b-7e45096d5021 + html_url: + type: string + format: uri + examples: + - https://github.com/enterprises/dc/teams/justice-league + members_url: + type: string + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + required: + - id + - url + - members_url + - sync_to_organizations + - name + - html_url + - slug + - created_at + - updated_at + type: + - 'null' + - object + pending_cancellation_date: + type: + - string + - 'null' + format: date + description: The pending cancellation date for the seat, + in `YYYY-MM-DD` format. This will be null unless the assignee's + Copilot access has been canceled during the current billing + cycle. If the seat has been cancelled, this corresponds + to the start of the organization's next billing cycle. + last_activity_at: + type: + - string + - 'null' + format: date-time + description: Timestamp of user's last GitHub Copilot activity, + in ISO 8601 format. + last_activity_editor: + type: + - string + - 'null' + description: Last editor that was used by the user for a + GitHub Copilot completion. + created_at: + type: string + format: date-time + description: Timestamp of when the assignee was last granted + access to GitHub Copilot, in ISO 8601 format. + updated_at: + type: string + format: date-time + deprecated: true + description: "**Closing down notice:** This field is no + longer relevant and is closing down. Use the `created_at` + field to determine when the assignee was last granted + access to GitHub Copilot. Timestamp of when the assignee's + GitHub Copilot access was last updated, in ISO 8601 format." + plan_type: + type: string + description: The Copilot plan of the organization, or the + parent enterprise, when applicable. + enum: + - business + - enterprise + - unknown + required: + - assignee + - created_at + additionalProperties: false examples: - default: *135 + default: + value: + total_seats: 2 + seats: + - created_at: '2021-08-03T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: + last_activity_at: '2021-10-14T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + plan_type: business + assignee: + login: octocat + id: 1 + node_id: MDQ6VXNlcjE= + avatar_url: https://github.com/images/error/octocat_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octocat + html_url: https://github.com/octocat + followers_url: https://api.github.com/users/octocat/followers + following_url: https://api.github.com/users/octocat/following{/other_user} + gists_url: https://api.github.com/users/octocat/gists{/gist_id} + starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octocat/subscriptions + organizations_url: https://api.github.com/users/octocat/orgs + repos_url: https://api.github.com/users/octocat/repos + events_url: https://api.github.com/users/octocat/events{/privacy} + received_events_url: https://api.github.com/users/octocat/received_events + type: User + site_admin: false + assigning_team: + id: 1 + node_id: MDQ6VGVhbTE= + url: https://api.github.com/teams/1 + html_url: https://github.com/orgs/github/teams/justice-league + name: Justice League + slug: justice-league + description: A great team. + privacy: closed + notification_setting: notifications_enabled + permission: admin + members_url: https://api.github.com/teams/1/members{/member} + repositories_url: https://api.github.com/teams/1/repos + parent: + - created_at: '2021-09-23T18:00:00-06:00' + updated_at: '2021-09-23T15:00:00-06:00' + pending_cancellation_date: '2021-11-01' + last_activity_at: '2021-10-13T00:53:32-06:00' + last_activity_editor: vscode/1.77.3/copilot/1.86.82 + assignee: + login: octokitten + id: 1 + node_id: MDQ76VNlcjE= + avatar_url: https://github.com/images/error/octokitten_happy.gif + gravatar_id: '' + url: https://api.github.com/users/octokitten + html_url: https://github.com/octokitten + followers_url: https://api.github.com/users/octokitten/followers + following_url: https://api.github.com/users/octokitten/following{/other_user} + gists_url: https://api.github.com/users/octokitten/gists{/gist_id} + starred_url: https://api.github.com/users/octokitten/starred{/owner}{/repo} + subscriptions_url: https://api.github.com/users/octokitten/subscriptions + organizations_url: https://api.github.com/users/octokitten/orgs + repos_url: https://api.github.com/users/octokitten/repos + events_url: https://api.github.com/users/octokitten/events{/privacy} + received_events_url: https://api.github.com/users/octokitten/received_events + type: User + site_admin: false headers: - Link: *37 - '500': *39 + Link: *50 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -23769,7 +22794,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: - - *89 + - *83 requestBody: content: application/json: @@ -23811,7 +22836,7 @@ paths: default: value: seats_created: 5 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -23847,7 +22872,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: - - *89 + - *83 requestBody: content: application/json: @@ -23889,7 +22914,7 @@ paths: default: value: seats_cancelled: 5 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -23927,7 +22952,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: - - *89 + - *83 requestBody: content: application/json: @@ -23968,7 +22993,7 @@ paths: default: value: seats_created: 5 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -24004,7 +23029,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: - - *89 + - *83 requestBody: content: application/json: @@ -24046,7 +23071,7 @@ paths: default: value: seats_cancelled: 5 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -24085,7 +23110,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *89 + - *83 - 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`). @@ -24117,13 +23142,430 @@ paths: application/json: schema: type: array - items: *52 + items: &221 + title: Copilot Usage Metrics + description: Copilot usage metrics for a given day. + type: object + properties: + date: + type: string + format: date + description: The date for which the usage metrics are aggregated, + in `YYYY-MM-DD` format. + total_active_users: + type: integer + description: The total number of Copilot users with activity + belonging to any Copilot feature, globally, for the given + day. Includes passive activity such as receiving a code suggestion, + as well as engagement activity such as accepting a code suggestion + or prompting chat. Does not include authentication events. + Is not limited to the individual features detailed on the + endpoint. + total_engaged_users: + type: integer + description: The total number of Copilot users who engaged with + any Copilot feature, for the given day. Examples include but + are not limited to accepting a code suggestion, prompting + Copilot chat, or triggering a PR Summary. Does not include + authentication events. Is not limited to the individual features + detailed on the endpoint. + copilot_ide_code_completions: + type: + - object + - 'null' + description: Usage metrics for Copilot editor code completions + in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Number of users who accepted at least one Copilot + code suggestion, across all active editors. Includes both + full and partial acceptances. + languages: + type: array + description: Code completion metrics for active languages. + items: + type: object + description: Usage metrics for a given language for the + given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used for Copilot + code completion suggestions. + total_engaged_users: + type: integer + description: Number of users who accepted at least + one Copilot code completion suggestion for the given + language. Includes both full and partial acceptances. + editors: + type: array + items: + type: object + description: Copilot code completion metrics for active + editors. + additionalProperties: true + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted at least + one Copilot code completion suggestion for the given + editor. Includes both full and partial acceptances. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot + code completion suggestions. If the default + model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_engaged_users: + type: integer + description: Number of users who accepted at + least one Copilot code completion suggestion + for the given editor, for the given language + and model. Includes both full and partial + acceptances. + languages: + type: array + description: Code completion metrics for active + languages, for the given editor. + items: + type: object + description: Usage metrics for a given language + for the given editor for Copilot code completions. + properties: + name: + type: string + description: Name of the language used + for Copilot code completion suggestions, + for the given editor. + total_engaged_users: + type: integer + description: Number of users who accepted + at least one Copilot code completion + suggestion for the given editor, for + the given language. Includes both full + and partial acceptances. + total_code_suggestions: + type: integer + description: The number of Copilot code + suggestions generated for the given + editor, for the given language. + total_code_acceptances: + type: integer + description: The number of Copilot code + suggestions accepted for the given editor, + for the given language. Includes both + full and partial acceptances. + total_code_lines_suggested: + type: integer + description: The number of lines of code + suggested by Copilot code completions + for the given editor, for the given + language. + total_code_lines_accepted: + type: integer + description: The number of lines of code + accepted from Copilot code suggestions + for the given editor, for the given + language. + copilot_ide_chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in the IDE. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat in the IDE. + editors: + type: array + items: + type: object + description: Copilot Chat metrics, for active editors. + properties: + name: + type: string + description: Name of the given editor. + total_engaged_users: + type: integer + description: The number of users who prompted Copilot + Chat in the specified editor. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot + code completion suggestions. If the default + model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_engaged_users: + type: integer + description: The number of users who prompted + Copilot Chat in the given editor and model. + total_chats: + type: integer + description: The total number of chats initiated + by users in the given editor and model. + total_chat_insertion_events: + type: integer + description: The number of times users accepted + a code suggestion from Copilot Chat using + the 'Insert Code' UI element, for the given + editor. + total_chat_copy_events: + type: integer + description: The number of times users copied + a code suggestion from Copilot Chat using + the keyboard, or the 'Copy' UI element, for + the given editor. + copilot_dotcom_chat: + type: + - object + - 'null' + description: Usage metrics for Copilot Chat in github.com + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat on github.com at least once. + models: + type: array + description: List of model metrics for a custom models and + the default model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot code + completion suggestions. If the default model is + used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom or + default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom model + (if applicable). + total_engaged_users: + type: integer + description: Total number of users who prompted Copilot + Chat on github.com at least once for each model. + total_chats: + type: integer + description: Total number of chats initiated by users + on github.com. + copilot_dotcom_pull_requests: + type: + - object + - 'null' + description: Usage metrics for Copilot for pull requests. + additionalProperties: true + properties: + total_engaged_users: + type: integer + description: The number of users who used Copilot for Pull + Requests on github.com to generate a pull request summary + at least once. + repositories: + type: array + description: Repositories in which users used Copilot for + Pull Requests to generate pull request summaries + items: + type: object + properties: + name: + type: string + description: Repository name + total_engaged_users: + type: integer + description: The number of users who generated pull + request summaries using Copilot for Pull Requests + in the given repository. + models: + type: array + description: List of model metrics for custom models + and the default model. + items: + type: object + properties: + name: + type: string + description: Name of the model used for Copilot + code completion suggestions. If the default + model is used will appear as 'default'. + is_custom_model: + type: boolean + description: Indicates whether a model is custom + or default. + custom_model_training_date: + type: + - string + - 'null' + description: The training date for the custom + model. + total_pr_summaries_created: + type: integer + description: The number of pull request summaries + generated using Copilot for Pull Requests + in the given repository. + total_engaged_users: + type: integer + description: The number of users who generated + pull request summaries using Copilot for Pull + Requests in the given repository and model. + required: + - date + additionalProperties: true examples: - default: *53 - '500': *39 + default: &222 + 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': *127 '403': *27 '404': *6 - '422': *54 + '422': &223 + 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 @@ -24154,7 +23596,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: - - *89 + - *83 - 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`). @@ -24186,10 +23628,159 @@ paths: application/json: schema: type: array - items: *55 + items: &224 + title: Copilot Usage Metrics + description: Summary of Copilot usage. + type: object + properties: + day: + type: string + format: date + description: The date for which the usage metrics are reported, + in `YYYY-MM-DD` format. + total_suggestions_count: + type: integer + description: The total number of Copilot code completion suggestions + shown to users. + total_acceptances_count: + type: integer + description: The total number of Copilot code completion suggestions + accepted by users. + total_lines_suggested: + type: integer + description: The total number of lines of code completions suggested + by Copilot. + total_lines_accepted: + type: integer + description: The total number of lines of code completions accepted + by users. + total_active_users: + type: integer + description: The total number of users who were shown Copilot + code completion suggestions during the day specified. + total_chat_acceptances: + type: integer + description: The total instances of users who accepted code + suggested by Copilot Chat in the IDE (panel and inline). + total_chat_turns: + type: integer + description: The total number of chat turns (prompt and response + pairs) sent between users and Copilot Chat in the IDE. + total_active_chat_users: + type: integer + description: The total number of users who interacted with Copilot + Chat in the IDE during the day specified. + breakdown: + type: + - array + - 'null' + description: Breakdown of Copilot code completions usage by + language and editor + items: + type: object + description: Breakdown of Copilot usage by editor for this + language + additionalProperties: true + properties: + language: + type: string + description: The language in which Copilot suggestions + were shown to users in the specified editor. + editor: + type: string + description: The editor in which Copilot suggestions were + shown to users for the specified language. + suggestions_count: + type: integer + description: The number of Copilot suggestions shown to + users in the editor specified during the day specified. + acceptances_count: + type: integer + description: The number of Copilot suggestions accepted + by users in the editor specified during the day specified. + lines_suggested: + type: integer + description: The number of lines of code suggested by + Copilot in the editor specified during the day specified. + lines_accepted: + type: integer + description: The number of lines of code accepted by users + in the editor specified during the day specified. + active_users: + type: integer + description: The number of users who were shown Copilot + completion suggestions in the editor specified during + the day specified. + required: + - day + - breakdown + additionalProperties: false examples: - default: *136 - '500': *39 + default: &225 + value: + - day: '2023-10-15' + total_suggestions_count: 1000 + total_acceptances_count: 800 + total_lines_suggested: 1800 + total_lines_accepted: 1200 + total_active_users: 10 + total_chat_acceptances: 32 + total_chat_turns: 200 + total_active_chat_users: 4 + breakdown: + - language: python + editor: vscode + suggestions_count: 300 + acceptances_count: 250 + lines_suggested: 900 + lines_accepted: 700 + active_users: 5 + - language: python + editor: jetbrains + suggestions_count: 300 + acceptances_count: 200 + lines_suggested: 400 + lines_accepted: 300 + active_users: 2 + - language: ruby + editor: vscode + suggestions_count: 400 + acceptances_count: 350 + lines_suggested: 500 + lines_accepted: 200 + active_users: 3 + - day: '2023-10-16' + total_suggestions_count: 800 + total_acceptances_count: 600 + total_lines_suggested: 1100 + total_lines_accepted: 700 + total_active_users: 12 + total_chat_acceptances: 57 + total_chat_turns: 426 + total_active_chat_users: 8 + breakdown: + - language: python + editor: vscode + suggestions_count: 300 + acceptances_count: 200 + lines_suggested: 600 + lines_accepted: 300 + active_users: 2 + - language: python + editor: jetbrains + suggestions_count: 300 + acceptances_count: 150 + lines_suggested: 300 + lines_accepted: 250 + active_users: 6 + - language: ruby + editor: vscode + suggestions_count: 200 + acceptances_count: 150 + lines_suggested: 200 + lines_accepted: 150 + active_users: 3 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -24214,18 +23805,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *89 + - *83 + - *130 + - *131 + - *132 + - *133 + - *134 + - *135 + - *37 + - *38 + - *39 + - *136 - *137 - - *138 - - *139 - - *140 - - *141 - - *142 - - *40 - - *41 - - *42 - - *143 - - *144 - *17 responses: '200': @@ -24234,9 +23825,9 @@ paths: application/json: schema: type: array - items: *145 + items: *138 examples: - default: *146 + default: *139 '304': *35 '400': *14 '403': *27 @@ -24262,7 +23853,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-organization-secrets parameters: - - *89 + - *83 - *17 - *18 responses: @@ -24280,7 +23871,7 @@ paths: type: integer secrets: type: array - items: &147 + items: &140 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -24332,7 +23923,7 @@ paths: visibility: selected selected_repositories_url: https://api.github.com/orgs/octo-org/dependabot/secrets/SUPER_SECRET/repositories headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24353,13 +23944,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-public-key parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &387 + schema: &386 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -24378,7 +23969,7 @@ paths: - key_id - key examples: - default: &388 + default: &387 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -24401,14 +23992,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 responses: '200': description: Response content: application/json: - schema: *147 + schema: *140 examples: default: value: @@ -24436,8 +24027,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 requestBody: required: true content: @@ -24492,7 +24083,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -24516,8 +24107,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 responses: '204': description: Response @@ -24541,8 +24132,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - *18 - *17 responses: @@ -24560,9 +24151,9 @@ paths: type: integer repositories: type: array - items: *108 + items: *102 examples: - default: *120 + default: *114 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -24583,8 +24174,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 requestBody: required: true content: @@ -24634,8 +24225,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#add-selected-repository-to-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - name: repository_id in: path required: true @@ -24666,8 +24257,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret parameters: - - *89 - - *116 + - *83 + - *110 - name: repository_id in: path required: true @@ -24697,7 +24288,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: - - *89 + - *83 responses: '200': description: Response @@ -24705,7 +24296,7 @@ paths: application/json: schema: type: array - items: &189 + items: &183 title: Package description: A software package type: object @@ -24758,7 +24349,7 @@ paths: repository: anyOf: - type: 'null' - - *108 + - *102 created_at: type: string format: date-time @@ -24776,7 +24367,7 @@ paths: - created_at - updated_at examples: - default: &190 + default: &184 value: - id: 197 name: hello_docker @@ -24854,7 +24445,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-organization-events parameters: - - *89 + - *83 - *17 - *18 responses: @@ -24864,7 +24455,7 @@ paths: application/json: schema: type: array - items: *83 + items: *78 examples: 200-response: value: @@ -24933,7 +24524,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-failed-organization-invitations parameters: - - *89 + - *83 - *17 - *18 responses: @@ -24943,7 +24534,7 @@ paths: application/json: schema: type: array - items: &170 + items: &163 title: Organization Invitation description: Organization Invitation type: object @@ -24997,7 +24588,7 @@ paths: - invitation_teams_url - node_id examples: - default: &171 + default: &164 value: - id: 1 login: monalisa @@ -25030,7 +24621,7 @@ paths: invitation_teams_url: https://api.github.com/organizations/2/invitations/1/teams invitation_source: member headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -25054,7 +24645,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-organization-webhooks parameters: - - *89 + - *83 - *17 - *18 responses: @@ -25064,7 +24655,7 @@ paths: application/json: schema: type: array - items: &148 + items: &141 title: Org Hook description: Org Hook type: object @@ -25164,7 +24755,7 @@ paths: created_at: '2011-09-06T17:26:27Z' type: Organization headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -25187,7 +24778,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#create-an-organization-webhook parameters: - - *89 + - *83 requestBody: required: true content: @@ -25249,9 +24840,9 @@ paths: description: Response content: application/json: - schema: *148 + schema: *141 examples: - default: &149 + default: &142 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -25298,8 +24889,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-an-organization-webhook parameters: - - *89 - - &150 + - *83 + - &143 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. @@ -25312,9 +24903,9 @@ paths: description: Response content: application/json: - schema: *148 + schema: *141 examples: - default: *149 + default: *142 '404': *6 x-github: githubCloudOnly: false @@ -25341,8 +24932,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-an-organization-webhook parameters: - - *89 - - *150 + - *83 + - *143 requestBody: required: false content: @@ -25388,7 +24979,7 @@ paths: description: Response content: application/json: - schema: *148 + schema: *141 examples: default: value: @@ -25429,8 +25020,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *89 - - *150 + - *83 + - *143 responses: '204': description: Response @@ -25457,8 +25048,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-configuration-for-an-organization parameters: - - *89 - - *150 + - *83 + - *143 responses: '200': description: Response @@ -25488,8 +25079,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization parameters: - - *89 - - *150 + - *83 + - *143 requestBody: required: false content: @@ -25539,10 +25130,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *89 - - *150 + - *83 + - *143 - *17 - - *151 + - *144 responses: '200': description: Response @@ -25550,9 +25141,9 @@ paths: application/json: schema: type: array - items: *152 + items: *145 examples: - default: *153 + default: *146 '400': *14 '422': *15 x-github: @@ -25577,17 +25168,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#get-a-webhook-delivery-for-an-organization-webhook parameters: - - *89 - - *150 + - *83 + - *143 - *16 responses: '200': description: Response content: application/json: - schema: *154 + schema: *147 examples: - default: *155 + default: *148 '400': *14 '422': *15 x-github: @@ -25612,11 +25203,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#redeliver-a-delivery-for-an-organization-webhook parameters: - - *89 - - *150 + - *83 + - *143 - *16 responses: - '202': *94 + '202': *88 '400': *14 '422': *15 x-github: @@ -25642,8 +25233,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *89 - - *150 + - *83 + - *143 responses: '204': description: Response @@ -25665,8 +25256,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *89 - - &160 + - *83 + - &153 name: actor_type in: path description: The type of the actor @@ -25679,14 +25270,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &161 + - &154 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &156 + - &149 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -25694,7 +25285,7 @@ paths: required: true schema: type: string - - &157 + - &150 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -25705,7 +25296,7 @@ paths: type: string - *18 - *17 - - *40 + - *37 - name: sort description: The property to sort the results by. in: query @@ -25788,13 +25379,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-subject-stats parameters: - - *89 - - *156 - - *157 + - *83 + - *149 + - *150 - *18 - *17 - - *40 - - &166 + - *37 + - &159 name: sort description: The property to sort the results by. in: query @@ -25873,15 +25464,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats parameters: - - *89 - - *156 - - *157 + - *83 + - *149 + - *150 responses: '200': description: Response content: application/json: - schema: &158 + schema: &151 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -25897,7 +25488,7 @@ paths: type: integer format: int64 examples: - default: &159 + default: &152 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -25917,24 +25508,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *89 - - &162 + - *83 + - &155 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *156 - - *157 + - *149 + - *150 responses: '200': description: Response content: application/json: - schema: *158 + schema: *151 examples: - default: *159 + default: *152 x-github: enabledForGitHubApps: true category: orgs @@ -25952,19 +25543,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *89 - - *156 - - *157 - - *160 - - *161 + - *83 + - *149 + - *150 + - *153 + - *154 responses: '200': description: Response content: application/json: - schema: *158 + schema: *151 examples: - default: *159 + default: *152 x-github: enabledForGitHubApps: true category: orgs @@ -25981,10 +25572,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats parameters: - - *89 - - *156 - - *157 - - &163 + - *83 + - *149 + - *150 + - &156 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -25997,7 +25588,7 @@ paths: description: Response content: application/json: - schema: &164 + schema: &157 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -26013,7 +25604,7 @@ paths: type: integer format: int64 examples: - default: &165 + default: &158 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -26049,19 +25640,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-user parameters: - - *89 - - *162 + - *83 + - *155 + - *149 + - *150 - *156 - - *157 - - *163 responses: '200': description: Response content: application/json: - schema: *164 + schema: *157 examples: - default: *165 + default: *158 x-github: enabledForGitHubApps: true category: orgs @@ -26078,20 +25669,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *89 - - *160 - - *161 + - *83 + - *153 + - *154 + - *149 + - *150 - *156 - - *157 - - *163 responses: '200': description: Response content: application/json: - schema: *164 + schema: *157 examples: - default: *165 + default: *158 x-github: enabledForGitHubApps: true category: orgs @@ -26108,14 +25699,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/api-insights#get-user-stats parameters: - - *89 - - *162 - - *156 - - *157 + - *83 + - *155 + - *149 + - *150 - *18 - *17 - - *40 - - *166 + - *37 + - *159 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -26191,7 +25782,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - - *89 + - *83 responses: '200': description: Response @@ -26199,7 +25790,7 @@ paths: application/json: schema: *20 examples: - default: &426 + default: &425 value: id: 1 account: @@ -26268,7 +25859,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *89 + - *83 - *17 - *18 responses: @@ -26338,7 +25929,7 @@ paths: suspended_at: suspended_by: headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26357,7 +25948,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response @@ -26365,12 +25956,12 @@ paths: application/json: schema: anyOf: - - &168 + - &161 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &167 + limit: &160 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -26398,7 +25989,7 @@ paths: properties: {} additionalProperties: false examples: - default: &169 + default: &162 value: limit: collaborators_only origin: organization @@ -26422,18 +26013,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *89 + - *83 requestBody: required: true content: application/json: - schema: &427 + schema: &426 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *167 + limit: *160 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -26458,9 +26049,9 @@ paths: description: Response content: application/json: - schema: *168 + schema: *161 examples: - default: *169 + default: *162 '422': *15 x-github: githubCloudOnly: false @@ -26478,7 +26069,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *89 + - *83 responses: '204': description: Response @@ -26502,7 +26093,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-pending-organization-invitations parameters: - - *89 + - *83 - *17 - *18 - name: role @@ -26536,11 +26127,11 @@ paths: application/json: schema: type: array - items: *170 + items: *163 examples: - default: *171 + default: *164 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -26561,7 +26152,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#create-an-organization-invitation parameters: - - *89 + - *83 requestBody: required: false content: @@ -26615,7 +26206,7 @@ paths: description: Response content: application/json: - schema: *170 + schema: *163 examples: default: value: @@ -26669,8 +26260,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#cancel-an-organization-invitation parameters: - - *89 - - &172 + - *83 + - &165 name: invitation_id description: The unique identifier of the invitation. in: path @@ -26700,8 +26291,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-invitation-teams parameters: - - *89 - - *172 + - *83 + - *165 - *17 - *18 responses: @@ -26711,9 +26302,9 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - default: &188 + default: &182 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -26729,7 +26320,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -26758,7 +26349,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - - *89 + - *83 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -26788,7 +26379,7 @@ paths: - closed - all default: open - - *174 + - *167 - name: sort description: What to sort results by. in: query @@ -26800,8 +26391,8 @@ paths: - updated - comments default: created - - *40 - - *62 + - *37 + - *57 - *17 - *18 responses: @@ -26811,11 +26402,11 @@ paths: application/json: schema: type: array - items: *72 + items: *67 examples: - default: *175 + default: *168 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -26835,7 +26426,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-organization-members parameters: - - *89 + - *83 - 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) @@ -26871,9 +26462,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 '422': *15 x-github: githubCloudOnly: false @@ -26891,8 +26482,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-organization-membership-for-a-user parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response if requester is an organization member and user is @@ -26923,8 +26514,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-an-organization-member parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response @@ -26950,8 +26541,8 @@ paths: parameters: - *17 - *18 - - *89 - - *121 + - *83 + - *115 responses: '200': description: Response @@ -26967,11 +26558,11 @@ paths: type: integer codespaces: type: array - items: *177 + items: *170 examples: - default: *178 + default: *171 '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -26994,9 +26585,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *89 - - *121 - - &179 + - *83 + - *115 + - &172 name: codespace_name in: path required: true @@ -27004,9 +26595,9 @@ paths: schema: type: string responses: - '202': *94 + '202': *88 '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -27029,17 +26620,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/organizations#stop-a-codespace-for-an-organization-user parameters: - - *89 - - *121 - - *179 + - *83 + - *115 + - *172 responses: '200': description: Response content: application/json: - schema: *177 + schema: *170 examples: - default: &358 + default: &357 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -27181,7 +26772,7 @@ paths: recent_folders: [] template: '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -27212,14 +26803,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: - - *89 - - *121 + - *83 + - *115 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *134 + schema: *173 examples: default: value: @@ -27262,7 +26853,7 @@ paths: members_url: https://api.github.com/teams/1/members{/member} repositories_url: https://api.github.com/teams/1/repos parent: - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -27287,14 +26878,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-organization-membership-for-a-user parameters: - - *89 - - *121 + - *83 + - *115 responses: '200': description: Response content: application/json: - schema: &180 + schema: &174 title: Org Membership description: Org Membership type: object @@ -27327,7 +26918,7 @@ paths: format: uri examples: - https://api.github.com/orgs/octocat - organization: *88 + organization: *129 user: anyOf: - type: 'null' @@ -27347,7 +26938,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &181 + response-if-user-has-an-active-admin-membership-with-organization: &175 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -27415,8 +27006,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-organization-membership-for-a-user parameters: - - *89 - - *121 + - *83 + - *115 requestBody: required: false content: @@ -27444,9 +27035,9 @@ paths: description: Response content: application/json: - schema: *180 + schema: *174 examples: - response-if-user-already-had-membership-with-organization: *181 + response-if-user-already-had-membership-with-organization: *175 '422': *15 '403': *27 x-github: @@ -27467,8 +27058,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response @@ -27493,7 +27084,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-organization-migrations parameters: - - *89 + - *83 - *17 - *18 - name: exclude @@ -27515,7 +27106,7 @@ paths: application/json: schema: type: array - items: &182 + items: &176 title: Migration description: A migration. type: object @@ -27557,7 +27148,7 @@ paths: type: array description: The repositories included in the migration. Only returned for export migrations. - items: *57 + items: *52 url: type: string format: uri @@ -27756,7 +27347,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -27772,7 +27363,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#start-an-organization-migration parameters: - - *89 + - *83 requestBody: required: true content: @@ -27853,7 +27444,7 @@ paths: description: Response content: application/json: - schema: *182 + schema: *176 examples: default: value: @@ -28031,8 +27622,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#get-an-organization-migration-status parameters: - - *89 - - &183 + - *83 + - &177 name: migration_id description: The unique identifier of the migration. in: path @@ -28060,7 +27651,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *182 + schema: *176 examples: default: value: @@ -28229,8 +27820,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *89 - - *183 + - *83 + - *177 responses: '302': description: Response @@ -28251,8 +27842,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *89 - - *183 + - *83 + - *177 responses: '204': description: Response @@ -28275,9 +27866,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#unlock-an-organization-repository parameters: - - *89 - - *183 - - &568 + - *83 + - *177 + - &567 name: repo_name description: repo_name parameter in: path @@ -28304,8 +27895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *89 - - *183 + - *83 + - *177 - *17 - *18 responses: @@ -28315,9 +27906,9 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: &195 + default: &189 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -28428,7 +28019,7 @@ paths: secret_scanning_non_provider_patterns: status: disabled headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -28454,7 +28045,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-all-organization-roles-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response - list of organization roles @@ -28470,7 +28061,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &186 + items: &180 title: Organization Role description: Organization roles type: object @@ -28619,8 +28210,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-team parameters: - - *89 - - *184 + - *83 + - &178 + name: team_slug + description: The slug of the team name. + in: path + required: true + schema: + type: string responses: '204': description: Response @@ -28645,9 +28242,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-team parameters: - - *89 - - *184 - - &185 + - *83 + - *178 + - &179 name: role_id description: The unique identifier of the role. in: path @@ -28682,9 +28279,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-team parameters: - - *89 - - *184 - - *185 + - *83 + - *178 + - *179 responses: '204': description: Response @@ -28709,8 +28306,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-all-organization-roles-for-a-user parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response @@ -28735,9 +28332,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#assign-an-organization-role-to-a-user parameters: - - *89 - - *121 - - *185 + - *83 + - *115 + - *179 responses: '204': description: Response @@ -28767,9 +28364,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#remove-an-organization-role-from-a-user parameters: - - *89 - - *121 - - *185 + - *83 + - *115 + - *179 responses: '204': description: Response @@ -28797,14 +28394,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/organization-roles#get-an-organization-role parameters: - - *89 - - *185 + - *83 + - *179 responses: '200': description: Response content: application/json: - schema: *186 + schema: *180 examples: default: value: @@ -28854,8 +28451,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: - - *89 - - *185 + - *83 + - *179 - *17 - *18 responses: @@ -28934,7 +28531,7 @@ paths: parent: anyOf: - type: 'null' - - *187 + - *181 required: - id - node_id @@ -28948,9 +28545,9 @@ paths: - slug - parent examples: - default: *188 + default: *182 headers: - Link: *37 + Link: *50 '404': description: Response if the organization or role does not exist. '422': @@ -28977,8 +28574,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: - - *89 - - *185 + - *83 + - *179 - *17 - *18 responses: @@ -29007,7 +28604,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *187 + items: *181 name: type: - string @@ -29124,9 +28721,9 @@ paths: - type - url examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 '404': description: Response if the organization or role does not exist. '422': @@ -29148,7 +28745,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#list-outside-collaborators-for-an-organization parameters: - - *89 + - *83 - 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) @@ -29172,9 +28769,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29197,8 +28794,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#convert-an-organization-member-to-outside-collaborator parameters: - - *89 - - *121 + - *83 + - *115 requestBody: required: false content: @@ -29255,8 +28852,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/outside-collaborators#remove-outside-collaborator-from-an-organization parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response @@ -29313,8 +28910,8 @@ paths: - docker - nuget - container - - *89 - - &570 + - *83 + - &569 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -29350,12 +28947,12 @@ paths: application/json: schema: type: array - items: *189 + items: *183 examples: - default: *190 + default: *184 '403': *27 '401': *23 - '400': &572 + '400': &571 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -29377,7 +28974,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-an-organization parameters: - - &191 + - &185 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 @@ -29395,20 +28992,20 @@ paths: - docker - nuget - container - - &192 + - &186 name: package_name description: The name of the package. in: path required: true schema: type: string - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: *189 + schema: *183 examples: default: value: @@ -29460,9 +29057,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-an-organization parameters: - - *191 - - *192 - - *89 + - *185 + - *186 + - *83 responses: '204': description: Response @@ -29494,9 +29091,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-an-organization parameters: - - *191 - - *192 - - *89 + - *185 + - *186 + - *83 - name: token description: package token schema: @@ -29528,9 +29125,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: - - *191 - - *192 - - *89 + - *185 + - *186 + - *83 - *18 - *17 - name: state @@ -29550,7 +29147,7 @@ paths: application/json: schema: type: array - items: &193 + items: &187 title: Package Version description: A version of a software package type: object @@ -29685,10 +29282,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-an-organization parameters: - - *191 - - *192 - - *89 - - &194 + - *185 + - *186 + - *83 + - &188 name: package_version_id description: Unique identifier of the package version. in: path @@ -29700,7 +29297,7 @@ paths: description: Response content: application/json: - schema: *193 + schema: *187 examples: default: value: @@ -29736,10 +29333,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-an-organization parameters: - - *191 - - *192 - - *89 - - *194 + - *185 + - *186 + - *83 + - *188 responses: '204': description: Response @@ -29771,10 +29368,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-an-organization parameters: - - *191 - - *192 - - *89 - - *194 + - *185 + - *186 + - *83 + - *188 responses: '204': description: Response @@ -29801,10 +29398,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: - - *89 + - *83 - *17 - *18 - - &196 + - &190 name: sort description: The property by which to sort the results. in: query @@ -29814,8 +29411,8 @@ paths: enum: - created_at default: created_at - - *40 - - &197 + - *37 + - &191 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -29827,7 +29424,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &198 + - &192 name: repository description: The name of the repository to use to filter the results. in: query @@ -29836,7 +29433,7 @@ paths: type: string examples: - Hello-World - - &199 + - &193 name: permission description: The permission to use to filter the results. in: query @@ -29845,7 +29442,7 @@ paths: type: string examples: - issues_read - - &200 + - &194 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) @@ -29855,7 +29452,7 @@ paths: schema: type: string format: date-time - - &201 + - &195 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) @@ -29866,7 +29463,7 @@ paths: type: string format: date-time responses: - '500': *39 + '500': *127 '422': *15 '404': *6 '403': *27 @@ -30001,7 +29598,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30021,7 +29618,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: - - *89 + - *83 requestBody: required: true content: @@ -30063,11 +29660,11 @@ paths: action: deny reason: Access is too broad. responses: - '500': *39 + '500': *127 '422': *15 '404': *6 '403': *27 - '202': *94 + '202': *88 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30088,7 +29685,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: - - *89 + - *83 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -30125,11 +29722,11 @@ paths: action: deny reason: This request is denied because the access is too broad. responses: - '500': *39 + '500': *127 '422': *15 '404': *6 '403': *27 - '204': *132 + '204': *126 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30150,7 +29747,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: - - *89 + - *83 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -30161,7 +29758,7 @@ paths: - *17 - *18 responses: - '500': *39 + '500': *127 '404': *6 '403': *27 '200': @@ -30170,11 +29767,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30195,18 +29792,18 @@ 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: - - *89 + - *83 - *17 - *18 - - *196 - - *40 - - *197 - - *198 - - *199 - - *200 - - *201 + - *190 + - *37 + - *191 + - *192 + - *193 + - *194 + - *195 responses: - '500': *39 + '500': *127 '422': *15 '404': *6 '403': *27 @@ -30335,7 +29932,7 @@ paths: token_expires_at: '2023-11-16T08:47:09.000-07:00' token_last_used_at: headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30355,7 +29952,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: - - *89 + - *83 requestBody: required: true content: @@ -30390,9 +29987,9 @@ paths: - 1296269 - 1296280 responses: - '500': *39 + '500': *127 '404': *6 - '202': *94 + '202': *88 '403': *27 '422': *15 x-github: @@ -30415,7 +30012,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: - - *89 + - *83 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -30443,9 +30040,9 @@ paths: value: action: revoke responses: - '500': *39 + '500': *127 '404': *6 - '204': *132 + '204': *126 '403': *27 '422': *15 x-github: @@ -30467,7 +30064,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: - - *89 + - *83 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -30477,7 +30074,7 @@ paths: - *17 - *18 responses: - '500': *39 + '500': *127 '404': *6 '403': *27 '200': @@ -30486,11 +30083,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -30510,7 +30107,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-organization-projects parameters: - - *89 + - *83 - name: state description: Indicates the state of the projects to return. in: query @@ -30531,7 +30128,7 @@ paths: application/json: schema: type: array - items: &202 + items: &196 title: Project description: Projects are a way to organize columns and cards of work. @@ -30664,7 +30261,7 @@ paths: organization_permission: write private: true headers: - Link: *37 + Link: *50 '422': *7 x-github: githubCloudOnly: false @@ -30684,7 +30281,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#create-an-organization-project parameters: - - *89 + - *83 requestBody: required: true content: @@ -30710,7 +30307,7 @@ paths: description: Response content: application/json: - schema: *202 + schema: *196 examples: default: value: @@ -30748,7 +30345,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': &251 + '410': &250 description: Gone content: application/json: @@ -30772,7 +30369,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-all-custom-properties-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response @@ -30780,7 +30377,7 @@ paths: application/json: schema: type: array - items: &203 + items: &197 title: Organization Custom Property description: Custom property defined on an organization type: object @@ -30856,7 +30453,7 @@ paths: - property_name - value_type examples: - default: &204 + default: &198 value: - property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -30900,7 +30497,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-custom-properties-for-an-organization parameters: - - *89 + - *83 requestBody: required: true content: @@ -30911,7 +30508,7 @@ paths: properties: type: array description: The array of custom properties to create or update. - items: *203 + items: *197 minItems: 1 maxItems: 100 required: @@ -30941,9 +30538,9 @@ paths: application/json: schema: type: array - items: *203 + items: *197 examples: - default: *204 + default: *198 '403': *27 '404': *6 x-github: @@ -30964,8 +30561,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#get-a-custom-property-for-an-organization parameters: - - *89 - - &205 + - *83 + - &199 name: custom_property_name description: The custom property name in: path @@ -30977,9 +30574,9 @@ paths: description: Response content: application/json: - schema: *203 + schema: *197 examples: - default: &206 + default: &200 value: property_name: environment url: https://api.github.com/orgs/github/properties/schema/environment @@ -31013,13 +30610,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *89 - - *205 + - *83 + - *199 requestBody: required: true content: application/json: schema: + title: Custom Property Set Payload + description: Custom property set payload type: object properties: value_type: @@ -31079,9 +30678,9 @@ paths: description: Response content: application/json: - schema: *203 + schema: *197 examples: - default: *206 + default: *200 '403': *27 '404': *6 x-github: @@ -31104,10 +30703,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#remove-a-custom-property-for-an-organization parameters: - - *89 - - *205 + - *83 + - *199 responses: - '204': *132 + '204': *126 '403': *27 '404': *6 x-github: @@ -31128,7 +30727,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/custom-properties#list-custom-property-values-for-organization-repositories parameters: - - *89 + - *83 - *17 - *18 - name: repository_query @@ -31169,7 +30768,7 @@ paths: - octocat/Hello-World properties: type: array - items: &207 + items: &201 title: Custom Property Value description: Custom property name and associated value type: object @@ -31211,7 +30810,7 @@ paths: - property_name: team value: octocat headers: - Link: *37 + Link: *50 '403': *27 '404': *6 x-github: @@ -31239,7 +30838,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: - - *89 + - *83 requestBody: required: true content: @@ -31259,7 +30858,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *207 + items: *201 required: - repository_names - properties @@ -31300,7 +30899,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#list-public-organization-members parameters: - - *89 + - *83 - *17 - *18 responses: @@ -31312,9 +30911,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31331,8 +30930,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#check-public-organization-membership-for-a-user parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response if user is a public member @@ -31356,8 +30955,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response @@ -31378,8 +30977,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - - *89 - - *121 + - *83 + - *115 responses: '204': description: Response @@ -31403,7 +31002,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-organization-repositories parameters: - - *89 + - *83 - name: type description: Specifies the types of repositories you want returned. in: query @@ -31449,11 +31048,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -31472,7 +31071,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-organization-repository parameters: - - *89 + - *83 requestBody: required: true content: @@ -31654,7 +31253,7 @@ paths: description: Response content: application/json: - schema: &253 + schema: &252 title: Full Repository description: Full Repository type: object @@ -32000,7 +31599,7 @@ paths: template_repository: anyOf: - type: 'null' - - *57 + - *52 temp_clone_token: type: - string @@ -32100,13 +31699,13 @@ paths: license: anyOf: - type: 'null' - - *73 + - *68 organization: anyOf: - type: 'null' - *4 - parent: *57 - source: *57 + parent: *52 + source: *52 forks: type: integer master_branch: @@ -32119,7 +31718,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &377 + code_of_conduct: &376 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -32149,7 +31748,7 @@ paths: - key - name - html_url - security_and_analysis: *208 + security_and_analysis: *202 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -32233,7 +31832,7 @@ paths: - network_count - subscribers_count examples: - default: &255 + default: &254 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -32751,10 +32350,10 @@ paths: category: orgs subcategory: rules parameters: - - *89 + - *83 - *17 - *18 - - &508 + - &507 name: targets description: | A comma-separated list of rule targets to filter by. @@ -32773,7 +32372,7 @@ paths: application/json: schema: type: array - items: &215 + items: &209 title: Repository ruleset type: object description: A set of rules to apply when specified conditions are @@ -32797,16 +32396,18 @@ paths: - branch - tag - push + - repository source_type: type: string description: The type of the source of the ruleset enum: - Repository - Organization + - Enterprise source: type: string description: The name of the source - enforcement: &211 + enforcement: &205 type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins @@ -32819,7 +32420,7 @@ paths: bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: &212 + items: &206 title: Repository Ruleset Bypass Actor type: object description: An actor that can bypass rules in a ruleset @@ -32885,7 +32486,7 @@ paths: description: The html URL of the ruleset conditions: anyOf: - - &209 + - &203 title: Repository ruleset conditions for ref names type: object description: Parameters for a repository ruleset ref name @@ -32909,20 +32510,21 @@ paths: match. items: type: string - - &213 + - &207 title: Organization ruleset conditions type: object description: |- Conditions for an organization ruleset. The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. The push rulesets conditions object does not require the `ref_name` property. + For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. oneOf: - type: object title: repository_name_and_ref_name description: Conditions to target repositories by name and refs by name allOf: - - *209 + - *203 - title: Repository ruleset conditions for repository names type: object description: Parameters for a repository name condition @@ -32956,7 +32558,7 @@ paths: description: Conditions to target repositories by id and refs by name allOf: - - *209 + - *203 - title: Repository ruleset conditions for repository IDs type: object description: Parameters for a repository ID condition @@ -32978,7 +32580,7 @@ paths: description: Conditions to target repositories by property and refs by name allOf: - - *209 + - *203 - title: Repository ruleset conditions for repository properties type: object description: Parameters for a repository property condition @@ -32991,7 +32593,7 @@ paths: description: The repository properties and values to include. All of these properties must match for the condition to pass. - items: &210 + items: &204 title: Repository ruleset property targeting definition type: object @@ -33024,7 +32626,7 @@ paths: description: The repository properties and values to exclude. The condition will not pass if any of these properties match. - items: *210 + items: *204 required: - repository_property type: @@ -33032,12 +32634,12 @@ paths: - object rules: type: array - items: &214 + items: &208 title: Repository Rule type: object description: A repository rule. oneOf: - - &490 + - &489 title: creation description: Only allow users with bypass permission to create matching refs. @@ -33049,7 +32651,7 @@ paths: type: string enum: - creation - - &491 + - &490 title: update description: Only allow users with bypass permission to update matching refs. @@ -33070,7 +32672,7 @@ paths: repository required: - update_allows_fetch_and_merge - - &493 + - &492 title: deletion description: Only allow users with bypass permissions to delete matching refs. @@ -33082,7 +32684,7 @@ paths: type: string enum: - deletion - - &494 + - &493 title: required_linear_history description: Prevent merge commits from being pushed to matching refs. @@ -33094,7 +32696,7 @@ paths: type: string enum: - required_linear_history - - &495 + - &494 title: merge_queue description: Merges must be performed via a merge queue. type: object @@ -33172,7 +32774,7 @@ paths: - merge_method - min_entries_to_merge - min_entries_to_merge_wait_minutes - - &496 + - &495 title: required_deployments description: Choose which environments must be successfully deployed to before refs can be pushed into a ref that @@ -33196,7 +32798,7 @@ paths: type: string required: - required_deployment_environments - - &497 + - &496 title: required_signatures description: Commits pushed to matching refs must have verified signatures. @@ -33208,7 +32810,7 @@ paths: type: string enum: - required_signatures - - &498 + - &497 title: pull_request description: Require all commits be made to a non-target branch and submitted via a pull request before they can @@ -33224,6 +32826,13 @@ paths: parameters: type: object properties: + allowed_merge_methods: + type: array + description: When merging pull requests, you can + allow any combination of merge commits, squashing, + or rebasing. At least one option must be enabled. + items: + type: string dismiss_stale_reviews_on_push: type: boolean description: New, reviewable commits pushed will @@ -33254,7 +32863,7 @@ paths: - require_last_push_approval - required_approving_review_count - required_review_thread_resolution - - &499 + - &498 title: required_status_checks description: Choose which status checks must pass before the ref is updated. When enabled, commits must first be @@ -33302,7 +32911,7 @@ paths: required: - required_status_checks - strict_required_status_checks_policy - - &500 + - &499 title: non_fast_forward description: Prevent users with push access from force pushing to refs. @@ -33314,7 +32923,7 @@ paths: type: string enum: - non_fast_forward - - &501 + - &500 title: commit_message_pattern description: Parameters to be used for the commit_message_pattern rule @@ -33350,7 +32959,7 @@ paths: required: - operator - pattern - - &502 + - &501 title: commit_author_email_pattern description: Parameters to be used for the commit_author_email_pattern rule @@ -33386,7 +32995,7 @@ paths: required: - operator - pattern - - &503 + - &502 title: committer_email_pattern description: Parameters to be used for the committer_email_pattern rule @@ -33422,7 +33031,7 @@ paths: required: - operator - pattern - - &504 + - &503 title: branch_name_pattern description: Parameters to be used for the branch_name_pattern rule @@ -33458,7 +33067,7 @@ paths: required: - operator - pattern - - &505 + - &504 title: tag_name_pattern description: Parameters to be used for the tag_name_pattern rule @@ -33584,7 +33193,7 @@ paths: maximum: 100 required: - max_file_size - - &506 + - &505 title: workflows description: Require all changes made to a targeted branch to pass the specified workflows before they can be merged. @@ -33634,7 +33243,7 @@ paths: - repository_id required: - workflows - - &507 + - &506 title: code_scanning description: Choose which tools must provide code scanning results before the reference is updated. When configured, @@ -33731,7 +33340,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *39 + '500': *127 post: summary: Create an organization repository ruleset description: Create a repository ruleset for an organization. @@ -33747,7 +33356,7 @@ paths: category: orgs subcategory: rules parameters: - - *89 + - *83 requestBody: description: Request body required: true @@ -33766,17 +33375,18 @@ paths: - branch - tag - push + - repository default: branch - enforcement: *211 + enforcement: *205 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *212 - conditions: *213 + items: *206 + conditions: *207 rules: type: array description: An array of rules within the ruleset. - items: *214 + items: *208 required: - name - enforcement @@ -33814,9 +33424,9 @@ paths: description: Response content: application/json: - schema: *215 + schema: *209 examples: - default: &216 + default: &210 value: id: 21 name: super cool ruleset @@ -33856,7 +33466,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *39 + '500': *127 "/orgs/{org}/rulesets/rule-suites": get: summary: List organization rule suites @@ -33870,8 +33480,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *89 - - &509 + - *83 + - &508 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 @@ -33886,7 +33496,7 @@ paths: in: query schema: type: string - - &510 + - &509 name: time_period description: |- The time period to filter by. @@ -33902,14 +33512,14 @@ paths: - week - month default: day - - &511 + - &510 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 - - &512 + - &511 name: rule_suite_result description: The rule results to filter on. When specified, only suites with this result will be returned. @@ -33929,7 +33539,7 @@ paths: description: Response content: application/json: - schema: &513 + schema: &512 title: Rule Suites description: Response type: array @@ -33985,7 +33595,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &514 + default: &513 value: - id: 21 actor_id: 12 @@ -34009,7 +33619,7 @@ paths: result: pass evaluation_result: fail '404': *6 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34028,8 +33638,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *89 - - &515 + - *83 + - &514 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -34045,7 +33655,7 @@ paths: description: Response content: application/json: - schema: &516 + schema: &515 title: Rule Suite description: Response type: object @@ -34152,7 +33762,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &517 + default: &516 value: id: 21 actor_id: 12 @@ -34187,7 +33797,7 @@ paths: result: fail rule_type: commit_message_pattern '404': *6 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34213,7 +33823,7 @@ paths: category: orgs subcategory: rules parameters: - - *89 + - *83 - name: ruleset_id description: The ID of the ruleset. in: path @@ -34225,11 +33835,11 @@ paths: description: Response content: application/json: - schema: *215 + schema: *209 examples: - default: *216 + default: *210 '404': *6 - '500': *39 + '500': *127 put: summary: Update an organization repository ruleset description: Update a ruleset for an organization. @@ -34245,7 +33855,7 @@ paths: category: orgs subcategory: rules parameters: - - *89 + - *83 - name: ruleset_id description: The ID of the ruleset. in: path @@ -34270,16 +33880,17 @@ paths: - branch - tag - push - enforcement: *211 + - repository + enforcement: *205 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *212 - conditions: *213 + items: *206 + conditions: *207 rules: description: An array of rules within the ruleset. type: array - items: *214 + items: *208 examples: default: value: @@ -34314,11 +33925,11 @@ paths: description: Response content: application/json: - schema: *215 + schema: *209 examples: - default: *216 + default: *210 '404': *6 - '500': *39 + '500': *127 delete: summary: Delete an organization repository ruleset description: Delete a ruleset for an organization. @@ -34334,7 +33945,7 @@ paths: category: orgs subcategory: rules parameters: - - *89 + - *83 - name: ruleset_id description: The ID of the ruleset. in: path @@ -34345,7 +33956,7 @@ paths: '204': description: Response '404': *6 - '500': *39 + '500': *127 "/orgs/{org}/secret-scanning/alerts": get: summary: List secret scanning alerts for an organization @@ -34362,15 +33973,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-organization parameters: - - *89 - - *217 - - *218 - - *219 - - *220 - - *40 + - *83 + - *211 + - *212 + - *213 + - *214 + - *37 - *18 - *17 - - &519 + - &518 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 @@ -34380,7 +33991,7 @@ paths: required: false schema: type: string - - &520 + - &519 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 @@ -34390,9 +34001,9 @@ paths: required: false schema: type: string - - *221 - - *222 - - *223 + - *215 + - *216 + - *217 responses: '200': description: Response @@ -34400,13 +34011,13 @@ paths: application/json: schema: type: array - items: *224 + items: *218 examples: - default: *225 + default: *219 headers: - Link: *37 + Link: *50 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -34428,8 +34039,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories-for-an-organization parameters: - - *89 - - *40 + - *83 + - *37 - name: sort description: The property to sort the results by. in: query @@ -34441,8 +34052,8 @@ paths: - updated - published default: created - - *41 - - *42 + - *38 + - *39 - name: per_page description: The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -34472,7 +34083,7 @@ paths: application/json: schema: type: array - items: &527 + items: &526 description: A repository security advisory. type: object properties: @@ -34680,7 +34291,7 @@ paths: required: - vector_string - score - cvss_severities: *44 + cvss_severities: *41 cwes: type: - array @@ -34716,7 +34327,7 @@ paths: login: type: string description: The username of the user credited. - type: *226 + type: *220 credits_detailed: type: - array @@ -34727,7 +34338,7 @@ paths: type: object properties: user: *4 - type: *226 + type: *220 state: type: string description: The state of the user's acceptance of the @@ -34753,13 +34364,13 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *173 + items: *166 private_fork: readOnly: true description: A temporary private fork of the advisory's repository for collaborating on a fix. allOf: - - *51 + - *49 type: - 'null' required: @@ -34791,7 +34402,7 @@ paths: - private_fork additionalProperties: false examples: - default: &528 + default: &527 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -35173,7 +34784,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#list-security-manager-teams parameters: - - *89 + - *83 responses: '200': description: Response @@ -35181,9 +34792,9 @@ paths: application/json: schema: type: array - items: *187 + items: *181 examples: - default: *188 + default: *182 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35206,8 +34817,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#add-a-security-manager-team parameters: - - *89 - - *184 + - *83 + - *178 responses: '204': description: Response @@ -35232,8 +34843,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *89 - - *184 + - *83 + - *178 responses: '204': description: Response @@ -35259,13 +34870,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &586 + schema: &585 type: object properties: total_minutes_used: @@ -35335,7 +34946,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &587 + default: &586 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -35365,13 +34976,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &588 + schema: &587 type: object properties: total_gigabytes_bandwidth_used: @@ -35389,7 +35000,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &589 + default: &588 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -35415,13 +35026,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-an-organization parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: &590 + schema: &589 type: object properties: days_left_in_billing_cycle: @@ -35439,7 +35050,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &591 + default: &590 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -35473,8 +35084,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *89 - - *184 + - *83 + - *178 - 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`). @@ -35506,13 +35117,13 @@ paths: application/json: schema: type: array - items: *52 + items: *221 examples: - default: *53 - '500': *39 + default: *222 + '500': *127 '403': *27 '404': *6 - '422': *54 + '422': *223 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35546,8 +35157,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: - - *89 - - *184 + - *83 + - *178 - 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`). @@ -35579,10 +35190,10 @@ paths: application/json: schema: type: array - items: *55 + items: *224 examples: - default: *136 - '500': *39 + default: *225 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -35603,7 +35214,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-teams parameters: - - *89 + - *83 - *17 - *18 responses: @@ -35613,11 +35224,11 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - default: *188 + default: *182 headers: - Link: *37 + Link: *50 '403': *27 x-github: githubCloudOnly: false @@ -35637,7 +35248,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#create-a-team parameters: - - *89 + - *83 requestBody: required: true content: @@ -35709,7 +35320,7 @@ paths: description: Response content: application/json: - schema: &227 + schema: &226 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -35783,7 +35394,7 @@ paths: parent: anyOf: - type: 'null' - - *187 + - *181 members_count: type: integer examples: @@ -36089,7 +35700,7 @@ paths: - repos_count - organization examples: - default: &228 + default: &227 value: id: 1 node_id: MDQ6VGVhbTE= @@ -36159,16 +35770,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-by-name parameters: - - *89 - - *184 + - *83 + - *178 responses: '200': description: Response content: application/json: - schema: *227 + schema: *226 examples: - default: *228 + default: *227 '404': *6 x-github: githubCloudOnly: false @@ -36189,8 +35800,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team parameters: - - *89 - - *184 + - *83 + - *178 requestBody: required: false content: @@ -36253,16 +35864,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *227 + schema: *226 examples: - default: *228 + default: *227 '201': description: Response content: application/json: - schema: *227 + schema: *226 examples: - default: *228 + default: *227 '404': *6 '422': *15 '403': *27 @@ -36287,8 +35898,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team parameters: - - *89 - - *184 + - *83 + - *178 responses: '204': description: Response @@ -36314,9 +35925,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions parameters: - - *89 - - *184 - - *40 + - *83 + - *178 + - *37 - *17 - *18 - name: pinned @@ -36332,7 +35943,7 @@ paths: application/json: schema: type: array - items: &229 + items: &228 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -36423,7 +36034,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *59 + reactions: *54 required: - author - body @@ -36443,7 +36054,7 @@ paths: - updated_at - url examples: - default: &542 + default: &541 value: - author: login: octocat @@ -36493,7 +36104,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36517,8 +36128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion parameters: - - *89 - - *184 + - *83 + - *178 requestBody: required: true content: @@ -36552,9 +36163,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *228 examples: - default: &230 + default: &229 value: author: login: octocat @@ -36626,9 +36237,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion parameters: - - *89 - - *184 - - &231 + - *83 + - *178 + - &230 name: discussion_number description: The number that identifies the discussion. in: path @@ -36640,9 +36251,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *228 examples: - default: *230 + default: *229 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36664,9 +36275,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion parameters: - - *89 - - *184 - - *231 + - *83 + - *178 + - *230 requestBody: required: false content: @@ -36689,9 +36300,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *228 examples: - default: &543 + default: &542 value: author: login: octocat @@ -36761,9 +36372,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion parameters: - - *89 - - *184 - - *231 + - *83 + - *178 + - *230 responses: '204': description: Response @@ -36789,10 +36400,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments parameters: - - *89 - - *184 - - *231 - - *40 + - *83 + - *178 + - *230 + - *37 - *17 - *18 responses: @@ -36802,7 +36413,7 @@ paths: application/json: schema: type: array - items: &232 + items: &231 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -36867,7 +36478,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *59 + reactions: *54 required: - author - body @@ -36882,7 +36493,7 @@ paths: - updated_at - url examples: - default: &544 + default: &543 value: - author: login: octocat @@ -36926,7 +36537,7 @@ paths: eyes: 1 rocket: 1 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -36950,9 +36561,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *89 - - *184 - - *231 + - *83 + - *178 + - *230 requestBody: required: true content: @@ -36974,9 +36585,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *231 examples: - default: &233 + default: &232 value: author: login: octocat @@ -37042,10 +36653,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *89 - - *184 - - *231 - - &234 + - *83 + - *178 + - *230 + - &233 name: comment_number description: The number that identifies the comment. in: path @@ -37057,9 +36668,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *231 examples: - default: *233 + default: *232 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37081,10 +36692,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *89 - - *184 - - *231 - - *234 + - *83 + - *178 + - *230 + - *233 requestBody: required: true content: @@ -37106,9 +36717,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *231 examples: - default: &545 + default: &544 value: author: login: octocat @@ -37172,10 +36783,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *89 - - *184 - - *231 - - *234 + - *83 + - *178 + - *230 + - *233 responses: '204': description: Response @@ -37201,10 +36812,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment parameters: - - *89 - - *184 - - *231 - - *234 + - *83 + - *178 + - *230 + - *233 - 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. @@ -37230,7 +36841,7 @@ paths: application/json: schema: type: array - items: &235 + items: &234 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -37274,7 +36885,7 @@ paths: - content - created_at examples: - default: &237 + default: &236 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -37300,7 +36911,7 @@ paths: content: heart created_at: '2016-05-20T20:09:31Z' headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37324,10 +36935,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment parameters: - - *89 - - *184 - - *231 - - *234 + - *83 + - *178 + - *230 + - *233 requestBody: required: true content: @@ -37360,9 +36971,9 @@ paths: team discussion comment content: application/json: - schema: *235 + schema: *234 examples: - default: &236 + default: &235 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -37391,9 +37002,9 @@ paths: description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37416,11 +37027,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *89 - - *184 - - *231 - - *234 - - &238 + - *83 + - *178 + - *230 + - *233 + - &237 name: reaction_id description: The unique identifier of the reaction. in: path @@ -37452,9 +37063,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *89 - - *184 - - *231 + - *83 + - *178 + - *230 - 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. @@ -37480,11 +37091,11 @@ paths: application/json: schema: type: array - items: *235 + items: *234 examples: - default: *237 + default: *236 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37508,9 +37119,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *89 - - *184 - - *231 + - *83 + - *178 + - *230 requestBody: required: true content: @@ -37542,16 +37153,16 @@ paths: description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '201': description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -37574,10 +37185,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *89 - - *184 - - *231 - - *238 + - *83 + - *178 + - *230 + - *237 responses: '204': description: Response @@ -37601,8 +37212,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations parameters: - - *89 - - *184 + - *83 + - *178 - *17 - *18 responses: @@ -37612,11 +37223,11 @@ paths: application/json: schema: type: array - items: *170 + items: *163 examples: - default: *171 + default: *164 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37636,8 +37247,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members parameters: - - *89 - - *184 + - *83 + - *178 - name: role description: Filters members returned by their role in the team. in: query @@ -37660,9 +37271,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37690,15 +37301,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user parameters: - - *89 - - *184 - - *121 + - *83 + - *178 + - *115 responses: '200': description: Response content: application/json: - schema: &239 + schema: &238 title: Team Membership description: Team Membership type: object @@ -37726,7 +37337,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &546 + response-if-user-is-a-team-maintainer: &545 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -37762,9 +37373,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user parameters: - - *89 - - *184 - - *121 + - *83 + - *178 + - *115 requestBody: required: false content: @@ -37789,9 +37400,9 @@ paths: description: Response content: application/json: - schema: *239 + schema: *238 examples: - response-if-users-membership-with-team-is-now-pending: &547 + response-if-users-membership-with-team-is-now-pending: &546 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -37826,9 +37437,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user parameters: - - *89 - - *184 - - *121 + - *83 + - *178 + - *115 responses: '204': description: Response @@ -37854,8 +37465,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects parameters: - - *89 - - *184 + - *83 + - *178 - *17 - *18 responses: @@ -37865,7 +37476,7 @@ paths: application/json: schema: type: array - items: &240 + items: &239 title: Team Project description: A team's access to a project. type: object @@ -37934,7 +37545,7 @@ paths: - updated_at - permissions examples: - default: &548 + default: &547 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -37974,7 +37585,7 @@ paths: write: true admin: false headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -37995,9 +37606,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project parameters: - - *89 - - *184 - - &241 + - *83 + - *178 + - &240 name: project_id description: The unique identifier of the project. in: path @@ -38009,9 +37620,9 @@ paths: description: Response content: application/json: - schema: *240 + schema: *239 examples: - default: &549 + default: &548 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -38071,9 +37682,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions parameters: - - *89 - - *184 - - *241 + - *83 + - *178 + - *240 requestBody: required: false content: @@ -38138,9 +37749,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team parameters: - - *89 - - *184 - - *241 + - *83 + - *178 + - *240 responses: '204': description: Response @@ -38164,8 +37775,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories parameters: - - *89 - - *184 + - *83 + - *178 - *17 - *18 responses: @@ -38175,11 +37786,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38206,16 +37817,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *89 - - *184 + - *83 + - *178 + - *241 - *242 - - *243 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &550 + schema: &549 title: Team Repository description: A team's access to a repository. type: object @@ -38241,7 +37852,7 @@ paths: license: anyOf: - type: 'null' - - *73 + - *68 forks: type: integer permissions: @@ -38856,10 +38467,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *89 - - *184 + - *83 + - *178 + - *241 - *242 - - *243 requestBody: required: false content: @@ -38904,10 +38515,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team parameters: - - *89 - - *184 + - *83 + - *178 + - *241 - *242 - - *243 responses: '204': description: Response @@ -38931,8 +38542,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams parameters: - - *89 - - *184 + - *83 + - *178 - *17 - *18 responses: @@ -38942,9 +38553,9 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - response-if-child-teams-exist: &551 + response-if-child-teams-exist: &550 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -38972,7 +38583,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos html_url: https://github.com/orgs/rails/teams/core headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -38997,7 +38608,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#enable-or-disable-a-security-feature-for-an-organization parameters: - - *89 + - *83 - name: security_product in: path description: The security feature to enable or disable. @@ -39068,7 +38679,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#get-a-project-card parameters: - - &244 + - &243 name: card_id description: The unique identifier of the card. in: path @@ -39080,7 +38691,7 @@ paths: description: Response content: application/json: - schema: &245 + schema: &244 title: Project Card description: Project cards represent a scope of work. type: object @@ -39155,7 +38766,7 @@ paths: - created_at - updated_at examples: - default: &246 + default: &245 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -39205,7 +38816,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#update-an-existing-project-card parameters: - - *244 + - *243 requestBody: required: false content: @@ -39235,9 +38846,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *244 examples: - default: *246 + default: *245 '304': *35 '403': *27 '401': *23 @@ -39258,7 +38869,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#delete-a-project-card parameters: - - *244 + - *243 responses: '204': description: Response @@ -39296,7 +38907,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#move-a-project-card parameters: - - *244 + - *243 requestBody: required: true content: @@ -39403,7 +39014,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#get-a-project-column parameters: - - &247 + - &246 name: column_id description: The unique identifier of the column. in: path @@ -39415,7 +39026,7 @@ paths: description: Response content: application/json: - schema: &248 + schema: &247 title: Project Column description: Project columns contain cards of work. type: object @@ -39469,7 +39080,7 @@ paths: - created_at - updated_at examples: - default: &249 + default: &248 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -39498,7 +39109,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#update-an-existing-project-column parameters: - - *247 + - *246 requestBody: required: true content: @@ -39523,9 +39134,9 @@ paths: description: Response content: application/json: - schema: *248 + schema: *247 examples: - default: *249 + default: *248 '304': *35 '403': *27 '401': *23 @@ -39544,7 +39155,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#delete-a-project-column parameters: - - *247 + - *246 responses: '204': description: Response @@ -39567,7 +39178,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#list-project-cards parameters: - - *247 + - *246 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -39588,7 +39199,7 @@ paths: application/json: schema: type: array - items: *245 + items: *244 examples: default: value: @@ -39622,7 +39233,7 @@ paths: content_url: https://api.github.com/repos/api-playground/projects-test/issues/3 project_url: https://api.github.com/projects/120 headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -39641,7 +39252,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/cards#create-a-project-card parameters: - - *247 + - *246 requestBody: required: true content: @@ -39685,9 +39296,9 @@ paths: description: Response content: application/json: - schema: *245 + schema: *244 examples: - default: *246 + default: *245 '304': *35 '403': *27 '401': *23 @@ -39697,8 +39308,8 @@ paths: application/json: schema: oneOf: - - *92 - - *93 + - *86 + - *87 '503': description: Response content: @@ -39737,7 +39348,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#move-a-project-column parameters: - - *247 + - *246 requestBody: required: true content: @@ -39794,15 +39405,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#get-a-project parameters: - - *241 + - *240 responses: '200': description: Response content: application/json: - schema: *202 + schema: *196 examples: - default: &250 + default: &249 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -39855,7 +39466,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#update-a-project parameters: - - *241 + - *240 requestBody: required: false content: @@ -39904,9 +39515,9 @@ paths: description: Response content: application/json: - schema: *202 + schema: *196 examples: - default: *250 + default: *249 '404': description: Not Found if the authenticated user does not have access to the project @@ -39927,7 +39538,7 @@ paths: items: type: string '401': *23 - '410': *251 + '410': *250 '422': *7 x-github: githubCloudOnly: false @@ -39945,7 +39556,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#delete-a-project parameters: - - *241 + - *240 responses: '204': description: Delete Success @@ -39966,7 +39577,7 @@ paths: items: type: string '401': *23 - '410': *251 + '410': *250 '404': *6 x-github: githubCloudOnly: false @@ -39989,7 +39600,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#list-project-collaborators parameters: - - *241 + - *240 - 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 @@ -40016,9 +39627,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 '404': *6 '422': *15 '304': *35 @@ -40041,8 +39652,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#add-project-collaborator parameters: - - *241 - - *121 + - *240 + - *115 requestBody: required: false content: @@ -40091,8 +39702,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#remove-user-as-a-collaborator parameters: - - *241 - - *121 + - *240 + - *115 responses: '204': description: Response @@ -40120,8 +39731,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/collaborators#get-project-permission-for-a-user parameters: - - *241 - - *121 + - *240 + - *115 responses: '200': description: Response @@ -40185,7 +39796,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#list-project-columns parameters: - - *241 + - *240 - *17 - *18 responses: @@ -40195,7 +39806,7 @@ paths: application/json: schema: type: array - items: *248 + items: *247 examples: default: value: @@ -40208,7 +39819,7 @@ paths: created_at: '2016-09-05T14:18:44Z' updated_at: '2016-09-05T14:22:28Z' headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -40227,7 +39838,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/columns#create-a-project-column parameters: - - *241 + - *240 requestBody: required: true content: @@ -40251,7 +39862,7 @@ paths: description: Response content: application/json: - schema: *248 + schema: *247 examples: default: value: @@ -40312,7 +39923,7 @@ paths: resources: type: object properties: - core: &252 + core: &251 title: Rate Limit type: object properties: @@ -40329,19 +39940,20 @@ paths: - remaining - reset - used - 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 + graphql: *251 + search: *251 + code_search: *251 + source_import: *251 + integration_manifest: *251 + code_scanning_upload: *251 + actions_runner_registration: *251 + scim: *251 + dependency_snapshots: *251 + code_scanning_autofix: *251 required: - core - search - rate: *252 + rate: *251 required: - rate - resources @@ -40399,6 +40011,11 @@ paths: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -40440,14 +40057,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *253 + schema: *252 examples: default-response: summary: Default response @@ -40948,7 +40565,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *254 + '301': *253 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40966,8 +40583,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#update-a-repository parameters: + - *241 - *242 - - *243 requestBody: required: false content: @@ -41204,10 +40821,10 @@ paths: description: Response content: application/json: - schema: *253 + schema: *252 examples: - default: *255 - '307': &256 + default: *254 + '307': &255 description: Temporary Redirect content: application/json: @@ -41236,8 +40853,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#delete-a-repository parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -41259,7 +40876,7 @@ paths: value: message: Organization members cannot delete repositories. documentation_url: https://docs.github.com/rest/repos/repos#delete-a-repository - '307': *256 + '307': *255 '404': *6 x-github: githubCloudOnly: false @@ -41282,11 +40899,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-artifacts-for-a-repository parameters: + - *241 - *242 - - *243 - *17 - *18 - - &282 + - &281 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -41309,7 +40926,7 @@ paths: type: integer artifacts: type: array - items: &257 + items: &256 title: Artifact description: An artifact type: object @@ -41395,7 +41012,7 @@ paths: - expires_at - updated_at examples: - default: &283 + default: &282 value: total_count: 2 artifacts: @@ -41432,7 +41049,7 @@ paths: head_branch: main head_sha: 178f4f6090b3fccad4a65b3e83d076a622d59652 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41454,9 +41071,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#get-an-artifact parameters: + - *241 - *242 - - *243 - - &258 + - &257 name: artifact_id description: The unique identifier of the artifact. in: path @@ -41468,7 +41085,7 @@ paths: description: Response content: application/json: - schema: *257 + schema: *256 examples: default: value: @@ -41505,9 +41122,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#delete-an-artifact parameters: + - *241 - *242 - - *243 - - *258 + - *257 responses: '204': description: Response @@ -41531,9 +41148,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#download-an-artifact parameters: + - *241 - *242 - - *243 - - *258 + - *257 - name: archive_format in: path required: true @@ -41547,7 +41164,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': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41570,14 +41187,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#get-github-actions-cache-usage-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *259 + schema: *258 examples: default: value: @@ -41603,11 +41220,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/cache#list-github-actions-caches-for-a-repository parameters: + - *241 - *242 - - *243 - *17 - *18 - - &260 + - &259 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 @@ -41635,13 +41252,13 @@ paths: - last_accessed_at - size_in_bytes default: last_accessed_at - - *40 + - *37 responses: '200': description: Response content: application/json: - schema: &261 + schema: &260 title: Repository actions caches description: Repository actions caches type: object @@ -41691,7 +41308,7 @@ paths: - total_count - actions_caches examples: - default: &262 + default: &261 value: total_count: 1 actions_caches: @@ -41703,7 +41320,7 @@ paths: created_at: '2019-01-24T22:45:36.000Z' size_in_bytes: 1024 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41723,23 +41340,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: + - *241 - *242 - - *243 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *260 + - *259 responses: '200': description: Response content: application/json: - schema: *261 + schema: *260 examples: - default: *262 + default: *261 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41759,8 +41376,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: + - *241 - *242 - - *243 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -41791,9 +41408,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run parameters: + - *241 - *242 - - *243 - - &263 + - &262 name: job_id description: The unique identifier of the job. in: path @@ -41805,7 +41422,7 @@ paths: description: Response content: application/json: - schema: &286 + schema: &285 title: Job description: Information of a job execution in a workflow run type: object @@ -42152,9 +41769,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run parameters: + - *241 - *242 - - *243 - - *263 + - *262 responses: '302': description: Response @@ -42182,9 +41799,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-job-from-a-workflow-run parameters: + - *241 - *242 - - *243 - - *263 + - *262 requestBody: required: false content: @@ -42206,7 +41823,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -42230,8 +41847,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: + - *241 - *242 - - *243 responses: '200': description: Status response @@ -42281,8 +41898,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: + - *241 - *242 - - *243 requestBody: required: true content: @@ -42316,7 +41933,7 @@ paths: description: Empty response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -42345,8 +41962,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-organization-secrets parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -42364,7 +41981,7 @@ paths: type: integer secrets: type: array - items: &288 + items: &287 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -42385,7 +42002,7 @@ paths: - created_at - updated_at examples: - default: &289 + default: &288 value: total_count: 2 secrets: @@ -42396,7 +42013,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42418,9 +42035,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-organization-variables parameters: + - *241 - *242 - - *243 - - *264 + - *263 - *18 responses: '200': @@ -42437,7 +42054,7 @@ paths: type: integer variables: type: array - items: &292 + items: &291 title: Actions Variable type: object properties: @@ -42471,7 +42088,7 @@ paths: - created_at - updated_at examples: - default: &293 + default: &292 value: total_count: 2 variables: @@ -42484,7 +42101,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42504,8 +42121,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-github-actions-permissions-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -42514,11 +42131,11 @@ paths: schema: type: object properties: - enabled: &266 + enabled: &265 type: boolean description: Whether GitHub Actions is enabled on the repository. - allowed_actions: *98 - selected_actions_url: *265 + allowed_actions: *92 + selected_actions_url: *264 required: - enabled examples: @@ -42545,8 +42162,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-github-actions-permissions-for-a-repository parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -42557,8 +42174,8 @@ paths: schema: type: object properties: - enabled: *266 - allowed_actions: *98 + enabled: *265 + allowed_actions: *92 required: - enabled examples: @@ -42587,14 +42204,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: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: &267 + schema: &266 type: object properties: access_level: @@ -42611,7 +42228,7 @@ paths: required: - access_level examples: - default: &268 + default: &267 value: access_level: organization x-github: @@ -42635,15 +42252,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: + - *241 - *242 - - *243 requestBody: required: true content: application/json: - schema: *267 + schema: *266 examples: - default: *268 + default: *267 responses: '204': description: Response @@ -42667,16 +42284,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *100 + schema: *94 examples: - default: *101 + default: *95 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -42695,8 +42312,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-allowed-actions-and-reusable-workflows-for-a-repository parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -42704,9 +42321,9 @@ paths: required: false content: application/json: - schema: *100 + schema: *94 examples: - selected_actions: *101 + selected_actions: *95 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -42728,16 +42345,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#get-default-workflow-permissions-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *269 + schema: *268 examples: - default: *104 + default: *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42758,8 +42375,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/permissions#set-default-workflow-permissions-for-a-repository parameters: + - *241 - *242 - - *243 responses: '204': description: Success response @@ -42770,9 +42387,9 @@ paths: required: true content: application/json: - schema: *270 + schema: *269 examples: - default: *104 + default: *98 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42799,8 +42416,8 @@ paths: in: query schema: type: string + - *241 - *242 - - *243 - *17 - *18 responses: @@ -42818,11 +42435,11 @@ paths: type: integer runners: type: array - items: *110 + items: *104 examples: - default: *111 + default: *105 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42844,8 +42461,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#list-runner-applications-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -42853,9 +42470,9 @@ paths: application/json: schema: type: array - items: *271 + items: *270 examples: - default: *272 + default: *271 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42877,8 +42494,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: + - *241 - *242 - - *243 requestBody: required: true content: @@ -42921,7 +42538,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *273 + '201': *272 '404': *6 '422': *7 x-github: @@ -42951,16 +42568,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-registration-token-for-a-repository parameters: + - *241 - *242 - - *243 responses: '201': description: Response content: application/json: - schema: *112 + schema: *106 examples: - default: *274 + default: *273 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42988,16 +42605,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/self-hosted-runners#create-a-remove-token-for-a-repository parameters: + - *241 - *242 - - *243 responses: '201': description: Response content: application/json: - schema: *112 + schema: *106 examples: - default: *275 + default: *274 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43019,17 +42636,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: + - *241 - *242 - - *243 - - *109 + - *103 responses: '200': description: Response content: application/json: - schema: *110 + schema: *104 examples: - default: *276 + default: *275 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43050,9 +42667,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: + - *241 - *242 - - *243 - - *109 + - *103 responses: '204': description: Response @@ -43077,11 +42694,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: + - *241 - *242 - - *243 - - *109 + - *103 responses: - '200': *114 + '200': *108 '404': *6 x-github: githubCloudOnly: false @@ -43103,9 +42720,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: + - *241 - *242 - - *243 - - *109 + - *103 requestBody: required: true content: @@ -43129,7 +42746,7 @@ paths: - gpu - accelerated responses: - '200': *114 + '200': *108 '404': *6 '422': *7 x-github: @@ -43153,9 +42770,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: + - *241 - *242 - - *243 - - *109 + - *103 requestBody: required: true content: @@ -43180,7 +42797,7 @@ paths: - gpu - accelerated responses: - '200': *114 + '200': *108 '404': *6 '422': *7 x-github: @@ -43204,11 +42821,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: + - *241 - *242 - - *243 - - *109 + - *103 responses: - '200': *277 + '200': *276 '404': *6 x-github: githubCloudOnly: false @@ -43235,12 +42852,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: + - *241 - *242 - - *243 - - *109 - - *278 + - *103 + - *277 responses: - '200': *114 + '200': *108 '404': *6 '422': *7 x-github: @@ -43266,9 +42883,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-repository parameters: + - *241 - *242 - - *243 - - &296 + - &295 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. @@ -43276,7 +42893,7 @@ paths: required: false schema: type: string - - &297 + - &296 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -43284,7 +42901,7 @@ paths: required: false schema: type: string - - &298 + - &297 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -43293,7 +42910,7 @@ paths: required: false schema: type: string - - &299 + - &298 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 @@ -43320,7 +42937,7 @@ paths: - pending - *17 - *18 - - &300 + - &299 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)." @@ -43329,7 +42946,7 @@ paths: schema: type: string format: date-time - - &279 + - &278 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -43338,13 +42955,13 @@ paths: schema: type: boolean default: false - - &301 + - &300 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &302 + - &301 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -43367,7 +42984,7 @@ paths: type: integer workflow_runs: type: array - items: &280 + items: &279 title: Workflow Run description: An invocation of a workflow type: object @@ -43484,7 +43101,7 @@ paths: type: - array - 'null' - items: &321 + items: &320 title: Pull Request Minimal type: object properties: @@ -43611,7 +43228,7 @@ paths: head_commit: anyOf: - type: 'null' - - &325 + - &324 title: Simple Commit description: A commit. type: object @@ -43685,8 +43302,8 @@ paths: - timestamp - author - committer - repository: *108 - head_repository: *108 + repository: *102 + head_repository: *102 head_repository_id: type: integer examples: @@ -43726,7 +43343,7 @@ paths: - workflow_url - pull_requests examples: - default: &303 + default: &302 value: total_count: 1 workflow_runs: @@ -43940,7 +43557,7 @@ paths: releases_url: https://api.github.com/repos/octo-org/octo-repo/releases{/id} deployments_url: https://api.github.com/repos/octo-org/octo-repo/deployments headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43962,24 +43579,24 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run parameters: + - *241 - *242 - - *243 - - &281 + - &280 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *279 + - *278 responses: '200': description: Response content: application/json: - schema: *280 + schema: *279 examples: - default: &284 + default: &283 value: id: 30433642 name: Build @@ -44220,9 +43837,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-a-workflow-run parameters: + - *241 - *242 - - *243 - - *281 + - *280 responses: '204': description: Response @@ -44245,9 +43862,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-the-review-history-for-a-workflow-run parameters: + - *241 - *242 - - *243 - - *281 + - *280 responses: '200': description: Response @@ -44375,15 +43992,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: + - *241 - *242 - - *243 - - *281 + - *280 responses: '201': description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -44410,12 +44027,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/artifacts#list-workflow-run-artifacts parameters: + - *241 - *242 - - *243 - - *281 + - *280 - *17 - *18 - - *282 + - *281 responses: '200': description: Response @@ -44431,11 +44048,11 @@ paths: type: integer artifacts: type: array - items: *257 + items: *256 examples: - default: *283 + default: *282 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44457,25 +44074,25 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: + - *241 - *242 - - *243 - - *281 - - &285 + - *280 + - &284 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *279 + - *278 responses: '200': description: Response content: application/json: - schema: *280 + schema: *279 examples: - default: *284 + default: *283 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44498,10 +44115,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run-attempt parameters: + - *241 - *242 - - *243 - - *281 - - *285 + - *280 + - *284 - *17 - *18 responses: @@ -44519,9 +44136,9 @@ paths: type: integer jobs: type: array - items: *286 + items: *285 examples: - default: &287 + default: &286 value: total_count: 1 jobs: @@ -44610,7 +44227,7 @@ paths: workflow_name: CI head_branch: main headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -44634,10 +44251,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: + - *241 - *242 - - *243 - - *281 - - *285 + - *280 + - *284 responses: '302': description: Response @@ -44665,19 +44282,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#cancel-a-workflow-run parameters: + - *241 - *242 - - *243 - - *281 + - *280 responses: '202': description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44700,9 +44317,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: + - *241 - *242 - - *243 - - *281 + - *280 requestBody: required: true content: @@ -44769,19 +44386,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: + - *241 - *242 - - *243 - - *281 + - *280 responses: '202': description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44804,9 +44421,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run parameters: + - *241 - *242 - - *243 - - *281 + - *280 - 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 @@ -44836,11 +44453,11 @@ paths: type: integer jobs: type: array - items: *286 + items: *285 examples: - default: *287 + default: *286 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44863,9 +44480,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#download-workflow-run-logs parameters: + - *241 - *242 - - *243 - - *281 + - *280 responses: '302': description: Response @@ -44892,14 +44509,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#delete-workflow-run-logs parameters: + - *241 - *242 - - *243 - - *281 + - *280 responses: '204': description: Response '403': *27 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -44921,9 +44538,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-pending-deployments-for-a-workflow-run parameters: + - *241 - *242 - - *243 - - *281 + - *280 responses: '200': description: Response @@ -44992,7 +44609,7 @@ paths: items: type: object properties: - type: &396 + type: &395 type: string description: The type of reviewer. enum: @@ -45003,7 +44620,7 @@ paths: reviewer: anyOf: - *4 - - *173 + - *166 required: - environment - wait_timer @@ -45078,9 +44695,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#review-pending-deployments-for-a-workflow-run parameters: + - *241 - *242 - - *243 - - *281 + - *280 requestBody: required: true content: @@ -45130,7 +44747,7 @@ paths: application/json: schema: type: array - items: &391 + items: &390 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -45242,7 +44859,7 @@ paths: - created_at - updated_at examples: - default: &392 + default: &391 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -45298,9 +44915,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-a-workflow parameters: + - *241 - *242 - - *243 - - *281 + - *280 requestBody: required: false content: @@ -45322,7 +44939,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -45345,9 +44962,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#re-run-failed-jobs-from-a-workflow-run parameters: + - *241 - *242 - - *243 - - *281 + - *280 requestBody: required: false content: @@ -45369,7 +44986,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -45394,9 +45011,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#get-workflow-run-usage parameters: + - *241 - *242 - - *243 - - *281 + - *280 responses: '200': description: Response @@ -45533,8 +45150,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-repository-secrets parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -45552,11 +45169,11 @@ paths: type: integer secrets: type: array - items: *288 + items: *287 examples: - default: *289 + default: *288 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45579,16 +45196,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-public-key parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *290 + schema: *289 examples: - default: *291 + default: *290 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45610,17 +45227,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 responses: '200': description: Response content: application/json: - schema: *288 + schema: *287 examples: - default: &409 + default: &408 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -45646,9 +45263,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 requestBody: required: true content: @@ -45676,7 +45293,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -45702,9 +45319,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 responses: '204': description: Response @@ -45729,9 +45346,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-repository-variables parameters: + - *241 - *242 - - *243 - - *264 + - *263 - *18 responses: '200': @@ -45748,11 +45365,11 @@ paths: type: integer variables: type: array - items: *292 + items: *291 examples: - default: *293 + default: *292 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -45773,8 +45390,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-a-repository-variable parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -45801,7 +45418,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -45826,17 +45443,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-a-repository-variable parameters: + - *241 - *242 - - *243 - - *119 + - *113 responses: '200': description: Response content: application/json: - schema: *292 + schema: *291 examples: - default: &410 + default: &409 value: name: USERNAME value: octocat @@ -45862,9 +45479,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-a-repository-variable parameters: + - *241 - *242 - - *243 - - *119 + - *113 requestBody: required: true content: @@ -45906,9 +45523,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-a-repository-variable parameters: + - *241 - *242 - - *243 - - *119 + - *113 responses: '204': description: Response @@ -45933,8 +45550,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#list-repository-workflows parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -45952,7 +45569,7 @@ paths: type: integer workflows: type: array - items: &294 + items: &293 title: Workflow description: A GitHub Actions workflow type: object @@ -46047,7 +45664,7 @@ paths: html_url: https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289 badge_url: https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46070,9 +45687,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-a-workflow parameters: + - *241 - *242 - - *243 - - &295 + - &294 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -46087,7 +45704,7 @@ paths: description: Response content: application/json: - schema: *294 + schema: *293 examples: default: value: @@ -46120,9 +45737,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#disable-a-workflow parameters: + - *241 - *242 - - *243 - - *295 + - *294 responses: '204': description: Response @@ -46147,9 +45764,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#create-a-workflow-dispatch-event parameters: + - *241 - *242 - - *243 - - *295 + - *294 responses: '204': description: Response @@ -46200,9 +45817,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#enable-a-workflow parameters: + - *241 - *242 - - *243 - - *295 + - *294 responses: '204': description: Response @@ -46229,19 +45846,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflow-runs#list-workflow-runs-for-a-workflow parameters: + - *241 - *242 - - *243 + - *294 - *295 - *296 - *297 - *298 - - *299 - *17 - *18 + - *299 + - *278 - *300 - - *279 - *301 - - *302 responses: '200': description: Response @@ -46257,11 +45874,11 @@ paths: type: integer workflow_runs: type: array - items: *280 + items: *279 examples: - default: *303 + default: *302 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46285,9 +45902,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/workflows#get-workflow-usage parameters: + - *241 - *242 - - *243 - - *295 + - *294 responses: '200': description: Response @@ -46348,12 +45965,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-activities parameters: + - *241 - *242 - - *243 - - *40 + - *37 - *17 - - *41 - - *42 + - *38 + - *39 - name: ref description: |- The Git reference for the activities you want to list. @@ -46498,7 +46115,7 @@ paths: type: User site_admin: false headers: - Link: *37 + Link: *50 '422': *7 x-github: githubCloudOnly: false @@ -46517,8 +46134,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#list-assignees parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -46530,9 +46147,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -46555,8 +46172,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#check-if-a-user-can-be-assigned parameters: + - *241 - *242 - - *243 - name: assignee in: path required: true @@ -46592,8 +46209,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-an-attestation parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -46705,11 +46322,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-attestations parameters: + - *241 - *242 - - *243 - *17 - - *41 - - *42 + - *38 + - *39 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -46749,8 +46366,10 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: - default: *304 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46770,8 +46389,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -46779,7 +46398,7 @@ paths: application/json: schema: type: array - items: &305 + items: &304 title: Autolink reference description: An autolink reference. type: object @@ -46833,8 +46452,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#create-an-autolink-reference-for-a-repository parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -46873,9 +46492,9 @@ paths: description: response content: application/json: - schema: *305 + schema: *304 examples: - default: &306 + default: &305 value: id: 1 key_prefix: TICKET- @@ -46906,9 +46525,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#get-an-autolink-reference-of-a-repository parameters: + - *241 - *242 - - *243 - - &307 + - &306 name: autolink_id description: The unique identifier of the autolink. in: path @@ -46920,9 +46539,9 @@ paths: description: Response content: application/json: - schema: *305 + schema: *304 examples: - default: *306 + default: *305 '404': *6 x-github: githubCloudOnly: false @@ -46942,9 +46561,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/autolinks#delete-an-autolink-reference-from-a-repository parameters: + - *241 - *242 - - *243 - - *307 + - *306 responses: '204': description: Response @@ -46968,8 +46587,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: + - *241 - *242 - - *243 responses: '200': description: Response if Dependabot is enabled @@ -47019,8 +46638,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-automated-security-fixes parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -47041,8 +46660,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-automated-security-fixes parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -47062,8 +46681,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#list-branches parameters: + - *241 - *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. @@ -47101,7 +46720,7 @@ paths: - url protected: type: boolean - protection: &309 + protection: &308 title: Branch Protection description: Branch Protection type: object @@ -47144,7 +46763,7 @@ paths: required: - contexts - checks - enforce_admins: &312 + enforce_admins: &311 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -47161,7 +46780,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &314 + required_pull_request_reviews: &313 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -47183,7 +46802,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *173 + items: *166 apps: description: The list of apps with review dismissal access. @@ -47215,7 +46834,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *173 + items: *166 apps: description: The list of apps allowed to bypass pull request requirements. @@ -47245,7 +46864,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &311 + restrictions: &310 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -47552,7 +47171,7 @@ paths: - linter protection_url: https://api.github.com/repos/octocat/hello-world/branches/master/protection headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -47570,9 +47189,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#get-a-branch parameters: + - *241 - *242 - - *243 - - &310 + - &309 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). @@ -47586,14 +47205,14 @@ paths: description: Response content: application/json: - schema: &320 + schema: &319 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &367 + commit: &366 title: Commit description: Commit type: object @@ -47632,7 +47251,7 @@ paths: author: anyOf: - type: 'null' - - &308 + - &307 title: Git User description: Metaproperties for Git author/committer information. @@ -47653,7 +47272,7 @@ paths: committer: anyOf: - type: 'null' - - *308 + - *307 message: type: string examples: @@ -47677,7 +47296,7 @@ paths: required: - sha - url - verification: &416 + verification: &415 title: Verification type: object properties: @@ -47712,14 +47331,14 @@ paths: author: oneOf: - *4 - - *117 + - *111 type: - 'null' - object committer: oneOf: - *4 - - *117 + - *111 type: - 'null' - object @@ -47756,7 +47375,7 @@ paths: type: integer files: type: array - items: &379 + items: &378 title: Diff Entry description: Diff Entry type: object @@ -47850,7 +47469,7 @@ paths: - self protected: type: boolean - protection: *309 + protection: *308 protection_url: type: string format: uri @@ -47959,7 +47578,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *254 + '301': *253 '404': *6 x-github: githubCloudOnly: false @@ -47981,15 +47600,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-branch-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response content: application/json: - schema: *309 + schema: *308 examples: default: value: @@ -48183,9 +47802,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-branch-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: true content: @@ -48445,7 +48064,7 @@ paths: url: type: string format: uri - required_status_checks: &317 + required_status_checks: &316 title: Status Check Policy description: Status Check Policy type: object @@ -48526,7 +48145,7 @@ paths: items: *4 teams: type: array - items: *173 + items: *166 apps: type: array items: *5 @@ -48544,7 +48163,7 @@ paths: items: *4 teams: type: array - items: *173 + items: *166 apps: type: array items: *5 @@ -48604,7 +48223,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *311 + restrictions: *310 required_conversation_resolution: type: object properties: @@ -48716,9 +48335,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-branch-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '204': description: Response @@ -48743,17 +48362,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-admin-branch-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response content: application/json: - schema: *312 + schema: *311 examples: - default: &313 + default: &312 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -48775,17 +48394,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-admin-branch-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response content: application/json: - schema: *312 + schema: *311 examples: - default: *313 + default: *312 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48804,9 +48423,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-admin-branch-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '204': description: Response @@ -48831,17 +48450,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-pull-request-review-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response content: application/json: - schema: *314 + schema: *313 examples: - default: &315 + default: &314 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -48937,9 +48556,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-pull-request-review-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: false content: @@ -49037,9 +48656,9 @@ paths: description: Response content: application/json: - schema: *314 + schema: *313 examples: - default: *315 + default: *314 '422': *15 x-github: githubCloudOnly: false @@ -49060,9 +48679,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-pull-request-review-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '204': description: Response @@ -49089,17 +48708,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-commit-signature-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response content: application/json: - schema: *312 + schema: *311 examples: - default: &316 + default: &315 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -49122,17 +48741,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#create-commit-signature-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response content: application/json: - schema: *312 + schema: *311 examples: - default: *316 + default: *315 '404': *6 x-github: githubCloudOnly: false @@ -49152,9 +48771,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-commit-signature-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '204': description: Response @@ -49179,17 +48798,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-status-checks-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response content: application/json: - schema: *317 + schema: *316 examples: - default: &318 + default: &317 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -49215,9 +48834,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#update-status-check-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: false content: @@ -49269,9 +48888,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *316 examples: - default: *318 + default: *317 '404': *6 '422': *15 x-github: @@ -49293,9 +48912,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-protection parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '204': description: Response @@ -49319,9 +48938,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-all-status-check-contexts parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response @@ -49355,9 +48974,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-status-check-contexts parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: false content: @@ -49424,9 +49043,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-status-check-contexts parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: false content: @@ -49490,9 +49109,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-status-check-contexts parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: content: application/json: @@ -49558,15 +49177,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response content: application/json: - schema: *311 + schema: *310 examples: default: value: @@ -49657,9 +49276,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#delete-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '204': description: Response @@ -49682,9 +49301,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-apps-with-access-to-the-protected-branch parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response @@ -49694,7 +49313,7 @@ paths: type: array items: *5 examples: - default: &319 + default: &318 value: - id: 1 slug: octoapp @@ -49751,9 +49370,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-app-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: true content: @@ -49787,7 +49406,7 @@ paths: type: array items: *5 examples: - default: *319 + default: *318 '422': *15 x-github: githubCloudOnly: false @@ -49808,9 +49427,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-app-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: true content: @@ -49844,7 +49463,7 @@ paths: type: array items: *5 examples: - default: *319 + default: *318 '422': *15 x-github: githubCloudOnly: false @@ -49865,9 +49484,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-app-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: true content: @@ -49901,7 +49520,7 @@ paths: type: array items: *5 examples: - default: *319 + default: *318 '422': *15 x-github: githubCloudOnly: false @@ -49923,9 +49542,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-teams-with-access-to-the-protected-branch parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response @@ -49933,9 +49552,9 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - default: *188 + default: *182 '404': *6 x-github: githubCloudOnly: false @@ -49955,9 +49574,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-team-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: false content: @@ -49993,9 +49612,9 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - default: *188 + default: *182 '422': *15 x-github: githubCloudOnly: false @@ -50016,9 +49635,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-team-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: false content: @@ -50054,9 +49673,9 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - default: *188 + default: *182 '422': *15 x-github: githubCloudOnly: false @@ -50077,9 +49696,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-team-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: content: application/json: @@ -50114,9 +49733,9 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - default: *188 + default: *182 '422': *15 x-github: githubCloudOnly: false @@ -50138,9 +49757,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#get-users-with-access-to-the-protected-branch parameters: + - *241 - *242 - - *243 - - *310 + - *309 responses: '200': description: Response @@ -50150,7 +49769,7 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 '404': *6 x-github: githubCloudOnly: false @@ -50174,9 +49793,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#add-user-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: true content: @@ -50209,7 +49828,7 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 '422': *15 x-github: githubCloudOnly: false @@ -50234,9 +49853,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#set-user-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: true content: @@ -50269,7 +49888,7 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 '422': *15 x-github: githubCloudOnly: false @@ -50294,9 +49913,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branch-protection#remove-user-access-restrictions parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: true content: @@ -50329,7 +49948,7 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 '422': *15 x-github: githubCloudOnly: false @@ -50356,9 +49975,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#rename-a-branch parameters: + - *241 - *242 - - *243 - - *310 + - *309 requestBody: required: true content: @@ -50380,7 +49999,7 @@ paths: description: Response content: application/json: - schema: *320 + schema: *319 examples: default: value: @@ -50496,8 +50115,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#create-a-check-run parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -50776,7 +50395,7 @@ paths: description: Response content: application/json: - schema: &322 + schema: &321 title: CheckRun description: A check performed on the code of a given code change type: object @@ -50911,8 +50530,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *321 - deployment: &600 + items: *320 + deployment: &599 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -51199,9 +50818,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#get-a-check-run parameters: + - *241 - *242 - - *243 - - &323 + - &322 name: check_run_id description: The unique identifier of the check run. in: path @@ -51213,9 +50832,9 @@ paths: description: Response content: application/json: - schema: *322 + schema: *321 examples: - default: &324 + default: &323 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -51315,9 +50934,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#update-a-check-run parameters: + - *241 - *242 - - *243 - - *323 + - *322 requestBody: required: true content: @@ -51557,9 +51176,9 @@ paths: description: Response content: application/json: - schema: *322 + schema: *321 examples: - default: *324 + default: *323 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51579,9 +51198,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-run-annotations parameters: + - *241 - *242 - - *243 - - *323 + - *322 - *17 - *18 responses: @@ -51671,7 +51290,7 @@ paths: raw_details: Do you mean 'bananas' or 'banana'? blob_href: https://api.github.com/repos/github/rest-api-description/git/blobs/abc headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51693,15 +51312,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#rerequest-a-check-run parameters: + - *241 - *242 - - *243 - - *323 + - *322 responses: '201': description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -51739,8 +51358,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#create-a-check-suite parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -51762,7 +51381,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &326 + schema: &325 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -51844,12 +51463,12 @@ paths: type: - array - 'null' - items: *321 + items: *320 app: anyOf: - type: 'null' - *5 - repository: *108 + repository: *102 created_at: type: - string @@ -51860,7 +51479,7 @@ paths: - string - 'null' format: date-time - head_commit: *325 + head_commit: *324 latest_check_runs_count: type: integer check_runs_url: @@ -51888,7 +51507,7 @@ paths: - check_runs_url - pull_requests examples: - default: &327 + default: &326 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -52179,9 +51798,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *326 + schema: *325 examples: - default: *327 + default: *326 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52200,8 +51819,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#update-repository-preferences-for-check-suites parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -52262,7 +51881,7 @@ paths: required: - app_id - setting - repository: *108 + repository: *102 examples: default: value: @@ -52510,9 +52129,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#get-a-check-suite parameters: + - *241 - *242 - - *243 - - &328 + - &327 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -52524,9 +52143,9 @@ paths: description: Response content: application/json: - schema: *326 + schema: *325 examples: - default: *327 + default: *326 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52549,17 +52168,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-in-a-check-suite parameters: + - *241 - *242 - - *243 - - *328 - - &374 + - *327 + - &373 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &375 + - &374 name: status description: Returns check runs with the specified `status`. in: query @@ -52598,9 +52217,9 @@ paths: type: integer check_runs: type: array - items: *322 + items: *321 examples: - default: &376 + default: &375 value: total_count: 1 check_runs: @@ -52682,7 +52301,7 @@ paths: url: https://api.github.com/repos/github/hello-world name: hello-world headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52702,15 +52321,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#rerequest-a-check-suite parameters: + - *241 - *242 - - *243 - - *328 + - *327 responses: '201': description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -52737,30 +52356,30 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository parameters: + - *241 - *242 - - *243 + - *328 - *329 - - *330 - *18 - *17 - - &343 + - &342 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: *331 - - &344 + schema: *330 + - &343 name: pr description: The number of the pull request for the results you want to list. in: query required: false schema: type: integer - - *40 - - *41 - - *42 + - *37 + - *38 + - *39 - name: sort description: The property by which to sort the results. in: query @@ -52776,13 +52395,13 @@ paths: be returned. in: query required: false - schema: *332 + schema: *331 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *333 + schema: *332 responses: '200': description: Response @@ -52793,24 +52412,24 @@ paths: items: type: object properties: - number: *46 - created_at: *47 - updated_at: *48 - url: *49 - html_url: *50 - instances_url: *334 - state: *126 - fixed_at: *122 + number: *44 + created_at: *45 + updated_at: *46 + url: *47 + html_url: *48 + instances_url: *333 + state: *120 + fixed_at: *116 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *123 - dismissed_reason: *335 - dismissed_comment: *336 - rule: *337 - tool: *338 - most_recent_instance: *339 + dismissed_at: *117 + dismissed_reason: *334 + dismissed_comment: *335 + rule: *336 + tool: *337 + most_recent_instance: *338 required: - number - created_at @@ -52926,14 +52545,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &340 + '403': &339 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52953,9 +52572,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-alert parameters: + - *241 - *242 - - *243 - - &341 + - &340 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -52963,30 +52582,30 @@ paths: field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. required: true - schema: *46 + schema: *44 responses: '200': description: Response content: application/json: - schema: &342 + schema: &341 type: object properties: - number: *46 - created_at: *47 - updated_at: *48 - url: *49 - html_url: *50 - instances_url: *334 - state: *126 - fixed_at: *122 + number: *44 + created_at: *45 + updated_at: *46 + url: *47 + html_url: *48 + instances_url: *333 + state: *120 + fixed_at: *116 dismissed_by: anyOf: - type: 'null' - *4 - dismissed_at: *123 - dismissed_reason: *335 - dismissed_comment: *336 + dismissed_at: *117 + dismissed_reason: *334 + dismissed_comment: *335 rule: type: object properties: @@ -53048,8 +52667,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *338 - most_recent_instance: *339 + tool: *337 + most_recent_instance: *338 required: - number - created_at @@ -53138,9 +52757,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *340 + '403': *339 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53158,9 +52777,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-alert parameters: + - *241 - *242 - - *243 - - *341 + - *340 requestBody: required: true content: @@ -53175,8 +52794,8 @@ paths: enum: - open - dismissed - dismissed_reason: *335 - dismissed_comment: *336 + dismissed_reason: *334 + dismissed_comment: *335 required: - state examples: @@ -53191,7 +52810,7 @@ paths: description: Response content: application/json: - schema: *342 + schema: *341 examples: default: value: @@ -53266,14 +52885,14 @@ paths: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '403': &349 + '403': &348 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *60 + '503': *55 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53293,13 +52912,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert parameters: + - *241 - *242 - - *243 - - *341 + - *340 - *18 - *17 + - *342 - *343 - - *344 responses: '200': description: Response @@ -53307,7 +52926,7 @@ paths: application/json: schema: type: array - items: *339 + items: *338 examples: default: value: @@ -53346,9 +52965,9 @@ paths: end_column: 50 classifications: - source - '403': *340 + '403': *339 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53380,30 +52999,30 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository parameters: + - *241 - *242 - - *243 + - *328 - *329 - - *330 - *18 - *17 - - *344 + - *343 - 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: *331 + schema: *330 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &347 + schema: &346 type: string description: An identifier for the upload. examples: - 6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53 - - *40 + - *37 - name: sort description: The property by which to sort the results. in: query @@ -53420,23 +53039,23 @@ paths: application/json: schema: type: array - items: &348 + items: &347 type: object properties: - ref: *331 - commit_sha: &357 + ref: *330 + commit_sha: &356 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: *345 + analysis_key: *344 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *346 + category: *345 error: type: string examples: @@ -53461,8 +53080,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *347 - tool: *338 + sarif_id: *346 + tool: *337 deletable: type: boolean warning: @@ -53524,9 +53143,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *340 + '403': *339 '404': *6 - '503': *60 + '503': *55 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53560,8 +53179,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: + - *241 - *242 - - *243 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -53574,7 +53193,7 @@ paths: description: Response content: application/json: - schema: *348 + schema: *347 examples: response: summary: application/json response @@ -53628,9 +53247,9 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *340 + '403': *339 '404': *6 - '503': *60 + '503': *55 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53710,8 +53329,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: + - *241 - *242 - - *243 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -53767,9 +53386,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *349 + '403': *348 '404': *6 - '503': *60 + '503': *55 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -53789,8 +53408,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -53798,7 +53417,7 @@ paths: application/json: schema: type: array - items: &350 + items: &349 title: CodeQL Database description: A CodeQL database. type: object @@ -53910,9 +53529,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': *340 + '403': *339 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -53939,8 +53558,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository parameters: + - *241 - *242 - - *243 - name: language in: path description: The language of the CodeQL database. @@ -53952,7 +53571,7 @@ paths: description: Response content: application/json: - schema: *350 + schema: *349 examples: default: value: @@ -53984,11 +53603,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': &381 + '302': &380 description: Found - '403': *340 + '403': *339 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54008,8 +53627,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#delete-a-codeql-database parameters: + - *241 - *242 - - *243 - name: language in: path description: The language of the CodeQL database. @@ -54019,9 +53638,9 @@ paths: responses: '204': description: Response - '403': *349 + '403': *348 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54047,8 +53666,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#create-a-codeql-variant-analysis parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -54057,7 +53676,7 @@ paths: type: object additionalProperties: false properties: - language: &351 + language: &350 type: string description: The language targeted by the CodeQL query enum: @@ -54135,7 +53754,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &355 + schema: &354 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -54143,9 +53762,9 @@ paths: id: type: integer description: The ID of the variant analysis. - controller_repo: *51 + controller_repo: *49 actor: *4 - query_language: *351 + query_language: *350 query_pack_url: type: string description: The download url for the query pack. @@ -54193,7 +53812,7 @@ paths: items: type: object properties: - repository: &352 + repository: &351 title: Repository Identifier description: Repository Identifier type: object @@ -54235,7 +53854,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &356 + analysis_status: &355 type: string description: The new status of the CodeQL variant analysis repository task. @@ -54267,7 +53886,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &353 + access_mismatch_repos: &352 type: object properties: repository_count: @@ -54282,7 +53901,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: *352 + items: *351 required: - repository_count - repositories @@ -54305,8 +53924,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *353 - over_limit_repos: *353 + no_codeql_db_repos: *352 + over_limit_repos: *352 required: - access_mismatch_repos - not_found_repos @@ -54322,7 +53941,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &354 + value: &353 summary: Default response value: id: 1 @@ -54474,17 +54093,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *354 + value: *353 repository_lists: summary: Response for a successful variant analysis submission - value: *354 + value: *353 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54505,8 +54124,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: + - *241 - *242 - - *243 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -54518,11 +54137,11 @@ paths: description: Response content: application/json: - schema: *355 + schema: *354 examples: - default: *354 + default: *353 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54543,7 +54162,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: - - *242 + - *241 - name: repo in: path description: The name of the controller repository. @@ -54577,8 +54196,8 @@ paths: schema: type: object properties: - repository: *51 - analysis_status: *356 + repository: *49 + analysis_status: *355 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -54682,7 +54301,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54703,8 +54322,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -54769,9 +54388,9 @@ paths: query_suite: default updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *340 + '403': *339 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54790,8 +54409,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -54849,7 +54468,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -54874,7 +54493,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *349 + '403': *348 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -54882,7 +54501,7 @@ paths: content: application/json: schema: *3 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54939,8 +54558,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#upload-an-analysis-as-sarif-data parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -54948,7 +54567,7 @@ paths: schema: type: object properties: - commit_sha: *357 + commit_sha: *356 ref: type: string description: |- @@ -55008,7 +54627,7 @@ paths: schema: type: object properties: - id: *347 + id: *346 url: type: string description: The REST API URL for checking the status of the upload. @@ -55022,11 +54641,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': *349 + '403': *348 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *60 + '503': *55 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -55045,8 +54664,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/code-scanning/code-scanning#get-information-about-a-sarif-upload parameters: + - *241 - *242 - - *243 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -55094,10 +54713,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': *340 + '403': *339 '404': description: Not Found if the sarif id does not match any upload - '503': *60 + '503': *55 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -55119,8 +54738,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: + - *241 - *242 - - *243 responses: '200': description: Response @@ -55144,7 +54763,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *127 + configuration: *121 examples: default: value: @@ -55173,7 +54792,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': *132 + '204': *126 '304': *35 '403': *27 '404': *6 @@ -55198,8 +54817,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-codeowners-errors parameters: + - *241 - *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 @@ -55327,8 +54946,8 @@ paths: parameters: - *17 - *18 + - *241 - *242 - - *243 responses: '200': description: Response @@ -55344,7 +54963,7 @@ paths: type: integer codespaces: type: array - items: *177 + items: *170 examples: default: value: @@ -55620,7 +55239,7 @@ paths: start_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start stop_url: https://api.github.com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop recent_folders: [] - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -55642,8 +55261,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -55707,22 +55326,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '400': *14 '401': *23 '403': *27 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -55746,8 +55365,8 @@ paths: parameters: - *17 - *18 + - *241 - *242 - - *243 responses: '200': description: Response @@ -55787,7 +55406,7 @@ paths: - path: ".devcontainer.json" display_name: Default project configuration total_count: 3 - '500': *39 + '500': *127 '400': *14 '401': *23 '403': *27 @@ -55811,8 +55430,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-available-machine-types-for-a-repository parameters: + - *241 - *242 - - *243 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -55849,9 +55468,9 @@ paths: type: integer machines: type: array - items: *359 + items: *358 examples: - default: &558 + default: &557 value: total_count: 2 machines: @@ -55868,7 +55487,7 @@ paths: memory_in_bytes: 34359738368 cpus: 8 '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -55891,8 +55510,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: + - *241 - *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. @@ -55979,8 +55598,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: + - *241 - *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 @@ -56028,7 +55647,7 @@ paths: '403': *27 '404': *6 '422': *15 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56049,8 +55668,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#list-repository-secrets parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -56068,7 +55687,7 @@ paths: type: integer secrets: type: array - items: &363 + items: &362 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -56089,9 +55708,9 @@ paths: - created_at - updated_at examples: - default: *360 + default: *359 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56112,16 +55731,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-public-key parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *361 + schema: *360 examples: - default: *362 + default: *361 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -56141,17 +55760,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#get-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 responses: '200': description: Response content: application/json: - schema: *363 + schema: *362 examples: - default: *364 + default: *363 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -56171,9 +55790,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#create-or-update-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 requestBody: required: true content: @@ -56201,7 +55820,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -56225,9 +55844,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/repository-secrets#delete-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 responses: '204': description: Response @@ -56255,8 +55874,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#list-repository-collaborators parameters: + - *241 - *242 - - *243 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -56294,7 +55913,7 @@ paths: application/json: schema: type: array - items: &365 + items: &364 title: Collaborator description: Collaborator type: object @@ -56462,7 +56081,7 @@ paths: admin: false role_name: write headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -56487,9 +56106,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#check-if-a-user-is-a-repository-collaborator parameters: + - *241 - *242 - - *243 - - *121 + - *115 responses: '204': description: Response if user is a collaborator @@ -56531,9 +56150,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#add-a-repository-collaborator parameters: + - *241 - *242 - - *243 - - *121 + - *115 requestBody: required: false content: @@ -56559,7 +56178,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &429 + schema: &428 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -56571,7 +56190,7 @@ paths: format: int64 examples: - 42 - repository: *108 + repository: *102 invitee: anyOf: - type: 'null' @@ -56780,9 +56399,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#remove-a-repository-collaborator parameters: + - *241 - *242 - - *243 - - *121 + - *115 responses: '204': description: No Content when collaborator was removed from the repository. @@ -56811,9 +56430,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: + - *241 - *242 - - *243 - - *121 + - *115 responses: '200': description: if user has admin permissions @@ -56833,7 +56452,7 @@ paths: user: anyOf: - type: 'null' - - *365 + - *364 required: - permission - role_name @@ -56887,8 +56506,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments-for-a-repository parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -56898,7 +56517,7 @@ paths: application/json: schema: type: array - items: &366 + items: &365 title: Commit Comment description: Commit Comment type: object @@ -56939,8 +56558,8 @@ paths: updated_at: type: string format: date-time - author_association: *58 - reactions: *59 + author_association: *53 + reactions: *54 required: - url - html_url @@ -56956,7 +56575,7 @@ paths: - created_at - updated_at examples: - default: &369 + default: &368 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -56990,7 +56609,7 @@ paths: updated_at: '2011-04-14T16:00:49Z' author_association: COLLABORATOR headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57015,17 +56634,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#get-a-commit-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 responses: '200': description: Response content: application/json: - schema: *366 + schema: *365 examples: - default: &370 + default: &369 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -57082,9 +56701,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#update-a-commit-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 requestBody: required: true content: @@ -57106,7 +56725,7 @@ paths: description: Response content: application/json: - schema: *366 + schema: *365 examples: default: value: @@ -57157,9 +56776,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#delete-a-commit-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 responses: '204': description: Response @@ -57180,9 +56799,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 - 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. @@ -57208,11 +56827,11 @@ paths: application/json: schema: type: array - items: *235 + items: *234 examples: - default: *237 + default: *236 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -57231,9 +56850,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 requestBody: required: true content: @@ -57265,16 +56884,16 @@ paths: description: Reaction exists content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '201': description: Reaction created content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '422': *15 x-github: githubCloudOnly: false @@ -57296,10 +56915,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-commit-comment-reaction parameters: + - *241 - *242 - - *243 - - *71 - - *238 + - *66 + - *237 responses: '204': description: Response @@ -57348,8 +56967,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-commits parameters: + - *241 - *242 - - *243 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -57405,9 +57024,9 @@ paths: application/json: schema: type: array - items: *367 + items: *366 examples: - default: &477 + default: &476 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -57477,11 +57096,11 @@ paths: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e headers: - Link: *37 - '500': *39 + Link: *50 + '500': *127 '400': *14 '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57501,9 +57120,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-branches-for-head-commit parameters: + - *241 - *242 - - *243 - - &368 + - &367 name: commit_sha description: The SHA of the commit. in: path @@ -57550,7 +57169,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57575,9 +57194,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#list-commit-comments parameters: + - *241 - *242 - - *243 - - *368 + - *367 - *17 - *18 responses: @@ -57587,11 +57206,11 @@ paths: application/json: schema: type: array - items: *366 + items: *365 examples: - default: *369 + default: *368 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57617,9 +57236,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/comments#create-a-commit-comment parameters: + - *241 - *242 - - *243 - - *368 + - *367 requestBody: required: true content: @@ -57654,9 +57273,9 @@ paths: description: Response content: application/json: - schema: *366 + schema: *365 examples: - default: *370 + default: *369 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -57684,9 +57303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#list-pull-requests-associated-with-a-commit parameters: + - *241 - *242 - - *243 - - *368 + - *367 - *17 - *18 responses: @@ -57696,7 +57315,7 @@ paths: application/json: schema: type: array - items: &468 + items: &467 title: Pull Request Simple description: Pull Request Simple type: object @@ -57816,7 +57435,7 @@ paths: milestone: anyOf: - type: 'null' - - *371 + - *370 active_lock_reason: type: - string @@ -57871,7 +57490,7 @@ paths: type: - array - 'null' - items: *173 + items: *166 head: type: object properties: @@ -57879,7 +57498,7 @@ paths: type: string ref: type: string - repo: *57 + repo: *52 sha: type: string user: @@ -57899,7 +57518,7 @@ paths: type: string ref: type: string - repo: *57 + repo: *52 sha: type: string user: @@ -57915,7 +57534,7 @@ paths: _links: type: object properties: - comments: &372 + comments: &371 title: Link description: Hypermedia Link type: object @@ -57924,13 +57543,13 @@ paths: type: string required: - href - commits: *372 - statuses: *372 - html: *372 - issue: *372 - review_comments: *372 - review_comment: *372 - self: *372 + commits: *371 + statuses: *371 + html: *371 + issue: *371 + review_comments: *371 + review_comment: *371 + self: *371 required: - comments - commits @@ -57940,8 +57559,8 @@ paths: - review_comments - review_comment - self - author_association: *58 - auto_merge: &470 + author_association: *53 + auto_merge: &469 title: Auto merge description: The status of auto merging a pull request. type: @@ -58006,7 +57625,7 @@ paths: - author_association - auto_merge examples: - default: &469 + default: &468 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -58485,8 +58104,8 @@ paths: auto_merge: draft: false headers: - Link: *37 - '409': *128 + Link: *50 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58543,11 +58162,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#get-a-commit parameters: + - *241 - *242 - - *243 - *18 - *17 - - &373 + - &372 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)" @@ -58562,9 +58181,9 @@ paths: description: Response content: application/json: - schema: *367 + schema: *366 examples: - default: &456 + default: &455 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -58650,9 +58269,9 @@ paths: ..... '422': *15 '404': *6 - '500': *39 - '503': *60 - '409': *128 + '500': *127 + '503': *55 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58677,11 +58296,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/runs#list-check-runs-for-a-git-reference parameters: + - *241 - *242 - - *243 + - *372 - *373 - *374 - - *375 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -58715,11 +58334,11 @@ paths: type: integer check_runs: type: array - items: *322 + items: *321 examples: - default: *376 + default: *375 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58742,9 +58361,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/checks/suites#list-check-suites-for-a-git-reference parameters: + - *241 - *242 - - *243 - - *373 + - *372 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -58752,7 +58371,7 @@ paths: schema: type: integer example: 1 - - *374 + - *373 - *17 - *18 responses: @@ -58770,7 +58389,7 @@ paths: type: integer check_suites: type: array - items: *326 + items: *325 examples: default: value: @@ -58945,7 +58564,7 @@ paths: latest_check_runs_count: 1 check_runs_url: https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58970,9 +58589,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#get-the-combined-status-for-a-specific-reference parameters: + - *241 - *242 - - *243 - - *373 + - *372 - *17 - *18 responses: @@ -59043,7 +58662,7 @@ paths: type: string total_count: type: integer - repository: *108 + repository: *102 commit_url: type: string format: uri @@ -59174,9 +58793,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#list-commit-statuses-for-a-reference parameters: + - *241 - *242 - - *243 - - *373 + - *372 - *17 - *18 responses: @@ -59186,7 +58805,7 @@ paths: application/json: schema: type: array - items: &532 + items: &531 title: Status description: The status of a commit. type: object @@ -59266,8 +58885,8 @@ paths: type: User site_admin: false headers: - Link: *37 - '301': *254 + Link: *50 + '301': *253 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59295,8 +58914,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/community#get-community-profile-metrics parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -59329,11 +58948,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *377 + - *376 code_of_conduct_file: anyOf: - type: 'null' - - &378 + - &377 title: Community Health File type: object properties: @@ -59349,23 +58968,23 @@ paths: license: anyOf: - type: 'null' - - *73 + - *68 contributing: anyOf: - type: 'null' - - *378 + - *377 readme: anyOf: - type: 'null' - - *378 + - *377 issue_template: anyOf: - type: 'null' - - *378 + - *377 pull_request_template: anyOf: - type: 'null' - - *378 + - *377 required: - code_of_conduct - code_of_conduct_file @@ -59494,8 +59113,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/commits#compare-two-commits parameters: + - *241 - *242 - - *243 - *18 - *17 - name: basehead @@ -59543,8 +59162,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *367 - merge_base_commit: *367 + base_commit: *366 + merge_base_commit: *366 status: type: string enum: @@ -59568,10 +59187,10 @@ paths: - 6 commits: type: array - items: *367 + items: *366 files: type: array - items: *379 + items: *378 required: - url - html_url @@ -59814,8 +59433,8 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" '404': *6 - '500': *39 - '503': *60 + '500': *127 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59857,8 +59476,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-repository-content parameters: + - *241 - *242 - - *243 - name: path description: path parameter in: path @@ -60009,7 +59628,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &380 + response-if-content-is-a-file: &379 summary: Response if content is a file value: type: file @@ -60146,7 +59765,7 @@ paths: - size - type - url - - &482 + - &481 title: Content File description: Content File type: object @@ -60364,7 +59983,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *380 + response-if-content-is-a-file: *379 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -60433,7 +60052,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *381 + '302': *380 '304': *35 x-github: githubCloudOnly: false @@ -60456,8 +60075,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#create-or-update-file-contents parameters: + - *241 - *242 - - *243 - name: path description: path parameter in: path @@ -60552,7 +60171,7 @@ paths: description: Response content: application/json: - schema: &382 + schema: &381 title: File Commit description: File Commit type: object @@ -60708,7 +60327,7 @@ paths: description: Response content: application/json: - schema: *382 + schema: *381 examples: example-for-creating-a-file: value: @@ -60762,7 +60381,7 @@ paths: schema: oneOf: - *3 - - &411 + - &410 description: Repository rule violation was detected type: object properties: @@ -60783,7 +60402,7 @@ paths: items: type: object properties: - placeholder_id: &524 + placeholder_id: &523 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -60815,8 +60434,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#delete-a-file parameters: + - *241 - *242 - - *243 - name: path description: path parameter in: path @@ -60877,7 +60496,7 @@ paths: description: Response content: application/json: - schema: *382 + schema: *381 examples: default: value: @@ -60911,8 +60530,8 @@ paths: verified_at: '422': *15 '404': *6 - '409': *128 - '503': *60 + '409': *122 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60932,8 +60551,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-contributors parameters: + - *241 - *242 - - *243 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -61034,7 +60653,7 @@ paths: site_admin: false contributions: 32 headers: - Link: *37 + Link: *50 '204': description: Response if repository is empty '403': *27 @@ -61057,21 +60676,21 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: + - *241 - *242 - - *243 - - *137 - - *138 - - *139 - - *140 + - *130 + - *131 + - *132 + - *133 - 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 - - *141 - - *142 - - *40 + - *134 + - *135 + - *37 - name: page description: "**Closing down notice**. Page number of the results to fetch. Use cursor-based pagination with `before` or `after` instead." @@ -61088,10 +60707,10 @@ paths: schema: type: integer default: 30 - - *41 - - *42 - - *143 - - *144 + - *38 + - *39 + - *136 + - *137 responses: '200': description: Response @@ -61099,11 +60718,11 @@ paths: application/json: schema: type: array - items: &385 + items: &384 type: object description: A Dependabot alert. properties: - number: *46 + number: *44 state: type: string description: The state of the Dependabot alert. @@ -61118,7 +60737,7 @@ paths: description: Details for the vulnerable dependency. readOnly: true properties: - package: *43 + package: *40 manifest_path: type: string description: The full path to the dependency manifest file, @@ -61134,13 +60753,13 @@ paths: - development - runtime - - security_advisory: *383 - security_vulnerability: *45 - url: *49 - html_url: *50 - created_at: *47 - updated_at: *48 - dismissed_at: *123 + security_advisory: *382 + security_vulnerability: *42 + url: *47 + html_url: *48 + created_at: *45 + updated_at: *46 + dismissed_at: *117 dismissed_by: anyOf: - type: 'null' @@ -61164,8 +60783,8 @@ paths: description: An optional comment associated with the alert's dismissal. maxLength: 280 - fixed_at: *122 - auto_dismissed_at: *384 + fixed_at: *116 + auto_dismissed_at: *383 required: - number - state @@ -61392,9 +61011,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#get-a-dependabot-alert parameters: + - *241 - *242 - - *243 - - &386 + - &385 name: alert_number in: path description: |- @@ -61403,13 +61022,13 @@ paths: or in `number` fields in the response from the `GET /repos/{owner}/{repo}/dependabot/alerts` operation. required: true - schema: *46 + schema: *44 responses: '200': description: Response content: application/json: - schema: *385 + schema: *384 examples: default: value: @@ -61519,9 +61138,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/alerts#update-a-dependabot-alert parameters: + - *241 - *242 - - *243 - - *386 + - *385 requestBody: required: true content: @@ -61566,7 +61185,7 @@ paths: description: Response content: application/json: - schema: *385 + schema: *384 examples: default: value: @@ -61672,7 +61291,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *128 + '409': *122 '422': *7 x-github: githubCloudOnly: false @@ -61695,8 +61314,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#list-repository-secrets parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -61714,7 +61333,7 @@ paths: type: integer secrets: type: array - items: &389 + items: &388 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -61746,7 +61365,7 @@ paths: created_at: '2020-01-10T10:59:22Z' updated_at: '2020-01-11T11:59:22Z' headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61768,16 +61387,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-public-key parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *387 + schema: *386 examples: - default: *388 + default: *387 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61797,15 +61416,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#get-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 responses: '200': description: Response content: application/json: - schema: *389 + schema: *388 examples: default: value: @@ -61831,9 +61450,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#create-or-update-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 requestBody: required: true content: @@ -61861,7 +61480,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -61885,9 +61504,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/dependabot/secrets#delete-a-repository-secret parameters: + - *241 - *242 - - *243 - - *116 + - *110 responses: '204': description: Response @@ -61909,8 +61528,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: + - *241 - *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 @@ -62060,7 +61679,7 @@ paths: advisory_summary: Ruby OpenID advisory_url: https://github.com/advisories/GHSA-fqfj-cmh6-hj49 headers: - Link: *37 + Link: *50 '404': *6 '403': description: Response if GitHub Advanced Security is not enabled for this @@ -62084,8 +61703,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: + - *241 - *242 - - *243 responses: '200': description: Response @@ -62322,7 +61941,7 @@ paths: spdxElementId: SPDXRef-DOCUMENT relatedSpdxElement: SPDXRef-Repository headers: - Link: *37 + Link: *50 '404': *6 '403': *27 x-github: @@ -62345,8 +61964,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: + - *241 - *242 - - *243 requestBody: required: true content: @@ -62429,7 +62048,7 @@ paths: - version - url additionalProperties: false - metadata: &390 + metadata: &389 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -62468,7 +62087,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *390 + metadata: *389 resolved: type: object description: A collection of resolved package dependencies. @@ -62482,7 +62101,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *390 + metadata: *389 relationship: type: string description: A notation of whether a dependency is requested @@ -62615,8 +62234,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#list-deployments parameters: + - *241 - *242 - - *243 - name: sha description: The SHA recorded at creation time. in: query @@ -62657,11 +62276,11 @@ paths: application/json: schema: type: array - items: *391 + items: *390 examples: - default: *392 + default: *391 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62725,8 +62344,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#create-a-deployment parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -62808,7 +62427,7 @@ paths: description: Response content: application/json: - schema: *391 + schema: *390 examples: simple-example: summary: Simple example @@ -62881,9 +62500,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#get-a-deployment parameters: + - *241 - *242 - - *243 - - &393 + - &392 name: deployment_id description: deployment_id parameter in: path @@ -62895,7 +62514,7 @@ paths: description: Response content: application/json: - schema: *391 + schema: *390 examples: default: value: @@ -62960,9 +62579,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/deployments#delete-a-deployment parameters: + - *241 - *242 - - *243 - - *393 + - *392 responses: '204': description: Response @@ -62984,9 +62603,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#list-deployment-statuses parameters: + - *241 - *242 - - *243 - - *393 + - *392 - *17 - *18 responses: @@ -62996,7 +62615,7 @@ paths: application/json: schema: type: array - items: &394 + items: &393 title: Deployment Status description: The status of a deployment. type: object @@ -63140,7 +62759,7 @@ paths: environment_url: https://test-branch.lab.acme.com log_url: https://example.com/deployment/42/output headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -63160,9 +62779,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#create-a-deployment-status parameters: + - *241 - *242 - - *243 - - *393 + - *392 requestBody: required: true content: @@ -63237,9 +62856,9 @@ paths: description: Response content: application/json: - schema: *394 + schema: *393 examples: - default: &395 + default: &394 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -63295,9 +62914,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/statuses#get-a-deployment-status parameters: + - *241 - *242 - - *243 - - *393 + - *392 - name: status_id in: path required: true @@ -63308,9 +62927,9 @@ paths: description: Response content: application/json: - schema: *394 + schema: *393 examples: - default: *395 + default: *394 '404': *6 x-github: githubCloudOnly: false @@ -63335,8 +62954,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -63393,8 +63012,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#list-environments parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -63412,7 +63031,7 @@ paths: - 5 environments: type: array - items: &397 + items: &396 title: Environment description: Details of a deployment environment type: object @@ -63474,7 +63093,7 @@ paths: type: string examples: - wait_timer - wait_timer: &399 + wait_timer: &398 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -63516,11 +63135,11 @@ paths: items: type: object properties: - type: *396 + type: *395 reviewer: anyOf: - *4 - - *173 + - *166 required: - id - node_id @@ -63543,7 +63162,7 @@ paths: - id - node_id - type - deployment_branch_policy: &400 + deployment_branch_policy: &399 type: - object - 'null' @@ -63660,9 +63279,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#get-an-environment parameters: + - *241 - *242 - - *243 - - &398 + - &397 name: environment_name in: path required: true @@ -63675,9 +63294,9 @@ paths: description: Response content: application/json: - schema: *397 + schema: *396 examples: - default: &401 + default: &400 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -63761,9 +63380,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#create-or-update-an-environment parameters: + - *241 - *242 - - *243 - - *398 + - *397 requestBody: required: false content: @@ -63773,7 +63392,7 @@ paths: - object - 'null' properties: - wait_timer: *399 + wait_timer: *398 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -63792,14 +63411,14 @@ paths: items: type: object properties: - type: *396 + type: *395 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *400 + deployment_branch_policy: *399 additionalProperties: false examples: default: @@ -63819,9 +63438,9 @@ paths: description: Response content: application/json: - schema: *397 + schema: *396 examples: - default: *401 + default: *400 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -63845,9 +63464,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/environments#delete-an-environment parameters: + - *241 - *242 - - *243 - - *398 + - *397 responses: '204': description: Default response @@ -63872,9 +63491,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#list-deployment-branch-policies parameters: + - *241 - *242 - - *243 - - *398 + - *397 - *17 - *18 responses: @@ -63893,7 +63512,7 @@ paths: - 2 branch_policies: type: array - items: &402 + items: &401 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -63954,9 +63573,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: + - *241 - *242 - - *243 - - *398 + - *397 requestBody: required: true content: @@ -64004,9 +63623,9 @@ paths: description: Response content: application/json: - schema: *402 + schema: *401 examples: - example-wildcard: &403 + example-wildcard: &402 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -64048,10 +63667,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: + - *241 - *242 - - *243 - - *398 - - &404 + - *397 + - &403 name: branch_policy_id in: path required: true @@ -64063,9 +63682,9 @@ paths: description: Response content: application/json: - schema: *402 + schema: *401 examples: - default: *403 + default: *402 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64084,10 +63703,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: + - *241 - *242 - - *243 - - *398 - - *404 + - *397 + - *403 requestBody: required: true content: @@ -64116,9 +63735,9 @@ paths: description: Response content: application/json: - schema: *402 + schema: *401 examples: - default: *403 + default: *402 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64137,10 +63756,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: + - *241 - *242 - - *243 - - *398 - - *404 + - *397 + - *403 responses: '204': description: Response @@ -64165,9 +63784,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-all-deployment-protection-rules-for-an-environment parameters: - - *398 - - *243 + - *397 - *242 + - *241 responses: '200': description: List of deployment protection rules @@ -64184,7 +63803,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &405 + items: &404 title: Deployment protection rule description: Deployment protection rule type: object @@ -64206,7 +63825,7 @@ paths: for the environment. examples: - true - app: &406 + app: &405 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -64309,9 +63928,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: - - *398 - - *243 + - *397 - *242 + - *241 requestBody: content: application/json: @@ -64332,9 +63951,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *405 + schema: *404 examples: - default: &407 + default: &406 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -64369,9 +63988,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: - - *398 - - *243 + - *397 - *242 + - *241 - *18 - *17 responses: @@ -64391,7 +64010,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *406 + items: *405 examples: default: value: @@ -64426,10 +64045,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#get-a-custom-deployment-protection-rule parameters: + - *241 - *242 - - *243 - - *398 - - &408 + - *397 + - &407 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -64441,9 +64060,9 @@ paths: description: Response content: application/json: - schema: *405 + schema: *404 examples: - default: *407 + default: *406 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64464,10 +64083,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/deployments/protection-rules#disable-a-custom-protection-rule-for-an-environment parameters: - - *398 - - *243 + - *397 - *242 - - *408 + - *241 + - *407 responses: '204': description: Response @@ -64493,9 +64112,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#list-environment-secrets parameters: + - *241 - *242 - - *243 - - *398 + - *397 - *17 - *18 responses: @@ -64513,11 +64132,11 @@ paths: type: integer secrets: type: array - items: *288 + items: *287 examples: - default: *289 + default: *288 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64540,17 +64159,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-public-key parameters: + - *241 - *242 - - *243 - - *398 + - *397 responses: '200': description: Response content: application/json: - schema: *290 + schema: *289 examples: - default: *291 + default: *290 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64572,18 +64191,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#get-an-environment-secret parameters: + - *241 - *242 - - *243 - - *398 - - *116 + - *397 + - *110 responses: '200': description: Response content: application/json: - schema: *288 + schema: *287 examples: - default: *409 + default: *408 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64605,10 +64224,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#create-or-update-an-environment-secret parameters: + - *241 - *242 - - *243 - - *398 - - *116 + - *397 + - *110 requestBody: required: true content: @@ -64639,7 +64258,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -64665,10 +64284,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/secrets#delete-an-environment-secret parameters: + - *241 - *242 - - *243 - - *398 - - *116 + - *397 + - *110 responses: '204': description: Default response @@ -64693,10 +64312,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#list-environment-variables parameters: + - *241 - *242 - - *243 - - *398 - - *264 + - *397 + - *263 - *18 responses: '200': @@ -64713,11 +64332,11 @@ paths: type: integer variables: type: array - items: *292 + items: *291 examples: - default: *293 + default: *292 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64738,9 +64357,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#create-an-environment-variable parameters: + - *241 - *242 - - *243 - - *398 + - *397 requestBody: required: true content: @@ -64767,7 +64386,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -64792,18 +64411,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#get-an-environment-variable parameters: + - *241 - *242 - - *243 - - *398 - - *119 + - *397 + - *113 responses: '200': description: Response content: application/json: - schema: *292 + schema: *291 examples: - default: *410 + default: *409 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64824,10 +64443,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#update-an-environment-variable parameters: + - *241 - *242 - - *243 - - *119 - - *398 + - *113 + - *397 requestBody: required: true content: @@ -64869,10 +64488,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/actions/variables#delete-an-environment-variable parameters: + - *241 - *242 - - *243 - - *119 - - *398 + - *113 + - *397 responses: '204': description: Response @@ -64894,8 +64513,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-repository-events parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -64905,7 +64524,7 @@ paths: application/json: schema: type: array - items: *83 + items: *78 examples: 200-response: value: @@ -64972,8 +64591,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#list-forks parameters: + - *241 - *242 - - *243 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -64995,7 +64614,7 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: default: value: @@ -65108,7 +64727,7 @@ paths: url: https://api.github.com/licenses/mit node_id: MDc6TGljZW5zZW1pdA== headers: - Link: *37 + Link: *50 '400': *14 x-github: githubCloudOnly: false @@ -65132,8 +64751,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/forks#create-a-fork parameters: + - *241 - *242 - - *243 requestBody: required: false content: @@ -65166,9 +64785,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *252 examples: - default: *255 + default: *254 '400': *14 '422': *15 '403': *27 @@ -65189,8 +64808,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#create-a-blob parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -65241,7 +64860,7 @@ paths: schema: type: string '404': *6 - '409': *128 + '409': *122 '403': *27 '422': description: Validation failed @@ -65249,8 +64868,8 @@ paths: application/json: schema: oneOf: - - *92 - - *411 + - *86 + - *410 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65275,8 +64894,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/blobs#get-a-blob parameters: + - *241 - *242 - - *243 - name: file_sha in: path required: true @@ -65328,7 +64947,7 @@ paths: '404': *6 '422': *15 '403': *27 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65376,8 +64995,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#create-a-commit parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -65486,7 +65105,7 @@ paths: description: Response content: application/json: - schema: &412 + schema: &411 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -65662,7 +65281,7 @@ paths: type: string '422': *15 '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65712,15 +65331,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/commits#get-a-commit-object parameters: + - *241 - *242 - - *243 - - *368 + - *367 responses: '200': description: Response content: application/json: - schema: *412 + schema: *411 examples: default: value: @@ -65751,7 +65370,7 @@ paths: payload: verified_at: '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65776,9 +65395,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#list-matching-references parameters: + - *241 - *242 - - *243 - - &413 + - &412 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. @@ -65795,7 +65414,7 @@ paths: application/json: schema: type: array - items: &414 + items: &413 title: Git Reference description: Git references within a repository type: object @@ -65849,8 +65468,8 @@ paths: sha: 612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: - Link: *37 - '409': *128 + Link: *50 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65871,17 +65490,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#get-a-reference parameters: + - *241 - *242 - - *243 - - *413 + - *412 responses: '200': description: Response content: application/json: - schema: *414 + schema: *413 examples: - default: &415 + default: &414 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -65891,7 +65510,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65910,8 +65529,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#create-a-reference parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -65940,16 +65559,16 @@ paths: description: Response content: application/json: - schema: *414 + schema: *413 examples: - default: *415 + default: *414 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65968,9 +65587,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#update-a-reference parameters: + - *241 - *242 - - *243 - - *413 + - *412 requestBody: required: true content: @@ -65999,11 +65618,11 @@ paths: description: Response content: application/json: - schema: *414 + schema: *413 examples: - default: *415 + default: *414 '422': *15 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66019,14 +65638,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/refs#delete-a-reference parameters: + - *241 - *242 - - *243 - - *413 + - *412 responses: '204': description: Response '422': *15 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66074,8 +65693,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#create-a-tag-object parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -66142,7 +65761,7 @@ paths: description: Response content: application/json: - schema: &417 + schema: &416 title: Git Tag description: Metadata for a Git tag type: object @@ -66198,7 +65817,7 @@ paths: - sha - type - url - verification: *416 + verification: *415 required: - sha - url @@ -66208,7 +65827,7 @@ paths: - tag - message examples: - default: &418 + default: &417 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -66235,7 +65854,7 @@ paths: schema: type: string '422': *15 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66281,8 +65900,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/tags#get-a-tag parameters: + - *241 - *242 - - *243 - name: tag_sha in: path required: true @@ -66293,11 +65912,11 @@ paths: description: Response content: application/json: - schema: *417 + schema: *416 examples: - default: *418 + default: *417 '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66319,8 +65938,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#create-a-tree parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -66394,7 +66013,7 @@ paths: description: Response content: application/json: - schema: &419 + schema: &418 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -66489,7 +66108,7 @@ paths: '422': *15 '404': *6 '403': *27 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66512,8 +66131,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/git/trees#get-a-tree parameters: + - *241 - *242 - - *243 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -66536,7 +66155,7 @@ paths: description: Response content: application/json: - schema: *419 + schema: *418 examples: default-response: summary: Default response @@ -66577,7 +66196,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66595,8 +66214,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-repository-webhooks parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -66606,7 +66225,7 @@ paths: application/json: schema: type: array - items: &420 + items: &419 title: Webhook description: Webhooks for repositories. type: object @@ -66669,7 +66288,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &631 + last_response: &630 title: Hook Response type: object properties: @@ -66727,7 +66346,7 @@ paths: status: unused message: headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -66746,8 +66365,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#create-a-repository-webhook parameters: + - *241 - *242 - - *243 requestBody: required: false content: @@ -66800,9 +66419,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *419 examples: - default: &421 + default: &420 value: type: Repository id: 12345678 @@ -66850,17 +66469,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-repository-webhook parameters: + - *241 - *242 - - *243 - - *150 + - *143 responses: '200': description: Response content: application/json: - schema: *420 + schema: *419 examples: - default: *421 + default: *420 '404': *6 x-github: githubCloudOnly: false @@ -66880,9 +66499,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-repository-webhook parameters: + - *241 - *242 - - *243 - - *150 + - *143 requestBody: required: true content: @@ -66927,9 +66546,9 @@ paths: description: Response content: application/json: - schema: *420 + schema: *419 examples: - default: *421 + default: *420 '422': *15 '404': *6 x-github: @@ -66950,9 +66569,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#delete-a-repository-webhook parameters: + - *241 - *242 - - *243 - - *150 + - *143 responses: '204': description: Response @@ -66976,9 +66595,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-webhook-configuration-for-a-repository parameters: + - *241 - *242 - - *243 - - *150 + - *143 responses: '200': description: Response @@ -67005,9 +66624,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository parameters: + - *241 - *242 - - *243 - - *150 + - *143 requestBody: required: false content: @@ -67051,11 +66670,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: + - *241 - *242 - - *243 - - *150 + - *143 - *17 - - *151 + - *144 responses: '200': description: Response @@ -67063,9 +66682,9 @@ paths: application/json: schema: type: array - items: *152 + items: *145 examples: - default: *153 + default: *146 '400': *14 '422': *15 x-github: @@ -67084,18 +66703,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#get-a-delivery-for-a-repository-webhook parameters: + - *241 - *242 - - *243 - - *150 + - *143 - *16 responses: '200': description: Response content: application/json: - schema: *154 + schema: *147 examples: - default: *155 + default: *148 '400': *14 '422': *15 x-github: @@ -67114,12 +66733,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#redeliver-a-delivery-for-a-repository-webhook parameters: + - *241 - *242 - - *243 - - *150 + - *143 - *16 responses: - '202': *94 + '202': *88 '400': *14 '422': *15 x-github: @@ -67139,9 +66758,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#ping-a-repository-webhook parameters: + - *241 - *242 - - *243 - - *150 + - *143 responses: '204': description: Response @@ -67166,9 +66785,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/webhooks#test-the-push-repository-webhook parameters: + - *241 - *242 - - *243 - - *150 + - *143 responses: '204': description: Response @@ -67226,14 +66845,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-an-import-status parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: &422 + schema: &421 title: Import description: A repository import from an external source. type: object @@ -67340,7 +66959,7 @@ paths: - html_url - authors_url examples: - default: &425 + default: &424 value: vcs: subversion use_lfs: true @@ -67356,7 +66975,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &423 + '503': &422 description: Unavailable due to service under maintenance. content: application/json: @@ -67385,8 +67004,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#start-an-import parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -67434,7 +67053,7 @@ paths: description: Response content: application/json: - schema: *422 + schema: *421 examples: default: value: @@ -67459,7 +67078,7 @@ paths: type: string '422': *15 '404': *6 - '503': *423 + '503': *422 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67487,8 +67106,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-an-import parameters: + - *241 - *242 - - *243 requestBody: required: false content: @@ -67540,7 +67159,7 @@ paths: description: Response content: application/json: - schema: *422 + schema: *421 examples: example-1: summary: Example 1 @@ -67588,7 +67207,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': *423 + '503': *422 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67611,12 +67230,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#cancel-an-import parameters: + - *241 - *242 - - *243 responses: '204': description: Response - '503': *423 + '503': *422 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67642,9 +67261,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-commit-authors parameters: + - *241 - *242 - - *243 - - &581 + - &580 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -67658,7 +67277,7 @@ paths: application/json: schema: type: array - items: &424 + items: &423 title: Porter Author description: Porter Author type: object @@ -67712,7 +67331,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *423 + '503': *422 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67737,8 +67356,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#map-a-commit-author parameters: + - *241 - *242 - - *243 - name: author_id in: path required: true @@ -67768,7 +67387,7 @@ paths: description: Response content: application/json: - schema: *424 + schema: *423 examples: default: value: @@ -67781,7 +67400,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *423 + '503': *422 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67805,8 +67424,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#get-large-files parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -67847,7 +67466,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *423 + '503': *422 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67875,8 +67494,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/source-imports#update-git-lfs-preference parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -67903,11 +67522,11 @@ paths: description: Response content: application/json: - schema: *422 + schema: *421 examples: - default: *425 + default: *424 '422': *15 - '503': *423 + '503': *422 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67930,8 +67549,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -67939,8 +67558,8 @@ paths: application/json: schema: *20 examples: - default: *426 - '301': *254 + default: *425 + '301': *253 '404': *6 x-github: githubCloudOnly: false @@ -67960,8 +67579,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -67969,12 +67588,12 @@ paths: application/json: schema: anyOf: - - *168 + - *161 - type: object properties: {} additionalProperties: false examples: - default: &428 + default: &427 value: limit: collaborators_only origin: repository @@ -67999,13 +67618,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: + - *241 - *242 - - *243 requestBody: required: true content: application/json: - schema: *427 + schema: *426 examples: default: summary: Example request body @@ -68017,9 +67636,9 @@ paths: description: Response content: application/json: - schema: *168 + schema: *161 examples: - default: *428 + default: *427 '409': description: Response x-github: @@ -68041,8 +67660,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -68065,8 +67684,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#list-repository-invitations parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -68076,9 +67695,9 @@ paths: application/json: schema: type: array - items: *429 + items: *428 examples: - default: &574 + default: &573 value: - id: 1 repository: @@ -68192,7 +67811,7 @@ paths: html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -68209,9 +67828,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#update-a-repository-invitation parameters: + - *241 - *242 - - *243 - - *172 + - *165 requestBody: required: false content: @@ -68240,7 +67859,7 @@ paths: description: Response content: application/json: - schema: *429 + schema: *428 examples: default: value: @@ -68371,9 +67990,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#delete-a-repository-invitation parameters: + - *241 - *242 - - *243 - - *172 + - *165 responses: '204': description: Response @@ -68404,8 +68023,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#list-repository-issues parameters: + - *241 - *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 @@ -68445,7 +68064,7 @@ paths: required: false schema: type: string - - *174 + - *167 - name: sort description: What to sort results by. in: query @@ -68457,8 +68076,8 @@ paths: - updated - comments default: created - - *40 - - *62 + - *37 + - *57 - *17 - *18 responses: @@ -68468,9 +68087,9 @@ paths: application/json: schema: type: array - items: *72 + items: *67 examples: - default: &438 + default: &437 value: - id: 1 node_id: MDU6SXNzdWUx @@ -68617,8 +68236,8 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *37 - '301': *254 + Link: *50 + '301': *253 '422': *15 '404': *6 x-github: @@ -68647,8 +68266,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#create-an-issue parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -68729,9 +68348,9 @@ paths: description: Response content: application/json: - schema: *72 + schema: *67 examples: - default: &433 + default: &432 value: id: 1 node_id: MDU6SXNzdWUx @@ -68885,9 +68504,9 @@ paths: '400': *14 '403': *27 '422': *15 - '503': *60 + '503': *55 '404': *6 - '410': *251 + '410': *250 x-github: triggersNotification: true githubCloudOnly: false @@ -68915,9 +68534,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments-for-a-repository parameters: + - *241 - *242 - - *243 - - *81 + - *76 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -68927,7 +68546,7 @@ paths: enum: - asc - desc - - *62 + - *57 - *17 - *18 responses: @@ -68937,9 +68556,9 @@ paths: application/json: schema: type: array - items: *430 + items: *429 examples: - default: &435 + default: &434 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -68970,7 +68589,7 @@ paths: issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347 author_association: COLLABORATOR headers: - Link: *37 + Link: *50 '422': *15 '404': *6 x-github: @@ -68997,17 +68616,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#get-an-issue-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 responses: '200': description: Response content: application/json: - schema: *430 + schema: *429 examples: - default: &431 + default: &430 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -69061,9 +68680,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#update-an-issue-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 requestBody: required: true content: @@ -69085,9 +68704,9 @@ paths: description: Response content: application/json: - schema: *430 + schema: *429 examples: - default: *431 + default: *430 '422': *15 x-github: githubCloudOnly: false @@ -69105,9 +68724,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#delete-an-issue-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 responses: '204': description: Response @@ -69127,9 +68746,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 - 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. @@ -69155,11 +68774,11 @@ paths: application/json: schema: type: array - items: *235 + items: *234 examples: - default: *237 + default: *236 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -69178,9 +68797,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 requestBody: required: true content: @@ -69212,16 +68831,16 @@ paths: description: Reaction exists content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '201': description: Reaction created content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '422': *15 x-github: githubCloudOnly: false @@ -69243,10 +68862,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-comment-reaction parameters: + - *241 - *242 - - *243 - - *71 - - *238 + - *66 + - *237 responses: '204': description: Response @@ -69266,8 +68885,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events-for-a-repository parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -69277,7 +68896,7 @@ paths: application/json: schema: type: array - items: &432 + items: &431 title: Issue Event description: Issue Event type: object @@ -69324,7 +68943,7 @@ paths: issue: anyOf: - type: 'null' - - *72 + - *67 label: title: Issue Event Label description: Issue Event Label @@ -69357,7 +68976,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *173 + requested_team: *166 dismissed_review: title: Issue Event Dismissed Review type: object @@ -69424,7 +69043,7 @@ paths: required: - from - to - author_association: *58 + author_association: *53 lock_reason: type: - string @@ -69598,7 +69217,7 @@ paths: author_association: COLLABORATOR state_reason: completed headers: - Link: *37 + Link: *50 '422': *15 x-github: githubCloudOnly: false @@ -69616,8 +69235,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#get-an-issue-event parameters: + - *241 - *242 - - *243 - name: event_id in: path required: true @@ -69628,7 +69247,7 @@ paths: description: Response content: application/json: - schema: *432 + schema: *431 examples: default: value: @@ -69821,7 +69440,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *251 + '410': *250 '403': *27 x-github: githubCloudOnly: false @@ -69855,9 +69474,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#get-an-issue parameters: + - *241 - *242 - - *243 - - &434 + - &433 name: issue_number description: The number that identifies the issue. in: path @@ -69869,12 +69488,12 @@ paths: description: Response content: application/json: - schema: *72 + schema: *67 examples: - default: *433 - '301': *254 + default: *432 + '301': *253 '404': *6 - '410': *251 + '410': *250 '304': *35 x-github: githubCloudOnly: false @@ -69899,9 +69518,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#update-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: false content: @@ -70009,15 +69628,15 @@ paths: description: Response content: application/json: - schema: *72 + schema: *67 examples: - default: *433 + default: *432 '422': *15 - '503': *60 + '503': *55 '403': *27 - '301': *254 + '301': *253 '404': *6 - '410': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70035,9 +69654,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#add-assignees-to-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: false content: @@ -70063,9 +69682,9 @@ paths: description: Response content: application/json: - schema: *72 + schema: *67 examples: - default: *433 + default: *432 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70081,9 +69700,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/assignees#remove-assignees-from-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: content: application/json: @@ -70108,9 +69727,9 @@ paths: description: Response content: application/json: - schema: *72 + schema: *67 examples: - default: *433 + default: *432 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70132,9 +69751,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: + - *241 - *242 - - *243 - - *434 + - *433 - name: assignee in: path required: true @@ -70174,10 +69793,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#list-issue-comments parameters: + - *241 - *242 - - *243 - - *434 - - *62 + - *433 + - *57 - *17 - *18 responses: @@ -70187,13 +69806,13 @@ paths: application/json: schema: type: array - items: *430 + items: *429 examples: - default: *435 + default: *434 headers: - Link: *37 + Link: *50 '404': *6 - '410': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70222,9 +69841,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/comments#create-an-issue-comment parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: true content: @@ -70246,16 +69865,16 @@ paths: description: Response content: application/json: - schema: *430 + schema: *429 examples: - default: *431 + default: *430 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *251 + '410': *250 '422': *15 '404': *6 x-github: @@ -70275,9 +69894,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/events#list-issue-events parameters: + - *241 - *242 - - *243 - - *434 + - *433 - *17 - *18 responses: @@ -70291,7 +69910,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &439 + - &438 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -70340,7 +69959,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &440 + - &439 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -70468,7 +70087,7 @@ paths: - performed_via_github_app - assignee - assigner - - &441 + - &440 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -70514,7 +70133,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &442 + - &441 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -70560,7 +70179,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &443 + - &442 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -70609,7 +70228,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &444 + - &443 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -70638,7 +70257,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *173 + requested_team: *166 requested_reviewer: *4 required: - review_requester @@ -70651,7 +70270,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &445 + - &444 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -70680,7 +70299,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *173 + requested_team: *166 requested_reviewer: *4 required: - review_requester @@ -70693,7 +70312,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &446 + - &445 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -70749,7 +70368,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &447 + - &446 title: Locked Issue Event description: Locked Issue Event type: object @@ -70794,7 +70413,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &448 + - &447 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -70855,7 +70474,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &449 + - &448 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -70916,7 +70535,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &450 + - &449 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -70977,7 +70596,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &451 + - &450 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -71069,8 +70688,8 @@ paths: name: label color: red headers: - Link: *37 - '410': *251 + Link: *50 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71087,9 +70706,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 - *17 - *18 responses: @@ -71099,7 +70718,7 @@ paths: application/json: schema: type: array - items: &436 + items: &435 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -71154,7 +70773,7 @@ paths: - color - default examples: - default: &437 + default: &436 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -71171,10 +70790,10 @@ paths: color: a2eeef default: false headers: - Link: *37 - '301': *254 + Link: *50 + '301': *253 '404': *6 - '410': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71191,9 +70810,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#add-labels-to-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: false content: @@ -71252,12 +70871,12 @@ paths: application/json: schema: type: array - items: *436 + items: *435 examples: - default: *437 - '301': *254 + default: *436 + '301': *253 '404': *6 - '410': *251 + '410': *250 '422': *15 x-github: githubCloudOnly: false @@ -71274,9 +70893,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#set-labels-for-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: false content: @@ -71336,12 +70955,12 @@ paths: application/json: schema: type: array - items: *436 + items: *435 examples: - default: *437 - '301': *254 + default: *436 + '301': *253 '404': *6 - '410': *251 + '410': *250 '422': *15 x-github: githubCloudOnly: false @@ -71358,15 +70977,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-all-labels-from-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 responses: '204': description: Response - '301': *254 + '301': *253 '404': *6 - '410': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71385,9 +71004,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#remove-a-label-from-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 - name: name in: path required: true @@ -71400,7 +71019,7 @@ paths: application/json: schema: type: array - items: *436 + items: *435 examples: default: value: @@ -71411,9 +71030,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *254 + '301': *253 '404': *6 - '410': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71433,9 +71052,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#lock-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: false content: @@ -71464,7 +71083,7 @@ paths: '204': description: Response '403': *27 - '410': *251 + '410': *250 '404': *6 '422': *15 x-github: @@ -71482,9 +71101,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/issues#unlock-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 responses: '204': description: Response @@ -71506,9 +71125,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 - 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. @@ -71534,13 +71153,13 @@ paths: application/json: schema: type: array - items: *235 + items: *234 examples: - default: *237 + default: *236 headers: - Link: *37 + Link: *50 '404': *6 - '410': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71558,9 +71177,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: true content: @@ -71592,16 +71211,16 @@ paths: description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '201': description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '422': *15 x-github: githubCloudOnly: false @@ -71623,10 +71242,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-an-issue-reaction parameters: + - *241 - *242 - - *243 - - *434 - - *238 + - *433 + - *237 responses: '204': description: Response @@ -71655,9 +71274,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#remove-sub-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: true content: @@ -71679,9 +71298,9 @@ paths: description: Response content: application/json: - schema: *72 + schema: *67 examples: - default: *433 + default: *432 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -71714,9 +71333,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#list-sub-issues parameters: + - *241 - *242 - - *243 - - *434 + - *433 - *17 - *18 responses: @@ -71726,13 +71345,13 @@ paths: application/json: schema: type: array - items: *72 + items: *67 examples: - default: *438 + default: *437 headers: - Link: *37 + Link: *50 '404': *6 - '410': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71760,9 +71379,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#add-sub-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: true content: @@ -71788,16 +71407,16 @@ paths: description: Response content: application/json: - schema: *72 + schema: *67 examples: - default: *433 + default: *432 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *251 + '410': *250 '422': *15 '404': *6 x-github: @@ -71817,9 +71436,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/sub-issues#reprioritize-sub-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 requestBody: required: true content: @@ -71850,13 +71469,13 @@ paths: description: Response content: application/json: - schema: *72 + schema: *67 examples: - default: *433 + default: *432 '403': *27 '404': *6 '422': *7 - '503': *60 + '503': *55 x-github: triggersNotification: true githubCloudOnly: false @@ -71874,9 +71493,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/timeline#list-timeline-events-for-an-issue parameters: + - *241 - *242 - - *243 - - *434 + - *433 - *17 - *18 responses: @@ -71891,6 +71510,7 @@ paths: description: Timeline Event type: object anyOf: + - *438 - *439 - *440 - *441 @@ -71903,7 +71523,6 @@ paths: - *448 - *449 - *450 - - *451 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -71951,12 +71570,12 @@ paths: issue_url: type: string format: uri - author_association: *58 + author_association: *53 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *59 + reactions: *54 required: - event - actor @@ -71987,7 +71606,7 @@ paths: properties: type: type: string - issue: *72 + issue: *67 required: - event - created_at @@ -72203,7 +71822,7 @@ paths: type: string body_text: type: string - author_association: *58 + author_association: *53 required: - event - id @@ -72226,7 +71845,7 @@ paths: type: string comments: type: array - items: &471 + items: &470 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -72331,7 +71950,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *58 + author_association: *53 _links: type: object properties: @@ -72426,7 +72045,7 @@ paths: enum: - line - file - reactions: *59 + reactions: *54 body_html: type: string examples: @@ -72464,7 +72083,7 @@ paths: type: string comments: type: array - items: *366 + items: *365 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -72737,9 +72356,9 @@ paths: type: User site_admin: true headers: - Link: *37 + Link: *50 '404': *6 - '410': *251 + '410': *250 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72756,8 +72375,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#list-deploy-keys parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -72767,7 +72386,7 @@ paths: application/json: schema: type: array - items: &452 + items: &451 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -72818,7 +72437,7 @@ paths: last_used: '2022-01-10T15:53:42Z' enabled: true headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72834,8 +72453,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -72871,9 +72490,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *451 examples: - default: &453 + default: &452 value: id: 1 key: ssh-rsa AAA... @@ -72907,9 +72526,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: + - *241 - *242 - - *243 - - &454 + - &453 name: key_id description: The unique identifier of the key. in: path @@ -72921,9 +72540,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *451 examples: - default: *453 + default: *452 '404': *6 x-github: githubCloudOnly: false @@ -72941,9 +72560,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: + - *241 - *242 - - *243 - - *454 + - *453 responses: '204': description: Response @@ -72963,8 +72582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-a-repository parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -72974,11 +72593,11 @@ paths: application/json: schema: type: array - items: *436 + items: *435 examples: - default: *437 + default: *436 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -72997,8 +72616,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#create-a-label parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -73034,9 +72653,9 @@ paths: description: Response content: application/json: - schema: *436 + schema: *435 examples: - default: &455 + default: &454 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -73068,8 +72687,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#get-a-label parameters: + - *241 - *242 - - *243 - name: name in: path required: true @@ -73080,9 +72699,9 @@ paths: description: Response content: application/json: - schema: *436 + schema: *435 examples: - default: *455 + default: *454 '404': *6 x-github: githubCloudOnly: false @@ -73099,8 +72718,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#update-a-label parameters: + - *241 - *242 - - *243 - name: name in: path required: true @@ -73139,7 +72758,7 @@ paths: description: Response content: application/json: - schema: *436 + schema: *435 examples: default: value: @@ -73165,8 +72784,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#delete-a-label parameters: + - *241 - *242 - - *243 - name: name in: path required: true @@ -73192,8 +72811,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-languages parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -73232,9 +72851,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/licenses/licenses#get-the-license-for-a-repository parameters: + - *241 - *242 - - *243 - - *343 + - *342 responses: '200': description: Response @@ -73300,7 +72919,7 @@ paths: license: anyOf: - type: 'null' - - *73 + - *68 required: - _links - git_url @@ -73381,8 +73000,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#sync-a-fork-branch-with-the-upstream-repository parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -73447,8 +73066,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/branches/branches#merge-a-branch parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -73482,9 +73101,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *367 + schema: *366 examples: - default: *456 + default: *455 '204': description: Response when already merged '404': @@ -73509,8 +73128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#list-milestones parameters: + - *241 - *242 - - *243 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -73551,7 +73170,7 @@ paths: application/json: schema: type: array - items: *371 + items: *370 examples: default: value: @@ -73590,7 +73209,7 @@ paths: closed_at: '2013-02-12T13:22:01Z' due_on: '2012-10-09T23:39:01Z' headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -73607,8 +73226,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#create-a-milestone parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -73648,9 +73267,9 @@ paths: description: Response content: application/json: - schema: *371 + schema: *370 examples: - default: &457 + default: &456 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -73709,9 +73328,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#get-a-milestone parameters: + - *241 - *242 - - *243 - - &458 + - &457 name: milestone_number description: The number that identifies the milestone. in: path @@ -73723,9 +73342,9 @@ paths: description: Response content: application/json: - schema: *371 + schema: *370 examples: - default: *457 + default: *456 '404': *6 x-github: githubCloudOnly: false @@ -73742,9 +73361,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#update-a-milestone parameters: + - *241 - *242 - - *243 - - *458 + - *457 requestBody: required: false content: @@ -73782,9 +73401,9 @@ paths: description: Response content: application/json: - schema: *371 + schema: *370 examples: - default: *457 + default: *456 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73800,9 +73419,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/milestones#delete-a-milestone parameters: + - *241 - *242 - - *243 - - *458 + - *457 responses: '204': description: Response @@ -73823,9 +73442,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/issues/labels#list-labels-for-issues-in-a-milestone parameters: + - *241 - *242 - - *243 - - *458 + - *457 - *17 - *18 responses: @@ -73835,11 +73454,11 @@ paths: application/json: schema: type: array - items: *436 + items: *435 examples: - default: *437 + default: *436 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73856,12 +73475,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: + - *241 - *242 - - *243 + - *458 - *459 + - *57 - *460 - - *62 - - *461 - *17 - *18 responses: @@ -73871,11 +73490,11 @@ paths: application/json: schema: type: array - items: *84 + items: *79 examples: - default: *462 + default: *461 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -73897,8 +73516,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/notifications#mark-repository-notifications-as-read parameters: + - *241 - *242 - - *243 requestBody: required: false content: @@ -73956,14 +73575,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-apiname-pages-site parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: &463 + schema: &462 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -74107,7 +73726,7 @@ paths: - custom_404 - public examples: - default: &464 + default: &463 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -74148,8 +73767,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-apiname-pages-site parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -74204,11 +73823,11 @@ paths: description: Response content: application/json: - schema: *463 + schema: *462 examples: - default: *464 + default: *463 '422': *15 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74229,8 +73848,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#update-information-about-a-apiname-pages-site parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -74309,7 +73928,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74330,14 +73949,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#delete-a-apiname-pages-site parameters: + - *241 - *242 - - *243 responses: '204': description: Response '422': *15 '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74357,8 +73976,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#list-apiname-pages-builds parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -74368,7 +73987,7 @@ paths: application/json: schema: type: array - items: &465 + items: &464 title: Page Build description: Page Build type: object @@ -74441,7 +74060,7 @@ paths: created_at: '2014-02-10T19:00:49Z' updated_at: '2014-02-10T19:00:51Z' headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74460,8 +74079,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#request-a-apiname-pages-build parameters: + - *241 - *242 - - *243 responses: '201': description: Response @@ -74508,16 +74127,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-latest-pages-build parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *465 + schema: *464 examples: - default: &466 + default: &465 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -74565,8 +74184,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-apiname-pages-build parameters: + - *241 - *242 - - *243 - name: build_id in: path required: true @@ -74577,9 +74196,9 @@ paths: description: Response content: application/json: - schema: *465 + schema: *464 examples: - default: *466 + default: *465 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -74599,8 +74218,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#create-a-github-pages-deployment parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -74709,9 +74328,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-the-status-of-a-github-pages-deployment parameters: + - *241 - *242 - - *243 - - &467 + - &466 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -74769,11 +74388,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#cancel-a-github-pages-deployment parameters: + - *241 - *242 - - *243 - - *467 + - *466 responses: - '204': *132 + '204': *126 '404': *6 x-github: githubCloudOnly: false @@ -74798,8 +74417,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pages/pages#get-a-dns-health-check-for-github-pages parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -75067,7 +74686,7 @@ paths: description: Empty response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -75094,8 +74713,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: + - *241 - *242 - - *243 responses: '200': description: Private vulnerability reporting status @@ -75132,10 +74751,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-private-vulnerability-reporting-for-a-repository parameters: + - *241 - *242 - - *243 responses: - '204': *132 + '204': *126 '422': *14 x-github: githubCloudOnly: false @@ -75154,10 +74773,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-private-vulnerability-reporting-for-a-repository parameters: + - *241 - *242 - - *243 responses: - '204': *132 + '204': *126 '422': *14 x-github: githubCloudOnly: false @@ -75178,8 +74797,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-repository-projects parameters: + - *241 - *242 - - *243 - name: state description: Indicates the state of the projects to return. in: query @@ -75200,7 +74819,7 @@ paths: application/json: schema: type: array - items: *202 + items: *196 examples: default: value: @@ -75236,11 +74855,11 @@ paths: created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' headers: - Link: *37 + Link: *50 '401': *23 '403': *27 '404': *6 - '410': *251 + '410': *250 '422': *7 x-github: githubCloudOnly: false @@ -75260,8 +74879,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#create-a-repository-project parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -75287,13 +74906,13 @@ paths: description: Response content: application/json: - schema: *202 + schema: *196 examples: - default: *250 + default: *249 '401': *23 '403': *27 '404': *6 - '410': *251 + '410': *250 '422': *7 x-github: githubCloudOnly: false @@ -75313,8 +74932,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/custom-properties#get-all-custom-property-values-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -75322,7 +74941,7 @@ paths: application/json: schema: type: array - items: *207 + items: *201 examples: default: value: @@ -75353,8 +74972,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: + - *241 - *242 - - *243 requestBody: required: true content: @@ -75366,7 +74985,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *207 + items: *201 required: - properties examples: @@ -75416,8 +75035,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests parameters: + - *241 - *242 - - *243 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -75477,11 +75096,11 @@ paths: application/json: schema: type: array - items: *468 + items: *467 examples: - default: *469 + default: *468 headers: - Link: *37 + Link: *50 '304': *35 '422': *15 x-github: @@ -75511,8 +75130,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#create-a-pull-request parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -75579,7 +75198,7 @@ paths: description: Response content: application/json: - schema: &473 + schema: &472 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -75708,7 +75327,7 @@ paths: milestone: anyOf: - type: 'null' - - *371 + - *370 active_lock_reason: type: - string @@ -75763,7 +75382,7 @@ paths: type: - array - 'null' - items: *187 + items: *181 head: type: object properties: @@ -75771,7 +75390,7 @@ paths: type: string ref: type: string - repo: *57 + repo: *52 sha: type: string user: *4 @@ -75788,7 +75407,7 @@ paths: type: string ref: type: string - repo: *57 + repo: *52 sha: type: string user: *4 @@ -75801,14 +75420,14 @@ paths: _links: type: object properties: - comments: *372 - commits: *372 - statuses: *372 - html: *372 - issue: *372 - review_comments: *372 - review_comment: *372 - self: *372 + comments: *371 + commits: *371 + statuses: *371 + html: *371 + issue: *371 + review_comments: *371 + review_comment: *371 + self: *371 required: - comments - commits @@ -75818,8 +75437,8 @@ paths: - review_comments - review_comment - self - author_association: *58 - auto_merge: *470 + author_association: *53 + auto_merge: *469 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -75921,7 +75540,7 @@ paths: - merged_by - review_comments examples: - default: &474 + default: &473 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -76448,8 +76067,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-in-a-repository parameters: + - *241 - *242 - - *243 - name: sort in: query required: false @@ -76468,7 +76087,7 @@ paths: enum: - asc - desc - - *62 + - *57 - *17 - *18 responses: @@ -76478,9 +76097,9 @@ paths: application/json: schema: type: array - items: *471 + items: *470 examples: - default: &476 + default: &475 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -76532,7 +76151,7 @@ paths: original_line: 2 side: RIGHT headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76557,17 +76176,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *71 + - *66 responses: '200': description: Response content: application/json: - schema: *471 + schema: *470 examples: - default: &472 + default: &471 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -76642,9 +76261,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#update-a-review-comment-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *71 + - *66 requestBody: required: true content: @@ -76666,9 +76285,9 @@ paths: description: Response content: application/json: - schema: *471 + schema: *470 examples: - default: *472 + default: *471 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76684,9 +76303,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#delete-a-review-comment-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *71 + - *66 responses: '204': description: Response @@ -76707,9 +76326,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-pull-request-review-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 - 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. @@ -76735,11 +76354,11 @@ paths: application/json: schema: type: array - items: *235 + items: *234 examples: - default: *237 + default: *236 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -76758,9 +76377,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-pull-request-review-comment parameters: + - *241 - *242 - - *243 - - *71 + - *66 requestBody: required: true content: @@ -76792,16 +76411,16 @@ paths: description: Reaction exists content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '201': description: Reaction created content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '422': *15 x-github: githubCloudOnly: false @@ -76823,10 +76442,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: + - *241 - *242 - - *243 - - *71 - - *238 + - *66 + - *237 responses: '204': description: Response @@ -76869,9 +76488,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#get-a-pull-request parameters: + - *241 - *242 - - *243 - - &475 + - &474 name: pull_number description: The number that identifies the pull request. in: path @@ -76884,9 +76503,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *473 + schema: *472 examples: - default: *474 + default: *473 '304': *35 '404': *6 '406': @@ -76894,8 +76513,8 @@ paths: content: application/json: schema: *3 - '500': *39 - '503': *60 + '500': *127 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76921,9 +76540,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 requestBody: required: false content: @@ -76965,9 +76584,9 @@ paths: description: Response content: application/json: - schema: *473 + schema: *472 examples: - default: *474 + default: *473 '422': *15 '403': *27 x-github: @@ -76989,9 +76608,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-codespace-from-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 requestBody: required: true content: @@ -77052,21 +76671,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '401': *23 '403': *27 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -77092,10 +76711,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#list-review-comments-on-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 - - *81 + - *474 + - *76 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -77105,7 +76724,7 @@ paths: enum: - asc - desc - - *62 + - *57 - *17 - *18 responses: @@ -77115,11 +76734,11 @@ paths: application/json: schema: type: array - items: *471 + items: *470 examples: - default: *476 + default: *475 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77150,9 +76769,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-review-comment-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 requestBody: required: true content: @@ -77258,7 +76877,7 @@ paths: description: Response content: application/json: - schema: *471 + schema: *470 examples: example-for-a-multi-line-comment: value: @@ -77346,10 +76965,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/comments#create-a-reply-for-a-review-comment parameters: + - *241 - *242 - - *243 - - *475 - - *71 + - *474 + - *66 requestBody: required: true content: @@ -77371,7 +76990,7 @@ paths: description: Response content: application/json: - schema: *471 + schema: *470 examples: default: value: @@ -77457,9 +77076,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-commits-on-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 - *17 - *18 responses: @@ -77469,11 +77088,11 @@ paths: application/json: schema: type: array - items: *367 + items: *366 examples: - default: *477 + default: *476 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77501,9 +77120,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#list-pull-requests-files parameters: + - *241 - *242 - - *243 - - *475 + - *474 - *17 - *18 responses: @@ -77513,7 +77132,7 @@ paths: application/json: schema: type: array - items: *379 + items: *378 examples: default: value: @@ -77529,10 +77148,10 @@ paths: patch: "@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test" headers: - Link: *37 + Link: *50 '422': *15 - '500': *39 - '503': *60 + '500': *127 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77551,9 +77170,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#check-if-a-pull-request-has-been-merged parameters: + - *241 - *242 - - *243 - - *475 + - *474 responses: '204': description: Response if pull request has been merged @@ -77576,9 +77195,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#merge-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 requestBody: required: false content: @@ -77690,9 +77309,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#get-all-requested-reviewers-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 responses: '200': description: Response @@ -77708,7 +77327,7 @@ paths: items: *4 teams: type: array - items: *173 + items: *166 required: - users - teams @@ -77749,7 +77368,7 @@ paths: repositories_url: https://api.github.com/teams/1/repos parent: headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77767,9 +77386,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#request-reviewers-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 requestBody: required: false content: @@ -77806,7 +77425,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *467 examples: default: value: @@ -78342,9 +77961,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/review-requests#remove-requested-reviewers-from-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 requestBody: required: true content: @@ -78378,7 +77997,7 @@ paths: description: Response content: application/json: - schema: *468 + schema: *467 examples: default: value: @@ -78883,9 +78502,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-reviews-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 - *17 - *18 responses: @@ -78895,7 +78514,7 @@ paths: application/json: schema: type: array - items: &478 + items: &477 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -78969,7 +78588,7 @@ paths: type: string body_text: type: string - author_association: *58 + author_association: *53 required: - id - node_id @@ -79018,7 +78637,7 @@ paths: commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091 author_association: COLLABORATOR headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79051,9 +78670,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#create-a-review-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 + - *474 requestBody: required: false content: @@ -79143,9 +78762,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *477 examples: - default: &480 + default: &479 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -79208,10 +78827,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#get-a-review-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 - - &479 + - *474 + - &478 name: review_id description: The unique identifier of the review. in: path @@ -79223,9 +78842,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *477 examples: - default: &481 + default: &480 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -79284,10 +78903,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#update-a-review-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 - - *479 + - *474 + - *478 requestBody: required: true content: @@ -79310,7 +78929,7 @@ paths: description: Response content: application/json: - schema: *478 + schema: *477 examples: default: value: @@ -79372,18 +78991,18 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#delete-a-pending-review-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 - - *479 + - *474 + - *478 responses: '200': description: Response content: application/json: - schema: *478 + schema: *477 examples: - default: *480 + default: *479 '422': *7 '404': *6 x-github: @@ -79410,10 +79029,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#list-comments-for-a-pull-request-review parameters: + - *241 - *242 - - *243 - - *475 - - *479 + - *474 + - *478 - *17 - *18 responses: @@ -79507,13 +79126,13 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *58 + author_association: *53 _links: type: object properties: - self: *372 - html: *372 - pull_request: *372 + self: *371 + html: *371 + pull_request: *371 required: - self - html @@ -79522,7 +79141,7 @@ paths: type: string body_html: type: string - reactions: *59 + reactions: *54 side: description: The side of the first line of the range for a multi-line comment. @@ -79635,7 +79254,7 @@ paths: pull_request: href: https://api.github.com/repos/octocat/Hello-World/pulls/1 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -79664,10 +79283,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#dismiss-a-review-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 - - *479 + - *474 + - *478 requestBody: required: true content: @@ -79696,7 +79315,7 @@ paths: description: Response content: application/json: - schema: *478 + schema: *477 examples: default: value: @@ -79759,10 +79378,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/reviews#submit-a-review-for-a-pull-request parameters: + - *241 - *242 - - *243 - - *475 - - *479 + - *474 + - *478 requestBody: required: true content: @@ -79797,9 +79416,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *477 examples: - default: *481 + default: *480 '404': *6 '422': *7 '403': *27 @@ -79821,9 +79440,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/pulls/pulls#update-a-pull-request-branch parameters: + - *241 - *242 - - *243 - - *475 + - *474 requestBody: required: false content: @@ -79887,8 +79506,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme parameters: + - *241 - *242 - - *243 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -79901,9 +79520,9 @@ paths: description: Response content: application/json: - schema: *482 + schema: *481 examples: - default: &483 + default: &482 value: type: file encoding: base64 @@ -79945,8 +79564,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/contents#get-a-repository-readme-for-a-directory parameters: + - *241 - *242 - - *243 - name: dir description: The alternate path to look for a README file in: path @@ -79966,9 +79585,9 @@ paths: description: Response content: application/json: - schema: *482 + schema: *481 examples: - default: *483 + default: *482 '404': *6 '422': *15 x-github: @@ -79990,8 +79609,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#list-releases parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -80001,7 +79620,7 @@ paths: application/json: schema: type: array - items: &484 + items: &483 title: Release description: A release. type: object @@ -80073,7 +79692,7 @@ paths: author: *4 assets: type: array - items: &485 + items: &484 title: Release Asset description: Data related to a release. type: object @@ -80143,7 +79762,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *59 + reactions: *54 required: - assets_url - upload_url @@ -80233,7 +79852,7 @@ paths: type: User site_admin: false headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -80253,8 +79872,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#create-a-release parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -80330,9 +79949,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *483 examples: - default: &488 + default: &487 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -80435,9 +80054,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#get-a-release-asset parameters: + - *241 - *242 - - *243 - - &486 + - &485 name: asset_id description: The unique identifier of the asset. in: path @@ -80449,9 +80068,9 @@ paths: description: Response content: application/json: - schema: *485 + schema: *484 examples: - default: &487 + default: &486 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 @@ -80485,7 +80104,7 @@ paths: type: User site_admin: false '404': *6 - '302': *381 + '302': *380 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80501,9 +80120,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#update-a-release-asset parameters: + - *241 - *242 - - *243 - - *486 + - *485 requestBody: required: false content: @@ -80532,9 +80151,9 @@ paths: description: Response content: application/json: - schema: *485 + schema: *484 examples: - default: *487 + default: *486 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80550,9 +80169,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#delete-a-release-asset parameters: + - *241 - *242 - - *243 - - *486 + - *485 responses: '204': description: Response @@ -80576,8 +80195,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#generate-release-notes-content-for-a-release parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -80663,16 +80282,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-the-latest-release parameters: + - *241 - *242 - - *243 responses: '200': description: Response content: application/json: - schema: *484 + schema: *483 examples: - default: *488 + default: *487 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80689,8 +80308,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release-by-tag-name parameters: + - *241 - *242 - - *243 - name: tag description: tag parameter in: path @@ -80703,9 +80322,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *483 examples: - default: *488 + default: *487 '404': *6 x-github: githubCloudOnly: false @@ -80727,9 +80346,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#get-a-release parameters: + - *241 - *242 - - *243 - - &489 + - &488 name: release_id description: The unique identifier of the release. in: path @@ -80743,9 +80362,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: *484 + schema: *483 examples: - default: *488 + default: *487 '401': description: Unauthorized x-github: @@ -80763,9 +80382,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#update-a-release parameters: + - *241 - *242 - - *243 - - *489 + - *488 requestBody: required: false content: @@ -80829,9 +80448,9 @@ paths: description: Response content: application/json: - schema: *484 + schema: *483 examples: - default: *488 + default: *487 '404': description: Not Found if the discussion category name is invalid content: @@ -80852,9 +80471,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/releases#delete-a-release parameters: + - *241 - *242 - - *243 - - *489 + - *488 responses: '204': description: Response @@ -80874,9 +80493,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/releases/assets#list-release-assets parameters: + - *241 - *242 - - *243 - - *489 + - *488 - *17 - *18 responses: @@ -80886,7 +80505,7 @@ paths: application/json: schema: type: array - items: *485 + items: *484 examples: default: value: @@ -80922,7 +80541,7 @@ paths: type: User site_admin: false headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80966,9 +80585,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: + - *241 - *242 - - *243 - - *489 + - *488 - name: name in: query required: true @@ -80994,7 +80613,7 @@ paths: description: Response for successful upload content: application/json: - schema: *485 + schema: *484 examples: response-for-successful-upload: value: @@ -81048,9 +80667,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-release parameters: + - *241 - *242 - - *243 - - *489 + - *488 - 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. @@ -81074,11 +80693,11 @@ paths: application/json: schema: type: array - items: *235 + items: *234 examples: - default: *237 + default: *236 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -81097,9 +80716,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-release parameters: + - *241 - *242 - - *243 - - *489 + - *488 requestBody: required: true content: @@ -81129,16 +80748,16 @@ paths: description: Reaction exists content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '201': description: Reaction created content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 '422': *15 x-github: githubCloudOnly: false @@ -81160,10 +80779,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#delete-a-release-reaction parameters: + - *241 - *242 - - *243 - - *489 - - *238 + - *488 + - *237 responses: '204': description: Response @@ -81187,9 +80806,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rules#get-rules-for-a-branch parameters: + - *241 - *242 - - *243 - - *310 + - *309 - *17 - *18 responses: @@ -81205,8 +80824,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *490 - - &492 + - *489 + - &491 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -81226,53 +80845,53 @@ paths: type: integer description: The ID of the ruleset that includes this rule. - allOf: + - *490 - *491 + - allOf: - *492 + - *491 - allOf: - *493 - - *492 + - *491 - allOf: - *494 - - *492 + - *491 - allOf: - *495 - - *492 + - *491 - allOf: - *496 - - *492 + - *491 - allOf: - *497 - - *492 + - *491 - allOf: - *498 - - *492 + - *491 - allOf: - *499 - - *492 + - *491 - allOf: - *500 - - *492 + - *491 - allOf: - *501 - - *492 + - *491 - allOf: - *502 - - *492 + - *491 - allOf: - *503 - - *492 + - *491 - allOf: - *504 - - *492 + - *491 - allOf: - *505 - - *492 + - *491 - allOf: - *506 - - *492 - - allOf: - - *507 - - *492 + - *491 examples: default: value: @@ -81311,8 +80930,8 @@ paths: category: repos subcategory: rules parameters: + - *241 - *242 - - *243 - *17 - *18 - name: includes_parents @@ -81323,7 +80942,7 @@ paths: schema: type: boolean default: true - - *508 + - *507 responses: '200': description: Response @@ -81331,7 +80950,7 @@ paths: application/json: schema: type: array - items: *215 + items: *209 examples: default: value: @@ -81362,7 +80981,7 @@ paths: created_at: '2023-08-15T08:43:03Z' updated_at: '2023-09-23T16:29:47Z' '404': *6 - '500': *39 + '500': *127 post: summary: Create a repository ruleset description: Create a ruleset for a repository. @@ -81378,8 +80997,8 @@ paths: category: repos subcategory: rules parameters: + - *241 - *242 - - *243 requestBody: description: Request body required: true @@ -81399,16 +81018,16 @@ paths: - tag - push default: branch - enforcement: *211 + enforcement: *205 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *212 - conditions: *209 + items: *206 + conditions: *203 rules: type: array description: An array of rules within the ruleset. - items: *214 + items: *208 required: - name - enforcement @@ -81439,9 +81058,9 @@ paths: description: Response content: application/json: - schema: *215 + schema: *209 examples: - default: &518 + default: &517 value: id: 42 name: super cool ruleset @@ -81474,7 +81093,7 @@ paths: created_at: '2023-07-15T08:43:03Z' updated_at: '2023-08-23T16:29:47Z' '404': *6 - '500': *39 + '500': *127 "/repos/{owner}/{repo}/rulesets/rule-suites": get: summary: List repository rule suites @@ -81488,12 +81107,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#list-repository-rule-suites parameters: + - *241 - *242 - - *243 + - *508 - *509 - *510 - *511 - - *512 - *17 - *18 responses: @@ -81501,11 +81120,11 @@ paths: description: Response content: application/json: - schema: *513 + schema: *512 examples: - default: *514 + default: *513 '404': *6 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81524,19 +81143,19 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/rule-suites#get-a-repository-rule-suite parameters: + - *241 - *242 - - *243 - - *515 + - *514 responses: '200': description: Response content: application/json: - schema: *516 + schema: *515 examples: - default: *517 + default: *516 '404': *6 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81562,8 +81181,8 @@ paths: category: repos subcategory: rules parameters: + - *241 - *242 - - *243 - name: ruleset_id description: The ID of the ruleset. in: path @@ -81583,11 +81202,11 @@ paths: description: Response content: application/json: - schema: *215 + schema: *209 examples: - default: *518 + default: *517 '404': *6 - '500': *39 + '500': *127 put: summary: Update a repository ruleset description: Update a ruleset for a repository. @@ -81603,8 +81222,8 @@ paths: category: repos subcategory: rules parameters: + - *241 - *242 - - *243 - name: ruleset_id description: The ID of the ruleset. in: path @@ -81629,16 +81248,16 @@ paths: - branch - tag - push - enforcement: *211 + enforcement: *205 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *212 - conditions: *209 + items: *206 + conditions: *203 rules: description: An array of rules within the ruleset. type: array - items: *214 + items: *208 examples: default: value: @@ -81666,11 +81285,11 @@ paths: description: Response content: application/json: - schema: *215 + schema: *209 examples: - default: *518 + default: *517 '404': *6 - '500': *39 + '500': *127 delete: summary: Delete a repository ruleset description: Delete a ruleset for a repository. @@ -81686,8 +81305,8 @@ paths: category: repos subcategory: rules parameters: + - *241 - *242 - - *243 - name: ruleset_id description: The ID of the ruleset. in: path @@ -81698,7 +81317,7 @@ paths: '204': description: Response '404': *6 - '500': *39 + '500': *127 "/repos/{owner}/{repo}/secret-scanning/alerts": get: summary: List secret scanning alerts for a repository @@ -81715,20 +81334,20 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-a-repository parameters: + - *241 - *242 - - *243 - - *217 - - *218 - - *219 - - *220 - - *40 + - *211 + - *212 + - *213 + - *214 + - *37 - *18 - *17 + - *518 - *519 - - *520 - - *221 - - *222 - - *223 + - *215 + - *216 + - *217 responses: '200': description: Response @@ -81736,24 +81355,24 @@ paths: application/json: schema: type: array - items: &523 + items: &522 type: object properties: - number: *46 - created_at: *47 + number: *44 + created_at: *45 updated_at: anyOf: - type: 'null' - - *48 - url: *49 - html_url: *50 + - *46 + url: *47 + html_url: *48 locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. - state: *521 - resolution: *522 + state: *520 + resolution: *521 resolved_at: type: - string @@ -81802,6 +81421,12 @@ paths: anyOf: - type: 'null' - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. push_protection_bypass_request_comment: type: - string @@ -81905,6 +81530,7 @@ paths: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true + push_protection_bypass_request_reviewer_comment: Example response push_protection_bypass_request_comment: Example comment push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment @@ -81927,6 +81553,7 @@ paths: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -81936,7 +81563,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -81958,15 +81585,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-a-secret-scanning-alert parameters: + - *241 - *242 - - *243 - - *341 + - *340 responses: '200': description: Response content: application/json: - schema: *523 + schema: *522 examples: default: value: @@ -81986,6 +81613,7 @@ paths: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -81996,7 +81624,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82017,9 +81645,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert parameters: + - *241 - *242 - - *243 - - *341 + - *340 requestBody: required: true content: @@ -82027,8 +81655,8 @@ paths: schema: type: object properties: - state: *521 - resolution: *522 + state: *520 + resolution: *521 resolution_comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -82047,7 +81675,7 @@ paths: description: Response content: application/json: - schema: *523 + schema: *522 examples: default: value: @@ -82085,6 +81713,7 @@ paths: push_protection_bypassed_by: push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: Example comment @@ -82099,7 +81728,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *60 + '503': *55 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -82121,9 +81750,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#list-locations-for-a-secret-scanning-alert parameters: + - *241 - *242 - - *243 - - *341 + - *340 - *18 - *17 responses: @@ -82134,7 +81763,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &652 + items: &651 type: object properties: type: @@ -82487,11 +82116,11 @@ paths: details: pull_request_review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 headers: - Link: *37 + Link: *50 '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82513,8 +82142,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#create-a-push-protection-bypass parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -82522,14 +82151,14 @@ paths: schema: type: object properties: - reason: &525 + reason: &524 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *524 + placeholder_id: *523 required: - reason - placeholder_id @@ -82546,7 +82175,7 @@ paths: schema: type: object properties: - reason: *525 + reason: *524 expire_at: type: - string @@ -82570,7 +82199,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *60 + '503': *55 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -82590,13 +82219,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: + - *241 - *242 - - *243 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *60 + '503': *55 '200': description: Response content: @@ -82606,7 +82235,7 @@ paths: properties: incremental_scans: type: array - items: &526 + items: &525 description: Information on a single scan performed by secret scanning on the repository type: object @@ -82634,15 +82263,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *526 + items: *525 backfill_scans: type: array - items: *526 + items: *525 custom_pattern_backfill_scans: type: array items: allOf: - - *526 + - *525 - type: object properties: pattern_name: @@ -82712,9 +82341,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: + - *241 - *242 - - *243 - - *40 + - *37 - name: sort description: The property to sort the results by. in: query @@ -82726,8 +82355,8 @@ paths: - updated - published default: created - - *41 - - *42 + - *38 + - *39 - name: per_page description: The number of advisories to return per page. For more information, see "[Using pagination in the REST API](https://docs.github.com/rest/using-the-rest-api/using-pagination-in-the-rest-api)." @@ -82757,9 +82386,9 @@ paths: application/json: schema: type: array - items: *527 + items: *526 examples: - default: *528 + default: *527 '400': *14 '404': *6 x-github: @@ -82782,8 +82411,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-repository-security-advisory parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -82863,7 +82492,7 @@ paths: login: type: string description: The username of the user credited. - type: *226 + type: *220 required: - login - type @@ -82953,9 +82582,9 @@ paths: description: Response content: application/json: - schema: *527 + schema: *526 examples: - default: &530 + default: &529 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -83188,8 +82817,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#privately-report-a-security-vulnerability parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -83302,7 +82931,7 @@ paths: description: Response content: application/json: - schema: *527 + schema: *526 examples: default: value: @@ -83449,17 +83078,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#get-a-repository-security-advisory parameters: + - *241 - *242 - - *243 - - *529 + - *528 responses: '200': description: Response content: application/json: - schema: *527 + schema: *526 examples: - default: *530 + default: *529 '403': *27 '404': *6 x-github: @@ -83483,9 +83112,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#update-a-repository-security-advisory parameters: + - *241 - *242 - - *243 - - *529 + - *528 requestBody: required: true content: @@ -83565,7 +83194,7 @@ paths: login: type: string description: The username of the user credited. - type: *226 + type: *220 required: - login - type @@ -83656,17 +83285,17 @@ paths: description: Response content: application/json: - schema: *527 + schema: *526 examples: - default: *530 - add_credit: *530 + default: *529 + add_credit: *529 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *92 + schema: *86 examples: invalid_state_transition: value: @@ -83697,11 +83326,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: + - *241 - *242 - - *243 - - *529 + - *528 responses: - '202': *94 + '202': *88 '400': *14 '403': *27 '404': *6 @@ -83726,17 +83355,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/security-advisories/repository-advisories#create-a-temporary-private-fork parameters: + - *241 - *242 - - *243 - - *529 + - *528 responses: '202': description: Response content: application/json: - schema: *253 + schema: *252 examples: - default: *255 + default: *254 '400': *14 '422': *15 '403': *27 @@ -83762,8 +83391,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-stargazers parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -83837,7 +83466,7 @@ paths: type: User site_admin: false headers: - Link: *37 + Link: *50 '422': *15 x-github: githubCloudOnly: false @@ -83859,8 +83488,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-activity parameters: + - *241 - *242 - - *243 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -83869,7 +83498,7 @@ paths: application/json: schema: type: array - items: &531 + items: &530 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -83881,8 +83510,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *94 - '204': *132 + '202': *88 + '204': *126 '422': description: Repository contains more than 10,000 commits x-github: @@ -83902,8 +83531,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-last-year-of-commit-activity parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -83953,8 +83582,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *94 - '204': *132 + '202': *88 + '204': *126 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83981,8 +83610,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-all-contributor-commit-activity parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -84053,8 +83682,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *94 - '204': *132 + '202': *88 + '204': *126 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84076,8 +83705,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-weekly-commit-count parameters: + - *241 - *242 - - *243 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -84231,8 +83860,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/statistics#get-the-hourly-commit-count-for-each-day parameters: + - *241 - *242 - - *243 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -84242,7 +83871,7 @@ paths: application/json: schema: type: array - items: *531 + items: *530 examples: default: value: @@ -84255,7 +83884,7 @@ paths: - - 0 - 2 - 21 - '204': *132 + '204': *126 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84275,8 +83904,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/commits/statuses#create-a-commit-status parameters: + - *241 - *242 - - *243 - name: sha in: path required: true @@ -84332,7 +83961,7 @@ paths: description: Response content: application/json: - schema: *532 + schema: *531 examples: default: value: @@ -84386,8 +84015,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-watchers parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -84399,9 +84028,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84419,14 +84048,14 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#get-a-repository-subscription parameters: + - *241 - *242 - - *243 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &533 + schema: &532 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -84499,8 +84128,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#set-a-repository-subscription parameters: + - *241 - *242 - - *243 requestBody: required: false content: @@ -84526,7 +84155,7 @@ paths: description: Response content: application/json: - schema: *533 + schema: *532 examples: default: value: @@ -84553,8 +84182,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#delete-a-repository-subscription parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -84574,8 +84203,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-tags parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -84634,7 +84263,7 @@ paths: tarball_url: https://github.com/octocat/Hello-World/tarball/v0.1 node_id: MDQ6VXNlcjE= headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -84657,8 +84286,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/tags#closing-down---list-tag-protection-states-for-a-repository parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -84666,7 +84295,7 @@ paths: application/json: schema: type: array - items: &534 + items: &533 title: Tag protection description: Tag protection type: object @@ -84723,8 +84352,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: + - *241 - *242 - - *243 requestBody: required: true content: @@ -84747,7 +84376,7 @@ paths: description: Response content: application/json: - schema: *534 + schema: *533 examples: default: value: @@ -84778,8 +84407,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: + - *241 - *242 - - *243 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -84816,8 +84445,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: + - *241 - *242 - - *243 - name: ref in: path required: true @@ -84853,8 +84482,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repository-teams parameters: + - *241 - *242 - - *243 - *17 - *18 responses: @@ -84864,11 +84493,11 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - default: *188 + default: *182 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -84886,8 +84515,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#get-all-repository-topics parameters: + - *241 - *242 - - *243 - *18 - *17 responses: @@ -84895,7 +84524,7 @@ paths: description: Response content: application/json: - schema: &535 + schema: &534 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -84907,7 +84536,7 @@ paths: required: - names examples: - default: &536 + default: &535 value: names: - octocat @@ -84930,8 +84559,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#replace-all-repository-topics parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -84962,9 +84591,9 @@ paths: description: Response content: application/json: - schema: *535 + schema: *534 examples: - default: *536 + default: *535 '404': *6 '422': *7 x-github: @@ -84985,9 +84614,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-repository-clones parameters: + - *241 - *242 - - *243 - - &537 + - &536 name: per description: The time frame to display results for. in: query @@ -85018,7 +84647,7 @@ paths: - 128 clones: type: array - items: &538 + items: &537 title: Traffic type: object properties: @@ -85105,8 +84734,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-paths parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -85200,8 +84829,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-top-referral-sources parameters: + - *241 - *242 - - *243 responses: '200': description: Response @@ -85264,9 +84893,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/metrics/traffic#get-page-views parameters: + - *241 - *242 - - *243 - - *537 + - *536 responses: '200': description: Response @@ -85287,7 +84916,7 @@ paths: - 3782 views: type: array - items: *538 + items: *537 required: - uniques - count @@ -85364,8 +84993,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#transfer-a-repository parameters: + - *241 - *242 - - *243 requestBody: required: true content: @@ -85401,7 +85030,7 @@ paths: description: Response content: application/json: - schema: *108 + schema: *102 examples: default: value: @@ -85639,8 +85268,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#check-if-vulnerability-alerts-are-enabled-for-a-repository parameters: + - *241 - *242 - - *243 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -85663,8 +85292,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#enable-vulnerability-alerts parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -85686,8 +85315,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#disable-vulnerability-alerts parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -85713,8 +85342,8 @@ paths: url: https://docs.github.com/rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: + - *241 - *242 - - *243 - name: ref in: path required: true @@ -85806,9 +85435,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *252 examples: - default: *255 + default: *254 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -85849,7 +85478,7 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: default: value: @@ -86038,7 +85667,7 @@ paths: html_url: type: string format: uri - repository: *108 + repository: *102 score: type: number file_size: @@ -86057,7 +85686,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &539 + text_matches: &538 title: Search Result Text Matches type: array items: @@ -86172,7 +85801,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *35 - '503': *60 + '503': *55 '422': *15 '403': *27 x-github: @@ -86220,7 +85849,7 @@ paths: enum: - author-date - committer-date - - &540 + - &539 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 @@ -86289,7 +85918,7 @@ paths: committer: anyOf: - type: 'null' - - *308 + - *307 comment_count: type: integer message: @@ -86308,7 +85937,7 @@ paths: url: type: string format: uri - verification: *416 + verification: *415 required: - author - committer @@ -86323,7 +85952,7 @@ paths: committer: anyOf: - type: 'null' - - *308 + - *307 parents: type: array items: @@ -86335,12 +85964,12 @@ paths: type: string sha: type: string - repository: *108 + repository: *102 score: type: number node_id: type: string - text_matches: *539 + text_matches: *538 required: - sha - node_id @@ -86532,7 +86161,7 @@ paths: - interactions - created - updated - - *540 + - *539 - *17 - *18 responses: @@ -86648,7 +86277,7 @@ paths: milestone: anyOf: - type: 'null' - - *371 + - *370 comments: type: integer created_at: @@ -86662,7 +86291,7 @@ paths: - string - 'null' format: date-time - text_matches: *539 + text_matches: *538 pull_request: type: object properties: @@ -86700,10 +86329,10 @@ paths: type: string score: type: number - author_association: *58 + author_association: *53 draft: type: boolean - repository: *57 + repository: *52 body_html: type: string body_text: @@ -86715,7 +86344,7 @@ paths: anyOf: - type: 'null' - *5 - reactions: *59 + reactions: *54 required: - assignee - closed_at @@ -86831,7 +86460,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *60 + '503': *55 '422': *15 '304': *35 '403': *27 @@ -86884,7 +86513,7 @@ paths: enum: - created - updated - - *540 + - *539 - *17 - *18 responses: @@ -86929,7 +86558,7 @@ paths: - 'null' score: type: number - text_matches: *539 + text_matches: *538 required: - id - node_id @@ -87014,7 +86643,7 @@ paths: - forks - help-wanted-issues - updated - - *540 + - *539 - *17 - *18 responses: @@ -87233,7 +86862,7 @@ paths: license: anyOf: - type: 'null' - - *73 + - *68 permissions: type: object properties: @@ -87251,7 +86880,7 @@ paths: - admin - pull - push - text_matches: *539 + text_matches: *538 temp_clone_token: type: string allow_merge_commit: @@ -87454,7 +87083,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *60 + '503': *55 '422': *15 '304': *35 x-github: @@ -87559,7 +87188,7 @@ paths: - string - 'null' format: uri - text_matches: *539 + text_matches: *538 related: type: - array @@ -87752,7 +87381,7 @@ paths: - followers - repositories - joined - - *540 + - *539 - *17 - *18 responses: @@ -87862,7 +87491,7 @@ paths: type: - boolean - 'null' - text_matches: *539 + text_matches: *538 blog: type: - string @@ -87924,7 +87553,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *35 - '503': *60 + '503': *55 '422': *15 x-github: githubCloudOnly: false @@ -87944,7 +87573,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#get-a-team-legacy parameters: - - &541 + - &540 name: team_id description: The unique identifier of the team. in: path @@ -87956,9 +87585,9 @@ paths: description: Response content: application/json: - schema: *227 + schema: *226 examples: - default: *228 + default: *227 '404': *6 x-github: githubCloudOnly: false @@ -87985,7 +87614,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#update-a-team-legacy parameters: - - *541 + - *540 requestBody: required: true content: @@ -88049,16 +87678,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *227 + schema: *226 examples: - default: *228 + default: *227 '201': description: Response content: application/json: - schema: *227 + schema: *226 examples: - default: *228 + default: *227 '404': *6 '422': *15 '403': *27 @@ -88086,7 +87715,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#delete-a-team-legacy parameters: - - *541 + - *540 responses: '204': description: Response @@ -88117,8 +87746,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#list-discussions-legacy parameters: - - *541 - - *40 + - *540 + - *37 - *17 - *18 responses: @@ -88128,11 +87757,11 @@ paths: application/json: schema: type: array - items: *229 + items: *228 examples: - default: *542 + default: *541 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88159,7 +87788,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#create-a-discussion-legacy parameters: - - *541 + - *540 requestBody: required: true content: @@ -88193,9 +87822,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *228 examples: - default: *230 + default: *229 x-github: triggersNotification: true githubCloudOnly: false @@ -88222,16 +87851,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#get-a-discussion-legacy parameters: - - *541 - - *231 + - *540 + - *230 responses: '200': description: Response content: application/json: - schema: *229 + schema: *228 examples: - default: *230 + default: *229 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88256,8 +87885,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#update-a-discussion-legacy parameters: - - *541 - - *231 + - *540 + - *230 requestBody: required: false content: @@ -88280,9 +87909,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *228 examples: - default: *543 + default: *542 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88307,8 +87936,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussions#delete-a-discussion-legacy parameters: - - *541 - - *231 + - *540 + - *230 responses: '204': description: Response @@ -88337,9 +87966,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *541 - - *231 - - *40 + - *540 + - *230 + - *37 - *17 - *18 responses: @@ -88349,11 +87978,11 @@ paths: application/json: schema: type: array - items: *232 + items: *231 examples: - default: *544 + default: *543 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88380,8 +88009,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *541 - - *231 + - *540 + - *230 requestBody: required: true content: @@ -88403,9 +88032,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *231 examples: - default: *233 + default: *232 x-github: triggersNotification: true githubCloudOnly: false @@ -88432,17 +88061,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *541 - - *231 - - *234 + - *540 + - *230 + - *233 responses: '200': description: Response content: application/json: - schema: *232 + schema: *231 examples: - default: *233 + default: *232 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88467,9 +88096,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *541 - - *231 - - *234 + - *540 + - *230 + - *233 requestBody: required: true content: @@ -88491,9 +88120,9 @@ paths: description: Response content: application/json: - schema: *232 + schema: *231 examples: - default: *545 + default: *544 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88518,9 +88147,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *541 - - *231 - - *234 + - *540 + - *230 + - *233 responses: '204': description: Response @@ -88549,9 +88178,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-comment-legacy parameters: - - *541 - - *231 - - *234 + - *540 + - *230 + - *233 - 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. @@ -88577,11 +88206,11 @@ paths: application/json: schema: type: array - items: *235 + items: *234 examples: - default: *237 + default: *236 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88608,9 +88237,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-comment-legacy parameters: - - *541 - - *231 - - *234 + - *540 + - *230 + - *233 requestBody: required: true content: @@ -88642,9 +88271,9 @@ paths: description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88670,8 +88299,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#list-reactions-for-a-team-discussion-legacy parameters: - - *541 - - *231 + - *540 + - *230 - 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. @@ -88697,11 +88326,11 @@ paths: application/json: schema: type: array - items: *235 + items: *234 examples: - default: *237 + default: *236 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88728,8 +88357,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/reactions/reactions#create-reaction-for-a-team-discussion-legacy parameters: - - *541 - - *231 + - *540 + - *230 requestBody: required: true content: @@ -88761,9 +88390,9 @@ paths: description: Response content: application/json: - schema: *235 + schema: *234 examples: - default: *236 + default: *235 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -88787,7 +88416,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-pending-team-invitations-legacy parameters: - - *541 + - *540 - *17 - *18 responses: @@ -88797,11 +88426,11 @@ paths: application/json: schema: type: array - items: *170 + items: *163 examples: - default: *171 + default: *164 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88825,7 +88454,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#list-team-members-legacy parameters: - - *541 + - *540 - name: role description: Filters members returned by their role in the team. in: query @@ -88848,9 +88477,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -88876,8 +88505,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-member-legacy parameters: - - *541 - - *121 + - *540 + - *115 responses: '204': description: if user is a member @@ -88913,8 +88542,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-team-member-legacy parameters: - - *541 - - *121 + - *540 + - *115 responses: '204': description: Response @@ -88953,8 +88582,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-member-legacy parameters: - - *541 - - *121 + - *540 + - *115 responses: '204': description: Response @@ -88990,16 +88619,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#get-team-membership-for-a-user-legacy parameters: - - *541 - - *121 + - *540 + - *115 responses: '200': description: Response content: application/json: - schema: *239 + schema: *238 examples: - response-if-user-is-a-team-maintainer: *546 + response-if-user-is-a-team-maintainer: *545 '404': *6 x-github: githubCloudOnly: false @@ -89032,8 +88661,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#add-or-update-team-membership-for-a-user-legacy parameters: - - *541 - - *121 + - *540 + - *115 requestBody: required: false content: @@ -89058,9 +88687,9 @@ paths: description: Response content: application/json: - schema: *239 + schema: *238 examples: - response-if-users-membership-with-team-is-now-pending: *547 + response-if-users-membership-with-team-is-now-pending: *546 '403': description: Forbidden if team synchronization is set up '422': @@ -89094,8 +88723,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/members#remove-team-membership-for-a-user-legacy parameters: - - *541 - - *121 + - *540 + - *115 responses: '204': description: Response @@ -89124,7 +88753,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-projects-legacy parameters: - - *541 + - *540 - *17 - *18 responses: @@ -89134,11 +88763,11 @@ paths: application/json: schema: type: array - items: *240 + items: *239 examples: - default: *548 + default: *547 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -89163,16 +88792,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-project-legacy parameters: - - *541 - - *241 + - *540 + - *240 responses: '200': description: Response content: application/json: - schema: *240 + schema: *239 examples: - default: *549 + default: *548 '404': description: Not Found if project is not managed by this team x-github: @@ -89197,8 +88826,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-project-permissions-legacy parameters: - - *541 - - *241 + - *540 + - *240 requestBody: required: false content: @@ -89266,8 +88895,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-project-from-a-team-legacy parameters: - - *541 - - *241 + - *540 + - *240 responses: '204': description: Response @@ -89294,7 +88923,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-team-repositories-legacy parameters: - - *541 + - *540 - *17 - *18 responses: @@ -89304,11 +88933,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -89336,15 +88965,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#check-team-permissions-for-a-repository-legacy parameters: - - *541 + - *540 + - *241 - *242 - - *243 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *550 + schema: *549 examples: alternative-response-with-extra-repository-information: value: @@ -89495,9 +89124,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#add-or-update-team-repository-permissions-legacy parameters: - - *541 + - *540 + - *241 - *242 - - *243 requestBody: required: false content: @@ -89547,9 +89176,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#remove-a-repository-from-a-team-legacy parameters: - - *541 + - *540 + - *241 - *242 - - *243 responses: '204': description: Response @@ -89574,7 +89203,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/teams/teams#list-child-teams-legacy parameters: - - *541 + - *540 - *17 - *18 responses: @@ -89584,11 +89213,11 @@ paths: application/json: schema: type: array - items: *173 + items: *166 examples: - response-if-child-teams-exist: *551 + response-if-child-teams-exist: *550 headers: - Link: *37 + Link: *50 '404': *6 '403': *27 '422': *15 @@ -89619,7 +89248,7 @@ paths: application/json: schema: oneOf: - - &553 + - &552 title: Private User description: Private User type: object @@ -89869,7 +89498,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *552 + - *551 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -90029,7 +89658,7 @@ paths: description: Response content: application/json: - schema: *553 + schema: *552 examples: default: value: @@ -90108,7 +89737,7 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 '304': *35 '404': *6 '403': *27 @@ -90131,7 +89760,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: - - *121 + - *115 responses: '204': description: If the user is blocked @@ -90159,7 +89788,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#block-a-user parameters: - - *121 + - *115 responses: '204': description: Response @@ -90183,7 +89812,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/blocking#unblock-a-user parameters: - - *121 + - *115 responses: '204': description: Response @@ -90232,11 +89861,11 @@ paths: type: integer codespaces: type: array - items: *177 + items: *170 examples: - default: *178 + default: *171 '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -90373,21 +90002,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '401': *23 '403': *27 '404': *6 - '503': *60 + '503': *55 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -90427,7 +90056,7 @@ paths: type: integer secrets: type: array - items: &554 + items: &553 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -90469,9 +90098,9 @@ paths: - visibility - selected_repositories_url examples: - default: *360 + default: *359 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -90541,13 +90170,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#get-a-secret-for-the-authenticated-user parameters: - - *116 + - *110 responses: '200': description: Response content: application/json: - schema: *554 + schema: *553 examples: default: value: @@ -90577,7 +90206,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#create-or-update-a-secret-for-the-authenticated-user parameters: - - *116 + - *110 requestBody: required: true content: @@ -90622,7 +90251,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -90650,7 +90279,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#delete-a-secret-for-the-authenticated-user parameters: - - *116 + - *110 responses: '204': description: Response @@ -90675,7 +90304,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#list-selected-repositories-for-a-user-secret parameters: - - *116 + - *110 responses: '200': description: Response @@ -90691,13 +90320,13 @@ paths: type: integer repositories: type: array - items: *108 + items: *102 examples: - default: *555 + default: *554 '401': *23 '403': *27 '404': *6 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -90718,7 +90347,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#set-selected-repositories-for-a-user-secret parameters: - - *116 + - *110 requestBody: required: true content: @@ -90750,7 +90379,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -90772,7 +90401,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#add-a-selected-repository-to-a-user-secret parameters: - - *116 + - *110 - name: repository_id in: path required: true @@ -90784,7 +90413,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -90805,7 +90434,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/secrets#remove-a-selected-repository-from-a-user-secret parameters: - - *116 + - *110 - name: repository_id in: path required: true @@ -90817,7 +90446,7 @@ paths: '401': *23 '403': *27 '404': *6 - '500': *39 + '500': *127 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -90837,17 +90466,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-a-codespace-for-the-authenticated-user parameters: - - *179 + - *172 responses: '200': description: Response content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -90871,7 +90500,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#update-a-codespace-for-the-authenticated-user parameters: - - *179 + - *172 requestBody: required: false content: @@ -90901,9 +90530,9 @@ paths: description: Response content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '401': *23 '403': *27 '404': *6 @@ -90925,11 +90554,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#delete-a-codespace-for-the-authenticated-user parameters: - - *179 + - *172 responses: - '202': *94 + '202': *88 '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -90954,13 +90583,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#export-a-codespace-for-the-authenticated-user parameters: - - *179 + - *172 responses: '202': description: Response content: application/json: - schema: &556 + schema: &555 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -91013,7 +90642,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &557 + default: &556 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -91021,7 +90650,7 @@ paths: sha: fd95a81ca01e48ede9f39c799ecbcef817b8a3b2 id: latest export_url: https://api.github.com/user/codespaces/:name/exports/latest - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -91045,7 +90674,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *179 + - *172 - name: export_id in: path required: true @@ -91058,9 +90687,9 @@ paths: description: Response content: application/json: - schema: *556 + schema: *555 examples: - default: *557 + default: *556 '404': *6 x-github: githubCloudOnly: false @@ -91081,7 +90710,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *179 + - *172 responses: '200': description: Response @@ -91097,11 +90726,11 @@ paths: type: integer machines: type: array - items: *359 + items: *358 examples: - default: *558 + default: *557 '304': *35 - '500': *39 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -91128,7 +90757,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#create-a-repository-from-an-unpublished-codespace parameters: - - *179 + - *172 requestBody: required: true content: @@ -91184,11 +90813,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *253 + repository: *252 machine: anyOf: - type: 'null' - - *359 + - *358 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -91985,17 +91614,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#start-a-codespace-for-the-authenticated-user parameters: - - *179 + - *172 responses: '200': description: Response content: application/json: - schema: *177 + schema: *170 examples: - default: *358 + default: *357 '304': *35 - '500': *39 + '500': *127 '400': *14 '401': *23 '402': @@ -92005,7 +91634,7 @@ paths: schema: *3 '403': *27 '404': *6 - '409': *128 + '409': *122 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -92025,16 +91654,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/codespaces/codespaces#stop-a-codespace-for-the-authenticated-user parameters: - - *179 + - *172 responses: '200': description: Response content: application/json: - schema: *177 + schema: *170 examples: - default: *358 - '500': *39 + default: *357 + '500': *127 '401': *23 '403': *27 '404': *6 @@ -92063,9 +91692,9 @@ paths: application/json: schema: type: array - items: *189 + items: *183 examples: - default: &571 + default: &570 value: - id: 197 name: hello_docker @@ -92166,7 +91795,7 @@ paths: application/json: schema: type: array - items: &559 + items: &558 title: Email description: Email type: object @@ -92236,16 +91865,16 @@ paths: application/json: schema: type: array - items: *559 + items: *558 examples: - default: &573 + default: &572 value: - email: octocat@github.com verified: true primary: true visibility: public headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -92315,7 +91944,7 @@ paths: application/json: schema: type: array - items: *559 + items: *558 examples: default: value: @@ -92427,9 +92056,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -92460,9 +92089,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -92482,7 +92111,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: - - *121 + - *115 responses: '204': description: if the person is followed by the authenticated user @@ -92512,7 +92141,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#follow-a-user parameters: - - *121 + - *115 responses: '204': description: Response @@ -92537,7 +92166,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#unfollow-a-user parameters: - - *121 + - *115 responses: '204': description: Response @@ -92573,7 +92202,7 @@ paths: application/json: schema: type: array - items: &560 + items: &559 title: GPG Key description: A unique encryption key type: object @@ -92718,7 +92347,7 @@ paths: - subkeys - revoked examples: - default: &584 + default: &583 value: - id: 3 name: Octocat's GPG Key @@ -92750,7 +92379,7 @@ paths: revoked: false raw_key: string headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -92803,9 +92432,9 @@ paths: description: Response content: application/json: - schema: *560 + schema: *559 examples: - default: &561 + default: &560 value: id: 3 name: Octocat's GPG Key @@ -92862,7 +92491,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - - &562 + - &561 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -92874,9 +92503,9 @@ paths: description: Response content: application/json: - schema: *560 + schema: *559 examples: - default: *561 + default: *560 '404': *6 '304': *35 '403': *27 @@ -92899,7 +92528,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - - *562 + - *561 responses: '204': description: Response @@ -93042,7 +92671,7 @@ paths: suspended_at: suspended_by: headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -93088,11 +92717,11 @@ paths: type: string repositories: type: array - items: *57 + items: *52 examples: - default: *563 + default: *562 headers: - Link: *37 + Link: *50 '404': *6 '403': *27 '304': *35 @@ -93115,7 +92744,7 @@ paths: url: https://docs.github.com/rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *99 + - *93 responses: '204': description: Response @@ -93141,7 +92770,7 @@ paths: url: https://docs.github.com/rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *99 + - *93 responses: '204': description: Response @@ -93175,12 +92804,12 @@ paths: application/json: schema: anyOf: - - *168 + - *161 - type: object properties: {} additionalProperties: false examples: - default: *169 + default: *162 '204': description: Response when there are no restrictions x-github: @@ -93204,7 +92833,7 @@ paths: required: true content: application/json: - schema: *427 + schema: *426 examples: default: value: @@ -93215,7 +92844,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *161 examples: default: value: @@ -93296,7 +92925,7 @@ paths: - closed - all default: open - - *174 + - *167 - name: sort description: What to sort results by. in: query @@ -93308,8 +92937,8 @@ paths: - updated - comments default: created - - *40 - - *62 + - *37 + - *57 - *17 - *18 responses: @@ -93319,11 +92948,11 @@ paths: application/json: schema: type: array - items: *72 + items: *67 examples: - default: *175 + default: *168 headers: - Link: *37 + Link: *50 '404': *6 '304': *35 x-github: @@ -93354,7 +92983,7 @@ paths: application/json: schema: type: array - items: &564 + items: &563 title: Key description: Key type: object @@ -93401,7 +93030,7 @@ paths: verified: false read_only: false headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -93452,9 +93081,9 @@ paths: description: Response content: application/json: - schema: *564 + schema: *563 examples: - default: &565 + default: &564 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -93487,15 +93116,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - - *454 + - *453 responses: '200': description: Response content: application/json: - schema: *564 + schema: *563 examples: - default: *565 + default: *564 '404': *6 '304': *35 '403': *27 @@ -93518,7 +93147,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - - *454 + - *453 responses: '204': description: Response @@ -93551,7 +93180,7 @@ paths: application/json: schema: type: array - items: &566 + items: &565 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -93619,7 +93248,7 @@ paths: - id - type - login - plan: *75 + plan: *70 required: - billing_cycle - next_billing_date @@ -93630,7 +93259,7 @@ paths: - account - plan examples: - default: &567 + default: &566 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -93663,7 +93292,7 @@ paths: - Up to 25 private repositories - 11 concurrent builds headers: - Link: *37 + Link: *50 '304': *35 '401': *23 '404': *6 @@ -93692,11 +93321,11 @@ paths: application/json: schema: type: array - items: *566 + items: *565 examples: - default: *567 + default: *566 headers: - Link: *37 + Link: *50 '304': *35 '401': *23 x-github: @@ -93734,7 +93363,7 @@ paths: application/json: schema: type: array - items: *180 + items: *174 examples: default: value: @@ -93811,7 +93440,7 @@ paths: type: User site_admin: false headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -93836,13 +93465,13 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#get-an-organization-membership-for-the-authenticated-user parameters: - - *89 + - *83 responses: '200': description: Response content: application/json: - schema: *180 + schema: *174 examples: default: value: @@ -93900,7 +93529,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user parameters: - - *89 + - *83 requestBody: required: true content: @@ -93925,7 +93554,7 @@ paths: description: Response content: application/json: - schema: *180 + schema: *174 examples: default: value: @@ -93993,7 +93622,7 @@ paths: application/json: schema: type: array - items: *182 + items: *176 examples: default: value: @@ -94146,7 +93775,7 @@ paths: updated_at: '2015-07-06T15:33:38-07:00' node_id: MDQ6VXNlcjE= headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -94255,7 +93884,7 @@ paths: description: Response content: application/json: - schema: *182 + schema: *176 examples: default: value: @@ -94435,7 +94064,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#get-a-user-migration-status parameters: - - *183 + - *177 - name: exclude in: query required: false @@ -94448,7 +94077,7 @@ paths: description: Response content: application/json: - schema: *182 + schema: *176 examples: default: value: @@ -94642,7 +94271,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#download-a-user-migration-archive parameters: - - *183 + - *177 responses: '302': description: Response @@ -94668,7 +94297,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#delete-a-user-migration-archive parameters: - - *183 + - *177 responses: '204': description: Response @@ -94697,8 +94326,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#unlock-a-user-repository parameters: - - *183 - - *568 + - *177 + - *567 responses: '204': description: Response @@ -94722,7 +94351,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *183 + - *177 - *17 - *18 responses: @@ -94732,11 +94361,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 '404': *6 x-github: githubCloudOnly: false @@ -94769,11 +94398,11 @@ paths: application/json: schema: type: array - items: *88 + items: *129 examples: - default: *569 + default: *568 headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -94813,7 +94442,7 @@ paths: - docker - nuget - container - - *570 + - *569 - *18 - *17 responses: @@ -94823,10 +94452,10 @@ paths: application/json: schema: type: array - items: *189 + items: *183 examples: - default: *571 - '400': *572 + default: *570 + '400': *571 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -94846,16 +94475,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - - *191 - - *192 + - *185 + - *186 responses: '200': description: Response content: application/json: - schema: *189 + schema: *183 examples: - default: &585 + default: &584 value: id: 40201 name: octo-name @@ -94968,8 +94597,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - - *191 - - *192 + - *185 + - *186 responses: '204': description: Response @@ -94999,8 +94628,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - - *191 - - *192 + - *185 + - *186 - name: token description: package token schema: @@ -95032,8 +94661,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: - - *191 - - *192 + - *185 + - *186 - *18 - *17 - name: state @@ -95053,7 +94682,7 @@ paths: application/json: schema: type: array - items: *193 + items: *187 examples: default: value: @@ -95102,15 +94731,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - - *191 - - *192 - - *194 + - *185 + - *186 + - *188 responses: '200': description: Response content: application/json: - schema: *193 + schema: *187 examples: default: value: @@ -95146,9 +94775,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - - *191 - - *192 - - *194 + - *185 + - *186 + - *188 responses: '204': description: Response @@ -95178,9 +94807,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - - *191 - - *192 - - *194 + - *185 + - *186 + - *188 responses: '204': description: Response @@ -95238,7 +94867,7 @@ paths: description: Response content: application/json: - schema: *202 + schema: *196 examples: default: value: @@ -95307,11 +94936,11 @@ paths: application/json: schema: type: array - items: *559 + items: *558 examples: - default: *573 + default: *572 headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -95420,9 +95049,9 @@ paths: application/json: schema: type: array - items: *57 + items: *52 examples: - default: &580 + default: &579 summary: Default response value: - id: 1296269 @@ -95738,9 +95367,9 @@ paths: description: Response content: application/json: - schema: *253 + schema: *252 examples: - default: *255 + default: *254 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -95778,11 +95407,11 @@ paths: application/json: schema: type: array - items: *429 + items: *428 examples: - default: *574 + default: *573 headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -95803,12 +95432,12 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *172 + - *165 responses: '204': description: Response '403': *27 - '409': *128 + '409': *122 '404': *6 '304': *35 x-github: @@ -95826,11 +95455,11 @@ paths: description: API method documentation url: https://docs.github.com/rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *172 + - *165 responses: '204': description: Response - '409': *128 + '409': *122 '304': *35 '404': *6 '403': *27 @@ -95859,7 +95488,7 @@ paths: application/json: schema: type: array - items: &575 + items: &574 title: Social account description: Social media account type: object @@ -95876,12 +95505,12 @@ paths: - provider - url examples: - default: &576 + default: &575 value: - provider: twitter url: https://twitter.com/github headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -95939,9 +95568,9 @@ paths: application/json: schema: type: array - items: *575 + items: *574 examples: - default: *576 + default: *575 '422': *15 '304': *35 '404': *6 @@ -96029,7 +95658,7 @@ paths: application/json: schema: type: array - items: &577 + items: &576 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -96049,7 +95678,7 @@ paths: - title - created_at examples: - default: &592 + default: &591 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -96062,7 +95691,7 @@ paths: title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -96116,9 +95745,9 @@ paths: description: Response content: application/json: - schema: *577 + schema: *576 examples: - default: &578 + default: &577 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -96149,7 +95778,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: - - &579 + - &578 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -96161,9 +95790,9 @@ paths: description: Response content: application/json: - schema: *577 + schema: *576 examples: - default: *578 + default: *577 '404': *6 '304': *35 '403': *27 @@ -96186,7 +95815,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: - - *579 + - *578 responses: '204': description: Response @@ -96215,7 +95844,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - - &593 + - &592 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 @@ -96228,7 +95857,7 @@ paths: - created - updated default: created - - *40 + - *37 - *17 - *18 responses: @@ -96238,13 +95867,13 @@ paths: application/json: schema: type: array - items: *57 + items: *52 examples: - default-response: *580 + default-response: *579 application/vnd.github.v3.star+json: schema: type: array - items: &594 + items: &593 title: Starred Repository description: Starred Repository type: object @@ -96252,7 +95881,7 @@ paths: starred_at: type: string format: date-time - repo: *57 + repo: *52 required: - starred_at - repo @@ -96380,7 +96009,7 @@ paths: open_issues: 1 watchers: 1 headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -96400,8 +96029,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: + - *241 - *242 - - *243 responses: '204': description: Response if this repository is starred by you @@ -96429,8 +96058,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#star-a-repository-for-the-authenticated-user parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -96454,8 +96083,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#unstar-a-repository-for-the-authenticated-user parameters: + - *241 - *242 - - *243 responses: '204': description: Response @@ -96488,11 +96117,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 '304': *35 '403': *27 '401': *23 @@ -96527,7 +96156,7 @@ paths: application/json: schema: type: array - items: *227 + items: *226 examples: default: value: @@ -96578,7 +96207,7 @@ paths: updated_at: '2017-08-17T12:37:15Z' type: Organization headers: - Link: *37 + Link: *50 '304': *35 '404': *6 '403': *27 @@ -96603,7 +96232,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user-using-their-id parameters: - - *77 + - *72 responses: '200': description: Response @@ -96611,10 +96240,10 @@ paths: application/json: schema: oneOf: - - *553 - *552 + - *551 examples: - default-response: &582 + default-response: &581 summary: Default response value: login: octocat @@ -96649,7 +96278,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &583 + response-with-git-hub-plan-information: &582 summary: Response with GitHub plan information value: login: octocat @@ -96709,7 +96338,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#list-users parameters: - - *581 + - *580 - *17 responses: '200': @@ -96720,7 +96349,7 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: Link: example: ; rel="next" @@ -96748,7 +96377,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-a-user parameters: - - *121 + - *115 responses: '200': description: Response @@ -96756,11 +96385,11 @@ paths: application/json: schema: oneOf: - - *553 - *552 + - *551 examples: - default-response: *582 - response-with-git-hub-plan-information: *583 + default-response: *581 + response-with-git-hub-plan-information: *582 '404': *6 x-github: githubCloudOnly: false @@ -96784,9 +96413,9 @@ paths: url: https://docs.github.com/rest/users/attestations#list-attestations parameters: - *17 - - *41 - - *42 - - *121 + - *38 + - *39 + - *115 - name: subject_digest description: Subject Digest in: path @@ -96881,6 +96510,8 @@ paths: type: string repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -96888,7 +96519,7 @@ paths: description: Response content: application/json: - schema: *117 + schema: *111 examples: default: value: @@ -96914,7 +96545,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: - - *121 + - *115 responses: '200': description: Response @@ -96922,9 +96553,9 @@ paths: application/json: schema: type: array - items: *189 + items: *183 examples: - default: *571 + default: *570 '403': *27 '401': *23 x-github: @@ -96947,7 +96578,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-for-the-authenticated-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -96957,7 +96588,7 @@ paths: application/json: schema: type: array - items: *83 + items: *78 examples: default: value: @@ -97028,8 +96659,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - - *121 - - *89 + - *115 + - *83 - *17 - *18 responses: @@ -97039,7 +96670,7 @@ paths: application/json: schema: type: array - items: *83 + items: *78 examples: default: value: @@ -97118,7 +96749,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-for-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -97128,7 +96759,7 @@ paths: application/json: schema: type: array - items: *83 + items: *78 examples: default: value: @@ -97195,7 +96826,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-followers-of-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -97207,9 +96838,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97226,7 +96857,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#list-the-people-a-user-follows parameters: - - *121 + - *115 - *17 - *18 responses: @@ -97238,9 +96869,9 @@ paths: type: array items: *4 examples: - default: *176 + default: *169 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97257,7 +96888,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/followers#check-if-a-user-follows-another-user parameters: - - *121 + - *115 - name: target_user in: path required: true @@ -97284,8 +96915,8 @@ paths: description: API method documentation url: https://docs.github.com/rest/gists/gists#list-gists-for-a-user parameters: - - *121 - - *62 + - *115 + - *57 - *17 - *18 responses: @@ -97295,11 +96926,11 @@ paths: application/json: schema: type: array - items: *63 + items: *58 examples: - default: *64 + default: *59 headers: - Link: *37 + Link: *50 '422': *15 x-github: githubCloudOnly: false @@ -97318,7 +96949,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/gpg-keys#list-gpg-keys-for-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -97328,11 +96959,11 @@ paths: application/json: schema: type: array - items: *560 + items: *559 examples: - default: *584 + default: *583 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97354,7 +96985,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/users#get-contextual-information-for-a-user parameters: - - *121 + - *115 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -97426,7 +97057,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - - *121 + - *115 responses: '200': description: Response @@ -97434,7 +97065,7 @@ paths: application/json: schema: *20 examples: - default: *426 + default: *425 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97452,7 +97083,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/keys#list-public-keys-for-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -97480,7 +97111,7 @@ paths: - id: 1 key: ssh-rsa AAA... headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97500,7 +97131,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/orgs/orgs#list-organizations-for-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -97510,11 +97141,11 @@ paths: application/json: schema: type: array - items: *88 + items: *129 examples: - default: *569 + default: *568 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -97551,8 +97182,8 @@ paths: - docker - nuget - container - - *570 - - *121 + - *569 + - *115 - *18 - *17 responses: @@ -97562,12 +97193,12 @@ paths: application/json: schema: type: array - items: *189 + items: *183 examples: - default: *571 + default: *570 '403': *27 '401': *23 - '400': *572 + '400': *571 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97587,17 +97218,17 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-for-a-user parameters: - - *191 - - *192 - - *121 + - *185 + - *186 + - *115 responses: '200': description: Response content: application/json: - schema: *189 + schema: *183 examples: - default: *585 + default: *584 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -97618,9 +97249,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-a-package-for-a-user parameters: - - *191 - - *192 - - *121 + - *185 + - *186 + - *115 responses: '204': description: Response @@ -97652,9 +97283,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-a-package-for-a-user parameters: - - *191 - - *192 - - *121 + - *185 + - *186 + - *115 - name: token description: package token schema: @@ -97686,9 +97317,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: - - *191 - - *192 - - *121 + - *185 + - *186 + - *115 responses: '200': description: Response @@ -97696,7 +97327,7 @@ paths: application/json: schema: type: array - items: *193 + items: *187 examples: default: value: @@ -97754,16 +97385,16 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#get-a-package-version-for-a-user parameters: - - *191 - - *192 - - *194 - - *121 + - *185 + - *186 + - *188 + - *115 responses: '200': description: Response content: application/json: - schema: *193 + schema: *187 examples: default: value: @@ -97798,10 +97429,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#delete-package-version-for-a-user parameters: - - *191 - - *192 - - *121 - - *194 + - *185 + - *186 + - *115 + - *188 responses: '204': description: Response @@ -97833,10 +97464,10 @@ paths: description: API method documentation url: https://docs.github.com/rest/packages/packages#restore-package-version-for-a-user parameters: - - *191 - - *192 - - *121 - - *194 + - *185 + - *186 + - *115 + - *188 responses: '204': description: Response @@ -97859,7 +97490,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/projects/projects#list-user-projects parameters: - - *121 + - *115 - name: state description: Indicates the state of the projects to return. in: query @@ -97880,7 +97511,7 @@ paths: application/json: schema: type: array - items: *202 + items: *196 examples: default: value: @@ -97916,7 +97547,7 @@ paths: created_at: '2011-04-10T20:09:31Z' updated_at: '2014-03-03T18:58:10Z' headers: - Link: *37 + Link: *50 '422': *15 x-github: githubCloudOnly: false @@ -97939,7 +97570,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -97949,7 +97580,7 @@ paths: application/json: schema: type: array - items: *83 + items: *78 examples: default: value: @@ -98028,7 +97659,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/events#list-public-events-received-by-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -98038,7 +97669,7 @@ paths: application/json: schema: type: array - items: *83 + items: *78 examples: default: value: @@ -98115,7 +97746,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/repos/repos#list-repositories-for-a-user parameters: - - *121 + - *115 - name: type description: Limit results to repositories of the specified type. in: query @@ -98158,11 +97789,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98184,15 +97815,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-actions-billing-for-a-user parameters: - - *121 + - *115 responses: '200': description: Response content: application/json: - schema: *586 + schema: *585 examples: - default: *587 + default: *586 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98214,15 +97845,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-github-packages-billing-for-a-user parameters: - - *121 + - *115 responses: '200': description: Response content: application/json: - schema: *588 + schema: *587 examples: - default: *589 + default: *588 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98244,15 +97875,15 @@ paths: description: API method documentation url: https://docs.github.com/rest/billing/billing#get-shared-storage-billing-for-a-user parameters: - - *121 + - *115 responses: '200': description: Response content: application/json: - schema: *590 + schema: *589 examples: - default: *591 + default: *590 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98270,7 +97901,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/social-accounts#list-social-accounts-for-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -98280,11 +97911,11 @@ paths: application/json: schema: type: array - items: *575 + items: *574 examples: - default: *576 + default: *575 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98302,7 +97933,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -98312,11 +97943,11 @@ paths: application/json: schema: type: array - items: *577 + items: *576 examples: - default: *592 + default: *591 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98338,9 +97969,9 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *121 - - *593 - - *40 + - *115 + - *592 + - *37 - *17 - *18 responses: @@ -98351,13 +97982,13 @@ paths: schema: anyOf: - type: array - items: *594 + items: *593 - type: array - items: *57 + items: *52 examples: - default-response: *580 + default-response: *579 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98374,7 +98005,7 @@ paths: description: API method documentation url: https://docs.github.com/rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *121 + - *115 - *17 - *18 responses: @@ -98384,11 +98015,11 @@ paths: application/json: schema: type: array - items: *108 + items: *102 examples: - default: *195 + default: *189 headers: - Link: *37 + Link: *50 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -98515,7 +98146,7 @@ webhooks: type: string enum: - disabled - enterprise: &595 + enterprise: &594 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -98584,7 +98215,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &596 + installation: &595 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -98605,7 +98236,7 @@ webhooks: required: - id - node_id - organization: &597 + organization: &596 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -98678,7 +98309,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &598 + repository: &597 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -98707,7 +98338,7 @@ webhooks: license: anyOf: - type: 'null' - - *73 + - *68 organization: anyOf: - type: 'null' @@ -99591,10 +99222,10 @@ webhooks: type: string enum: - enabled - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -99670,11 +99301,11 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - rule: &599 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + rule: &598 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) @@ -99897,11 +99528,11 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - rule: *599 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + rule: *598 sender: *4 required: - action @@ -100089,11 +99720,11 @@ webhooks: - everyone required: - from - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - rule: *599 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + rule: *598 sender: *4 required: - action @@ -100177,7 +99808,7 @@ webhooks: type: string enum: - completed - check_run: &601 + check_run: &600 title: CheckRun description: A check performed on the code of a given code change type: object @@ -100245,8 +99876,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *321 - repository: *108 + items: *320 + repository: *102 status: type: string enum: @@ -100290,7 +99921,7 @@ webhooks: - examples: - neutral - deployment: *600 + deployment: *599 details_url: type: string examples: @@ -100350,7 +99981,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *321 + items: *320 started_at: type: string format: date-time @@ -100388,9 +100019,9 @@ webhooks: - output - app - pull_requests - installation: *596 - organization: *597 - repository: *598 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - check_run @@ -100783,10 +100414,10 @@ webhooks: type: string enum: - created - check_run: *601 - installation: *596 - organization: *597 - repository: *598 + check_run: *600 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - check_run @@ -101182,10 +100813,10 @@ webhooks: type: string enum: - requested_action - check_run: *601 - installation: *596 - organization: *597 - repository: *598 + check_run: *600 + installation: *595 + organization: *596 + repository: *597 requested_action: description: The action requested by the user. type: object @@ -101590,10 +101221,10 @@ webhooks: type: string enum: - rerequested - check_run: *601 - installation: *596 - organization: *597 - repository: *598 + check_run: *600 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - check_run @@ -102585,10 +102216,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -103273,10 +102904,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -103955,10 +103586,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -104265,20 +103896,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &602 + commit_oid: &601 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: *595 - installation: *596 - organization: *597 - ref: &603 + enterprise: *594 + installation: *595 + organization: *596 + ref: &602 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: *598 + repository: *597 sender: *4 required: - action @@ -104606,12 +104237,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *602 - enterprise: *595 - installation: *596 - organization: *597 - ref: *603 - repository: *598 + commit_oid: *601 + enterprise: *594 + installation: *595 + organization: *596 + ref: *602 + repository: *597 sender: *4 required: - action @@ -104709,7 +104340,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *336 + dismissed_comment: *335 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -104884,12 +104515,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *602 - enterprise: *595 - installation: *596 - organization: *597 - ref: *603 - repository: *598 + commit_oid: *601 + enterprise: *594 + installation: *595 + organization: *596 + ref: *602 + repository: *597 sender: *4 required: - action @@ -105221,12 +104852,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *602 - enterprise: *595 - installation: *596 - organization: *597 - ref: *603 - repository: *598 + commit_oid: *601 + enterprise: *594 + installation: *595 + organization: *596 + ref: *602 + repository: *597 sender: *4 required: - action @@ -105495,9 +105126,9 @@ webhooks: type: - string - 'null' - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -105505,7 +105136,7 @@ webhooks: type: - string - 'null' - repository: *598 + repository: *597 sender: *4 required: - action @@ -105737,12 +105368,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *602 - enterprise: *595 - installation: *596 - organization: *597 - ref: *603 - repository: *598 + commit_oid: *601 + enterprise: *594 + installation: *595 + organization: *596 + ref: *602 + repository: *597 sender: *4 required: - action @@ -106004,10 +105635,10 @@ webhooks: - updated_at - author_association - body - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -106088,18 +105719,18 @@ webhooks: type: - string - 'null' - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *597 - pusher_type: &604 + organization: *596 + pusher_type: &603 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &605 + ref: &604 description: The [`git ref`](https://docs.github.com/rest/git/refs#get-a-reference) resource. type: string @@ -106109,7 +105740,7 @@ webhooks: enum: - tag - branch - repository: *598 + repository: *597 sender: *4 required: - ref @@ -106191,10 +105822,10 @@ webhooks: type: string enum: - created - definition: *203 - enterprise: *595 - installation: *596 - organization: *597 + definition: *197 + enterprise: *594 + installation: *595 + organization: *596 sender: *4 required: - action @@ -106279,9 +105910,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 sender: *4 required: - action @@ -106358,10 +105989,10 @@ webhooks: type: string enum: - updated - definition: *203 - enterprise: *595 - installation: *596 - organization: *597 + definition: *197 + enterprise: *594 + installation: *595 + organization: *596 sender: *4 required: - action @@ -106438,19 +106069,19 @@ webhooks: type: string enum: - updated - enterprise: *595 - installation: *596 - repository: *598 - organization: *597 + enterprise: *594 + installation: *595 + repository: *597 + organization: *596 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *207 + items: *201 old_property_values: type: array description: The old custom property values for the repository. - items: *207 + items: *201 required: - action - repository @@ -106526,18 +106157,18 @@ webhooks: title: delete event type: object properties: - enterprise: *595 - installation: *596 - organization: *597 - pusher_type: *604 - ref: *605 + enterprise: *594 + installation: *595 + organization: *596 + pusher_type: *603 + ref: *604 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *598 + repository: *597 sender: *4 required: - ref @@ -106621,11 +106252,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *385 - installation: *596 - organization: *597 - enterprise: *595 - repository: *598 + alert: *384 + installation: *595 + organization: *596 + enterprise: *594 + repository: *597 sender: *4 required: - action @@ -106709,11 +106340,11 @@ webhooks: type: string enum: - auto_reopened - alert: *385 - installation: *596 - organization: *597 - enterprise: *595 - repository: *598 + alert: *384 + installation: *595 + organization: *596 + enterprise: *594 + repository: *597 sender: *4 required: - action @@ -106797,11 +106428,11 @@ webhooks: type: string enum: - created - alert: *385 - installation: *596 - organization: *597 - enterprise: *595 - repository: *598 + alert: *384 + installation: *595 + organization: *596 + enterprise: *594 + repository: *597 sender: *4 required: - action @@ -106883,11 +106514,11 @@ webhooks: type: string enum: - dismissed - alert: *385 - installation: *596 - organization: *597 - enterprise: *595 - repository: *598 + alert: *384 + installation: *595 + organization: *596 + enterprise: *594 + repository: *597 sender: *4 required: - action @@ -106969,11 +106600,11 @@ webhooks: type: string enum: - fixed - alert: *385 - installation: *596 - organization: *597 - enterprise: *595 - repository: *598 + alert: *384 + installation: *595 + organization: *596 + enterprise: *594 + repository: *597 sender: *4 required: - action @@ -107056,11 +106687,11 @@ webhooks: type: string enum: - reintroduced - alert: *385 - installation: *596 - organization: *597 - enterprise: *595 - repository: *598 + alert: *384 + installation: *595 + organization: *596 + enterprise: *594 + repository: *597 sender: *4 required: - action @@ -107142,11 +106773,11 @@ webhooks: type: string enum: - reopened - alert: *385 - installation: *596 - organization: *597 - enterprise: *595 - repository: *598 + alert: *384 + installation: *595 + organization: *596 + enterprise: *594 + repository: *597 sender: *4 required: - action @@ -107223,9 +106854,9 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - key: &606 + enterprise: *594 + installation: *595 + key: &605 description: The [`deploy key`](https://docs.github.com/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -107263,8 +106894,8 @@ webhooks: - verified - created_at - read_only - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -107341,11 +106972,11 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - key: *606 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + key: *605 + organization: *596 + repository: *597 sender: *4 required: - action @@ -107917,12 +107548,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - workflow: &610 + workflow: &609 title: Workflow type: - object @@ -108660,13 +108291,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *391 + deployment: *390 pull_requests: type: array - items: *473 - repository: *598 - organization: *597 - installation: *596 + items: *472 + repository: *597 + organization: *596 + installation: *595 sender: *4 responses: '200': @@ -108737,7 +108368,7 @@ webhooks: type: string enum: - approved - approver: &607 + approver: &606 type: object properties: avatar_url: @@ -108780,11 +108411,11 @@ webhooks: type: string comment: type: string - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - reviewers: &608 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + reviewers: &607 type: array items: type: object @@ -108865,7 +108496,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &609 + workflow_job_run: &608 type: object properties: conclusion: @@ -109611,18 +109242,18 @@ webhooks: type: string enum: - rejected - approver: *607 + approver: *606 comment: type: string - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - reviewers: *608 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + reviewers: *607 sender: *4 since: type: string - workflow_job_run: *609 + workflow_job_run: *608 workflow_job_runs: type: array items: @@ -110339,13 +109970,13 @@ webhooks: type: string enum: - requested - enterprise: *595 + enterprise: *594 environment: type: string - installation: *596 - organization: *597 - repository: *598 - requestor: &615 + installation: *595 + organization: *596 + repository: *597 + requestor: &614 title: User type: - object @@ -112288,12 +111919,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - workflow: *610 + workflow: *609 workflow_run: title: Deployment Workflow Run type: @@ -112984,7 +112615,7 @@ webhooks: type: string enum: - answered - answer: &613 + answer: &612 type: object properties: author_association: @@ -113144,7 +112775,7 @@ webhooks: - created_at - updated_at - body - discussion: &611 + discussion: &610 title: Discussion description: A Discussion in a repository. type: object @@ -113440,7 +113071,7 @@ webhooks: - id labels: type: array - items: *436 + items: *435 required: - repository_url - category @@ -113462,10 +113093,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -113592,11 +113223,11 @@ webhooks: - from required: - category - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -113679,11 +113310,11 @@ webhooks: type: string enum: - closed - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -113765,7 +113396,7 @@ webhooks: type: string enum: - created - comment: &612 + comment: &611 type: object properties: author_association: @@ -113925,11 +113556,11 @@ webhooks: - updated_at - body - reactions - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114012,12 +113643,12 @@ webhooks: type: string enum: - deleted - comment: *612 - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + comment: *611 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114112,12 +113743,12 @@ webhooks: - from required: - body - comment: *612 - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + comment: *611 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114201,11 +113832,11 @@ webhooks: type: string enum: - created - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114287,11 +113918,11 @@ webhooks: type: string enum: - deleted - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114391,11 +114022,11 @@ webhooks: type: string required: - from - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114477,10 +114108,10 @@ webhooks: type: string enum: - labeled - discussion: *611 - enterprise: *595 - installation: *596 - label: &614 + discussion: *610 + enterprise: *594 + installation: *595 + label: &613 title: Label type: object properties: @@ -114513,8 +114144,8 @@ webhooks: - color - default - description - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114597,11 +114228,11 @@ webhooks: type: string enum: - locked - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114683,11 +114314,11 @@ webhooks: type: string enum: - pinned - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114769,11 +114400,11 @@ webhooks: type: string enum: - reopened - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114858,16 +114489,16 @@ webhooks: changes: type: object properties: - new_discussion: *611 - new_repository: *598 + new_discussion: *610 + new_repository: *597 required: - new_discussion - new_repository - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -114950,10 +114581,10 @@ webhooks: type: string enum: - unanswered - discussion: *611 - old_answer: *613 - organization: *597 - repository: *598 + discussion: *610 + old_answer: *612 + organization: *596 + repository: *597 sender: *4 required: - action @@ -115035,12 +114666,12 @@ webhooks: type: string enum: - unlabeled - discussion: *611 - enterprise: *595 - installation: *596 - label: *614 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + label: *613 + organization: *596 + repository: *597 sender: *4 required: - action @@ -115123,11 +114754,11 @@ webhooks: type: string enum: - unlocked - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -115209,11 +114840,11 @@ webhooks: type: string enum: - unpinned - discussion: *611 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + discussion: *610 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -115286,7 +114917,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *595 + enterprise: *594 forkee: description: The created [`repository`](https://docs.github.com/rest/repos/repos#get-a-repository) resource. @@ -115964,9 +115595,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *596 - organization: *597 - repository: *598 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - forkee @@ -116112,9 +115743,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 pages: description: The pages that were updated. type: array @@ -116152,7 +115783,7 @@ webhooks: - action - sha - html_url - repository: *598 + repository: *597 sender: *4 required: - pages @@ -116228,10 +115859,10 @@ webhooks: type: string enum: - created - enterprise: *595 + enterprise: *594 installation: *20 - organization: *597 - repositories: &616 + organization: *596 + repositories: &615 description: An array of repository objects that the installation can access. type: array @@ -116257,8 +115888,8 @@ webhooks: - name - full_name - private - repository: *598 - requester: *615 + repository: *597 + requester: *614 sender: *4 required: - action @@ -116333,11 +115964,11 @@ webhooks: type: string enum: - deleted - enterprise: *595 + enterprise: *594 installation: *20 - organization: *597 - repositories: *616 - repository: *598 + organization: *596 + repositories: *615 + repository: *597 requester: type: - 'null' @@ -116414,11 +116045,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *595 + enterprise: *594 installation: *20 - organization: *597 - repositories: *616 - repository: *598 + organization: *596 + repositories: *615 + repository: *597 requester: type: - 'null' @@ -116495,10 +116126,10 @@ webhooks: type: string enum: - added - enterprise: *595 + enterprise: *594 installation: *20 - organization: *597 - repositories_added: &617 + organization: *596 + repositories_added: &616 description: An array of repository objects, which were added to the installation. type: array @@ -116544,15 +116175,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *598 - repository_selection: &618 + repository: *597 + repository_selection: &617 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *615 + requester: *614 sender: *4 required: - action @@ -116631,10 +116262,10 @@ webhooks: type: string enum: - removed - enterprise: *595 + enterprise: *594 installation: *20 - organization: *597 - repositories_added: *617 + organization: *596 + repositories_added: *616 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -116661,9 +116292,9 @@ webhooks: - name - full_name - private - repository: *598 - repository_selection: *618 - requester: *615 + repository: *597 + repository_selection: *617 + requester: *614 sender: *4 required: - action @@ -116742,11 +116373,11 @@ webhooks: type: string enum: - suspend - enterprise: *595 + enterprise: *594 installation: *20 - organization: *597 - repositories: *616 - repository: *598 + organization: *596 + repositories: *615 + repository: *597 requester: type: - 'null' @@ -116928,10 +116559,10 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 target_type: type: string @@ -117010,11 +116641,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *595 + enterprise: *594 installation: *20 - organization: *597 - repositories: *616 - repository: *598 + organization: *596 + repositories: *615 + repository: *597 requester: type: - 'null' @@ -117262,8 +116893,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -118453,8 +118084,8 @@ webhooks: - state - locked - assignee - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -118534,7 +118165,7 @@ webhooks: type: string enum: - deleted - comment: &619 + comment: &618 title: issue comment description: The [comment](https://docs.github.com/rest/issues/comments#get-an-issue-comment) itself. @@ -118701,8 +118332,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -119890,8 +119521,8 @@ webhooks: - state - locked - assignee - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -119971,7 +119602,7 @@ webhooks: type: string enum: - edited - changes: &644 + changes: &643 description: The changes to the comment. type: object properties: @@ -119983,9 +119614,9 @@ webhooks: type: string required: - from - comment: *619 - enterprise: *595 - installation: *596 + comment: *618 + enterprise: *594 + installation: *595 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) the comment belongs to. @@ -121174,8 +120805,8 @@ webhooks: - state - locked - assignee - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -121257,10 +120888,10 @@ webhooks: type: string enum: - assigned - assignee: *615 - enterprise: *595 - installation: *596 - issue: &622 + assignee: *614 + enterprise: *594 + installation: *595 + issue: &621 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -122204,8 +121835,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -122285,8 +121916,8 @@ webhooks: type: string enum: - closed - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -123378,8 +123009,8 @@ webhooks: required: - state - closed_at - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -123458,8 +123089,8 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -124396,8 +124027,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -124476,8 +124107,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -125418,7 +125049,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &620 + milestone: &619 title: Milestone description: A collection of related issues and pull requests. type: object @@ -125561,8 +125192,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -125661,8 +125292,8 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -126606,9 +126237,9 @@ webhooks: - active_lock_reason - body - reactions - label: *614 - organization: *597 - repository: *598 + label: *613 + organization: *596 + repository: *597 sender: *4 required: - action @@ -126688,8 +126319,8 @@ webhooks: type: string enum: - labeled - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -127632,9 +127263,9 @@ webhooks: - active_lock_reason - body - reactions - label: *614 - organization: *597 - repository: *598 + label: *613 + organization: *596 + repository: *597 sender: *4 required: - action @@ -127714,8 +127345,8 @@ webhooks: type: string enum: - locked - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -128660,8 +128291,8 @@ webhooks: format: uri user_view_type: type: string - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -128740,8 +128371,8 @@ webhooks: type: string enum: - milestoned - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -129680,9 +129311,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *620 - organization: *597 - repository: *598 + milestone: *619 + organization: *596 + repository: *597 sender: *4 required: - action @@ -131182,8 +130813,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -132126,8 +131757,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -132207,9 +131838,9 @@ webhooks: type: string enum: - pinned - enterprise: *595 - installation: *596 - issue: &621 + enterprise: *594 + installation: *595 + issue: &620 title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) itself. @@ -133146,8 +132777,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -133226,8 +132857,8 @@ webhooks: type: string enum: - reopened - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -134171,8 +133802,8 @@ webhooks: format: uri user_view_type: type: string - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -135672,11 +135303,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *595 - installation: *596 - issue: *621 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + issue: *620 + organization: *596 + repository: *597 sender: *4 required: - action @@ -135757,7 +135388,7 @@ webhooks: type: string enum: - unassigned - assignee: &647 + assignee: &646 title: User type: - object @@ -135829,11 +135460,11 @@ webhooks: required: - login - id - enterprise: *595 - installation: *596 - issue: *622 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + issue: *621 + organization: *596 + repository: *597 sender: *4 required: - action @@ -135912,12 +135543,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *595 - installation: *596 - issue: *622 - label: *614 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + issue: *621 + label: *613 + organization: *596 + repository: *597 sender: *4 required: - action @@ -135997,8 +135628,8 @@ webhooks: type: string enum: - unlocked - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 issue: title: Issue description: The [issue](https://docs.github.com/rest/issues/issues#get-an-issue) @@ -136941,8 +136572,8 @@ webhooks: format: uri user_view_type: type: string - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -137022,11 +136653,11 @@ webhooks: type: string enum: - unpinned - enterprise: *595 - installation: *596 - issue: *621 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + issue: *620 + organization: *596 + repository: *597 sender: *4 required: - action @@ -137105,11 +136736,11 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - label: *614 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + label: *613 + organization: *596 + repository: *597 sender: *4 required: - action @@ -137187,11 +136818,11 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - label: *614 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + label: *613 + organization: *596 + repository: *597 sender: *4 required: - action @@ -137301,11 +136932,11 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 - label: *614 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + label: *613 + organization: *596 + repository: *597 sender: *4 required: - action @@ -137387,9 +137018,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *595 - installation: *596 - marketplace_purchase: &623 + enterprise: *594 + installation: *595 + marketplace_purchase: &622 title: Marketplace Purchase type: object required: @@ -137477,8 +137108,8 @@ webhooks: type: integer unit_count: type: integer - organization: *597 - previous_marketplace_purchase: &624 + organization: *596 + previous_marketplace_purchase: &623 title: Marketplace Purchase type: object properties: @@ -137562,7 +137193,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *598 + repository: *597 sender: *4 required: - action @@ -137642,10 +137273,10 @@ webhooks: - changed effective_date: type: string - enterprise: *595 - installation: *596 - marketplace_purchase: *623 - organization: *597 + enterprise: *594 + installation: *595 + marketplace_purchase: *622 + organization: *596 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -137733,7 +137364,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *598 + repository: *597 sender: *4 required: - action @@ -137815,10 +137446,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *595 - installation: *596 - marketplace_purchase: *623 - organization: *597 + enterprise: *594 + installation: *595 + marketplace_purchase: *622 + organization: *596 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -137904,7 +137535,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *598 + repository: *597 sender: *4 required: - action @@ -137985,8 +137616,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 marketplace_purchase: title: Marketplace Purchase type: object @@ -138072,9 +137703,9 @@ webhooks: type: integer unit_count: type: integer - organization: *597 - previous_marketplace_purchase: *624 - repository: *598 + organization: *596 + previous_marketplace_purchase: *623 + repository: *597 sender: *4 required: - action @@ -138154,12 +137785,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *595 - installation: *596 - marketplace_purchase: *623 - organization: *597 - previous_marketplace_purchase: *624 - repository: *598 + enterprise: *594 + installation: *595 + marketplace_purchase: *622 + organization: *596 + previous_marketplace_purchase: *623 + repository: *597 sender: *4 required: - action @@ -138261,11 +137892,11 @@ webhooks: type: string required: - to - enterprise: *595 - installation: *596 - member: *615 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + member: *614 + organization: *596 + repository: *597 sender: *4 required: - action @@ -138367,11 +137998,11 @@ webhooks: type: - string - 'null' - enterprise: *595 - installation: *596 - member: *615 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + member: *614 + organization: *596 + repository: *597 sender: *4 required: - action @@ -138450,11 +138081,11 @@ webhooks: type: string enum: - removed - enterprise: *595 - installation: *596 - member: *615 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + member: *614 + organization: *596 + repository: *597 sender: *4 required: - action @@ -138532,11 +138163,11 @@ webhooks: type: string enum: - added - enterprise: *595 - installation: *596 - member: *615 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + member: *614 + organization: *596 + repository: *597 scope: description: The scope of the membership. Currently, can only be `team`. @@ -138614,7 +138245,7 @@ webhooks: required: - login - id - team: &625 + team: &624 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -138807,11 +138438,11 @@ webhooks: type: string enum: - removed - enterprise: *595 - installation: *596 - member: *615 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + member: *614 + organization: *596 + repository: *597 scope: description: The scope of the membership. Currently, can only be `team`. @@ -138890,7 +138521,7 @@ webhooks: required: - login - id - team: *625 + team: *624 required: - action - scope @@ -138972,8 +138603,8 @@ webhooks: type: string enum: - checks_requested - installation: *596 - merge_group: &626 + installation: *595 + merge_group: &625 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -138992,15 +138623,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *325 + head_commit: *324 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -139086,10 +138717,10 @@ webhooks: - merged - invalidated - dequeued - installation: *596 - merge_group: *626 - organization: *597 - repository: *598 + installation: *595 + merge_group: *625 + organization: *596 + repository: *597 sender: *4 required: - action @@ -139162,7 +138793,7 @@ webhooks: type: string enum: - deleted - enterprise: *595 + enterprise: *594 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -139270,12 +138901,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *596 - organization: *597 + installation: *595 + organization: *596 repository: anyOf: - type: 'null' - - *598 + - *597 sender: *4 required: - action @@ -139355,11 +138986,11 @@ webhooks: type: string enum: - closed - enterprise: *595 - installation: *596 - milestone: *620 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + milestone: *619 + organization: *596 + repository: *597 sender: *4 required: - action @@ -139438,9 +139069,9 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - milestone: &627 + enterprise: *594 + installation: *595 + milestone: &626 title: Milestone description: A collection of related issues and pull requests. type: object @@ -139582,8 +139213,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -139662,11 +139293,11 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - milestone: *620 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + milestone: *619 + organization: *596 + repository: *597 sender: *4 required: - action @@ -139776,11 +139407,11 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 - milestone: *620 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + milestone: *619 + organization: *596 + repository: *597 sender: *4 required: - action @@ -139860,11 +139491,11 @@ webhooks: type: string enum: - opened - enterprise: *595 - installation: *596 - milestone: *627 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + milestone: *626 + organization: *596 + repository: *597 sender: *4 required: - action @@ -139943,11 +139574,11 @@ webhooks: type: string enum: - blocked - blocked_user: *615 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + blocked_user: *614 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -140026,11 +139657,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *615 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + blocked_user: *614 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -140109,9 +139740,9 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - membership: &628 + enterprise: *594 + installation: *595 + membership: &627 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -140205,8 +139836,8 @@ webhooks: - role - organization_url - user - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 required: - action @@ -140284,11 +139915,11 @@ webhooks: type: string enum: - member_added - enterprise: *595 - installation: *596 - membership: *628 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + membership: *627 + organization: *596 + repository: *597 sender: *4 required: - action @@ -140367,8 +139998,8 @@ webhooks: type: string enum: - member_invited - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -140490,10 +140121,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 - user: *615 + user: *614 required: - action - invitation @@ -140571,11 +140202,11 @@ webhooks: type: string enum: - member_removed - enterprise: *595 - installation: *596 - membership: *628 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + membership: *627 + organization: *596 + repository: *597 sender: *4 required: - action @@ -140662,11 +140293,11 @@ webhooks: properties: from: type: string - enterprise: *595 - installation: *596 - membership: *628 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + membership: *627 + organization: *596 + repository: *597 sender: *4 required: - action @@ -140742,9 +140373,9 @@ webhooks: type: string enum: - published - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 package: description: Information about the package. type: object @@ -141267,7 +140898,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &629 + items: &628 title: Ruby Gems metadata type: object properties: @@ -141364,7 +140995,7 @@ webhooks: - owner - package_version - registry - repository: *598 + repository: *597 sender: *4 required: - action @@ -141440,9 +141071,9 @@ webhooks: type: string enum: - updated - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 package: description: Information about the package. type: object @@ -141804,7 +141435,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *629 + items: *628 source_url: type: string format: uri @@ -141875,7 +141506,7 @@ webhooks: - owner - package_version - registry - repository: *598 + repository: *597 sender: *4 required: - action @@ -142056,12 +141687,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *595 + enterprise: *594 id: type: integer - installation: *596 - organization: *597 - repository: *598 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - id @@ -142141,7 +141772,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &630 + personal_access_token_request: &629 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -142291,10 +141922,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *595 - organization: *597 + enterprise: *594 + organization: *596 sender: *4 - installation: *596 + installation: *595 required: - action - personal_access_token_request @@ -142373,11 +142004,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *630 - enterprise: *595 - organization: *597 + personal_access_token_request: *629 + enterprise: *594 + organization: *596 sender: *4 - installation: *596 + installation: *595 required: - action - personal_access_token_request @@ -142455,11 +142086,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *630 - enterprise: *595 - organization: *597 + personal_access_token_request: *629 + enterprise: *594 + organization: *596 sender: *4 - installation: *596 + installation: *595 required: - action - personal_access_token_request @@ -142536,11 +142167,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *630 - organization: *597 - enterprise: *595 + personal_access_token_request: *629 + organization: *596 + enterprise: *594 sender: *4 - installation: *596 + installation: *595 required: - action - personal_access_token_request @@ -142644,7 +142275,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *631 + last_response: *630 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -142676,8 +142307,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 zen: description: Random string of GitHub zen. @@ -142922,10 +142553,10 @@ webhooks: - from required: - note - enterprise: *595 - installation: *596 - organization: *597 - project_card: &632 + enterprise: *594 + installation: *595 + organization: *596 + project_card: &631 title: Project Card type: object properties: @@ -143048,7 +142679,7 @@ webhooks: - creator - created_at - updated_at - repository: *598 + repository: *597 sender: *4 required: - action @@ -143129,11 +142760,11 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - project_card: *632 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + project_card: *631 + repository: *597 sender: *4 required: - action @@ -143213,9 +142844,9 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 project_card: title: Project Card type: object @@ -143345,7 +142976,7 @@ webhooks: repository: anyOf: - type: 'null' - - *598 + - *597 sender: *4 required: - action @@ -143439,11 +143070,11 @@ webhooks: - from required: - note - enterprise: *595 - installation: *596 - organization: *597 - project_card: *632 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + project_card: *631 + repository: *597 sender: *4 required: - action @@ -143537,9 +143168,9 @@ webhooks: - from required: - column_id - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 project_card: allOf: - title: Project Card @@ -143736,7 +143367,7 @@ webhooks: type: string required: - after_id - repository: *598 + repository: *597 sender: *4 required: - action @@ -143816,10 +143447,10 @@ webhooks: type: string enum: - closed - enterprise: *595 - installation: *596 - organization: *597 - project: &634 + enterprise: *594 + installation: *595 + organization: *596 + project: &633 title: Project type: object properties: @@ -143946,7 +143577,7 @@ webhooks: - creator - created_at - updated_at - repository: *598 + repository: *597 sender: *4 required: - action @@ -144026,10 +143657,10 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - project_column: &633 + enterprise: *594 + installation: *595 + organization: *596 + project_column: &632 title: Project Column type: object properties: @@ -144069,7 +143700,7 @@ webhooks: - name - created_at - updated_at - repository: *598 + repository: *597 sender: *4 required: - action @@ -144148,14 +143779,14 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 - project_column: *633 + enterprise: *594 + installation: *595 + organization: *596 + project_column: *632 repository: anyOf: - type: 'null' - - *598 + - *597 sender: *4 required: - action @@ -144244,11 +143875,11 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 - organization: *597 - project_column: *633 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + project_column: *632 + repository: *597 sender: *4 required: - action @@ -144328,11 +143959,11 @@ webhooks: type: string enum: - moved - enterprise: *595 - installation: *596 - organization: *597 - project_column: *633 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + project_column: *632 + repository: *597 sender: *4 required: - action @@ -144412,11 +144043,11 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - project: *634 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + project: *633 + repository: *597 sender: *4 required: - action @@ -144496,14 +144127,14 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 - project: *634 + enterprise: *594 + installation: *595 + organization: *596 + project: *633 repository: anyOf: - type: 'null' - - *598 + - *597 sender: *4 required: - action @@ -144604,11 +144235,11 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 - organization: *597 - project: *634 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + project: *633 + repository: *597 sender: *4 required: - action @@ -144687,11 +144318,11 @@ webhooks: type: string enum: - reopened - enterprise: *595 - installation: *596 - organization: *597 - project: *634 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + project: *633 + repository: *597 sender: *4 required: - action @@ -144772,9 +144403,9 @@ webhooks: type: string enum: - closed - installation: *596 - organization: *597 - projects_v2: &635 + installation: *595 + organization: *596 + projects_v2: &634 title: Projects v2 Project description: A projects v2 project type: object @@ -144922,9 +144553,9 @@ webhooks: type: string enum: - created - installation: *596 - organization: *597 - projects_v2: *635 + installation: *595 + organization: *596 + projects_v2: *634 sender: *4 required: - action @@ -145005,9 +144636,9 @@ webhooks: type: string enum: - deleted - installation: *596 - organization: *597 - projects_v2: *635 + installation: *595 + organization: *596 + projects_v2: *634 sender: *4 required: - action @@ -145128,9 +144759,9 @@ webhooks: type: string to: type: string - installation: *596 - organization: *597 - projects_v2: *635 + installation: *595 + organization: *596 + projects_v2: *634 sender: *4 required: - action @@ -145213,7 +144844,7 @@ webhooks: type: string enum: - archived - changes: &639 + changes: &638 type: object properties: archived_at: @@ -145229,9 +144860,9 @@ webhooks: - string - 'null' format: date-time - installation: *596 - organization: *597 - projects_v2_item: &636 + installation: *595 + organization: *596 + projects_v2_item: &635 title: Projects v2 Item description: An item belonging to a project type: object @@ -145370,9 +145001,9 @@ webhooks: - 'null' to: type: string - installation: *596 - organization: *597 - projects_v2_item: *636 + installation: *595 + organization: *596 + projects_v2_item: *635 sender: *4 required: - action @@ -145454,9 +145085,9 @@ webhooks: type: string enum: - created - installation: *596 - organization: *597 - projects_v2_item: *636 + installation: *595 + organization: *596 + projects_v2_item: *635 sender: *4 required: - action @@ -145537,9 +145168,9 @@ webhooks: type: string enum: - deleted - installation: *596 - organization: *597 - projects_v2_item: *636 + installation: *595 + organization: *596 + projects_v2_item: *635 sender: *4 required: - action @@ -145644,7 +145275,7 @@ webhooks: oneOf: - type: string - type: integer - - &637 + - &636 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -145664,7 +145295,7 @@ webhooks: required: - id - name - - &638 + - &637 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -145693,8 +145324,8 @@ webhooks: oneOf: - type: string - type: integer + - *636 - *637 - - *638 type: - 'null' - string @@ -145717,9 +145348,9 @@ webhooks: - 'null' required: - body - installation: *596 - organization: *597 - projects_v2_item: *636 + installation: *595 + organization: *596 + projects_v2_item: *635 sender: *4 required: - action @@ -145816,9 +145447,9 @@ webhooks: type: - string - 'null' - installation: *596 - organization: *597 - projects_v2_item: *636 + installation: *595 + organization: *596 + projects_v2_item: *635 sender: *4 required: - action @@ -145901,10 +145532,10 @@ webhooks: type: string enum: - restored - changes: *639 - installation: *596 - organization: *597 - projects_v2_item: *636 + changes: *638 + installation: *595 + organization: *596 + projects_v2_item: *635 sender: *4 required: - action @@ -145986,9 +145617,9 @@ webhooks: type: string enum: - reopened - installation: *596 - organization: *597 - projects_v2: *635 + installation: *595 + organization: *596 + projects_v2: *634 sender: *4 required: - action @@ -146069,9 +145700,9 @@ webhooks: type: string enum: - created - installation: *596 - organization: *597 - projects_v2_status_update: &640 + installation: *595 + organization: *596 + projects_v2_status_update: &639 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -146206,9 +145837,9 @@ webhooks: type: string enum: - deleted - installation: *596 - organization: *597 - projects_v2_status_update: *640 + installation: *595 + organization: *596 + projects_v2_status_update: *639 sender: *4 required: - action @@ -146354,9 +145985,9 @@ webhooks: - string - 'null' format: date - installation: *596 - organization: *597 - projects_v2_status_update: *640 + installation: *595 + organization: *596 + projects_v2_status_update: *639 sender: *4 required: - action @@ -146427,10 +146058,10 @@ webhooks: title: public event type: object properties: - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - repository @@ -146507,13 +146138,13 @@ webhooks: type: string enum: - assigned - assignee: *615 - enterprise: *595 - installation: *596 - number: &641 + assignee: *614 + enterprise: *594 + installation: *595 + number: &640 description: The pull request number. type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -148862,7 +148493,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -148944,11 +148575,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 number: type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -151290,7 +150921,7 @@ webhooks: - draft reason: type: string - repository: *598 + repository: *597 sender: *4 required: - action @@ -151372,11 +151003,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 number: type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -153718,7 +153349,7 @@ webhooks: - draft reason: type: string - repository: *598 + repository: *597 sender: *4 required: - action @@ -153800,13 +153431,13 @@ webhooks: type: string enum: - closed - enterprise: *595 - installation: *596 - number: *641 - organization: *597 - pull_request: &642 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 + pull_request: &641 allOf: - - *473 + - *472 - type: object properties: allow_auto_merge: @@ -153868,7 +153499,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *598 + repository: *597 sender: *4 required: - action @@ -153949,12 +153580,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *595 - installation: *596 - number: *641 - organization: *597 - pull_request: *642 - repository: *598 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 + pull_request: *641 + repository: *597 sender: *4 required: - action @@ -154034,11 +153665,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *595 - milestone: *371 - number: *641 - organization: *597 - pull_request: &643 + enterprise: *594 + milestone: *370 + number: *640 + organization: *596 + pull_request: &642 title: Pull Request type: object properties: @@ -156365,7 +155996,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -156444,11 +156075,11 @@ webhooks: type: string enum: - dequeued - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 number: type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -158794,7 +158425,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *598 + repository: *597 sender: *4 required: - action @@ -158918,12 +158549,12 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 - number: *641 - organization: *597 - pull_request: *642 - repository: *598 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 + pull_request: *641 + repository: *597 sender: *4 required: - action @@ -159003,11 +158634,11 @@ webhooks: type: string enum: - enqueued - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 number: type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -161338,7 +160969,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -161418,11 +161049,11 @@ webhooks: type: string enum: - labeled - enterprise: *595 - installation: *596 - label: *614 - number: *641 - organization: *597 + enterprise: *594 + installation: *595 + label: *613 + number: *640 + organization: *596 pull_request: title: Pull Request type: object @@ -163770,7 +163401,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -163851,10 +163482,10 @@ webhooks: type: string enum: - locked - enterprise: *595 - installation: *596 - number: *641 - organization: *597 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 pull_request: title: Pull Request type: object @@ -166200,7 +165831,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -166280,12 +165911,12 @@ webhooks: type: string enum: - milestoned - enterprise: *595 - milestone: *371 - number: *641 - organization: *597 - pull_request: *643 - repository: *598 + enterprise: *594 + milestone: *370 + number: *640 + organization: *596 + pull_request: *642 + repository: *597 sender: *4 required: - action @@ -166364,12 +165995,12 @@ webhooks: type: string enum: - opened - enterprise: *595 - installation: *596 - number: *641 - organization: *597 - pull_request: *642 - repository: *598 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 + pull_request: *641 + repository: *597 sender: *4 required: - action @@ -166450,12 +166081,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *595 - installation: *596 - number: *641 - organization: *597 - pull_request: *642 - repository: *598 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 + pull_request: *641 + repository: *597 sender: *4 required: - action @@ -166535,12 +166166,12 @@ webhooks: type: string enum: - reopened - enterprise: *595 - installation: *596 - number: *641 - organization: *597 - pull_request: *642 - repository: *598 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 + pull_request: *641 + repository: *597 sender: *4 required: - action @@ -166915,9 +166546,9 @@ webhooks: - start_side - side - reactions - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 pull_request: type: object properties: @@ -169147,7 +168778,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *598 + repository: *597 sender: *4 required: - action @@ -169227,7 +168858,7 @@ webhooks: type: string enum: - deleted - comment: &645 + comment: &644 title: Pull Request Review Comment description: The [comment](https://docs.github.com/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. @@ -169520,9 +169151,9 @@ webhooks: - start_side - side - reactions - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 pull_request: type: object properties: @@ -171740,7 +171371,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *598 + repository: *597 sender: *4 required: - action @@ -171820,11 +171451,11 @@ webhooks: type: string enum: - edited - changes: *644 - comment: *645 - enterprise: *595 - installation: *596 - organization: *597 + changes: *643 + comment: *644 + enterprise: *594 + installation: *595 + organization: *596 pull_request: type: object properties: @@ -174045,7 +173676,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *598 + repository: *597 sender: *4 required: - action @@ -174126,9 +173757,9 @@ webhooks: type: string enum: - dismissed - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 pull_request: title: Simple Pull Request type: object @@ -176361,7 +175992,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *598 + repository: *597 review: description: The review that was affected. type: object @@ -176607,9 +176238,9 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 pull_request: title: Simple Pull Request type: object @@ -178723,8 +178354,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *598 - review: &646 + repository: *597 + review: &645 description: The review that was affected. type: object properties: @@ -178957,12 +178588,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 number: description: The pull request number. type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -181309,7 +180940,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 requested_reviewer: title: User type: @@ -181395,12 +181026,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 number: description: The pull request number. type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -183754,7 +183385,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 requested_team: title: Team description: Groups of organization members that gives permissions @@ -183949,12 +183580,12 @@ webhooks: type: string enum: - review_requested - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 number: description: The pull request number. type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -186303,7 +185934,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 requested_reviewer: title: User type: @@ -186390,12 +186021,12 @@ webhooks: type: string enum: - review_requested - enterprise: *595 - installation: *596 + enterprise: *594 + installation: *595 number: description: The pull request number. type: integer - organization: *597 + organization: *596 pull_request: title: Pull Request type: object @@ -188735,7 +188366,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 requested_team: title: Team description: Groups of organization members that gives permissions @@ -188919,9 +188550,9 @@ webhooks: type: string enum: - submitted - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 pull_request: title: Simple Pull Request type: object @@ -191157,8 +190788,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *598 - review: *646 + repository: *597 + review: *645 sender: *4 required: - action @@ -191238,9 +190869,9 @@ webhooks: type: string enum: - resolved - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 pull_request: title: Simple Pull Request type: object @@ -193371,7 +193002,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *598 + repository: *597 sender: *4 thread: type: object @@ -193763,9 +193394,9 @@ webhooks: type: string enum: - unresolved - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 pull_request: title: Simple Pull Request type: object @@ -195879,7 +195510,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *598 + repository: *597 sender: *4 thread: type: object @@ -196273,10 +195904,10 @@ webhooks: type: string before: type: string - enterprise: *595 - installation: *596 - number: *641 - organization: *597 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 pull_request: title: Pull Request type: object @@ -198611,7 +198242,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -198693,11 +198324,11 @@ webhooks: type: string enum: - unassigned - assignee: *647 - enterprise: *595 - installation: *596 - number: *641 - organization: *597 + assignee: *646 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 pull_request: title: Pull Request type: object @@ -201047,7 +200678,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -201126,11 +200757,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *595 - installation: *596 - label: *614 - number: *641 - organization: *597 + enterprise: *594 + installation: *595 + label: *613 + number: *640 + organization: *596 pull_request: title: Pull Request type: object @@ -203469,7 +203100,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -203550,10 +203181,10 @@ webhooks: type: string enum: - unlocked - enterprise: *595 - installation: *596 - number: *641 - organization: *597 + enterprise: *594 + installation: *595 + number: *640 + organization: *596 pull_request: title: Pull Request type: object @@ -205882,7 +205513,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *598 + repository: *597 sender: *4 required: - action @@ -206085,7 +205716,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *595 + enterprise: *594 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -206180,8 +205811,8 @@ webhooks: - url - author - committer - installation: *596 - organization: *597 + installation: *595 + organization: *596 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -206769,9 +206400,9 @@ webhooks: type: string enum: - published - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 registry_package: type: object properties: @@ -207248,7 +206879,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *629 + items: *628 summary: type: string tag_name: @@ -207304,7 +206935,7 @@ webhooks: - owner - package_version - registry - repository: *598 + repository: *597 sender: *4 required: - action @@ -207382,9 +207013,9 @@ webhooks: type: string enum: - updated - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 registry_package: type: object properties: @@ -207696,7 +207327,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *629 + items: *628 summary: type: string tag_name: @@ -207746,7 +207377,7 @@ webhooks: - owner - package_version - registry - repository: *598 + repository: *597 sender: *4 required: - action @@ -207823,10 +207454,10 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - release: &648 + enterprise: *594 + installation: *595 + organization: *596 + release: &647 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -208142,7 +207773,7 @@ webhooks: - tarball_url - zipball_url - body - repository: *598 + repository: *597 sender: *4 required: - action @@ -208219,11 +207850,11 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 - release: *648 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + release: *647 + repository: *597 sender: *4 required: - action @@ -208331,11 +207962,11 @@ webhooks: type: boolean required: - to - enterprise: *595 - installation: *596 - organization: *597 - release: *648 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + release: *647 + repository: *597 sender: *4 required: - action @@ -208413,9 +208044,9 @@ webhooks: type: string enum: - prereleased - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 release: title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) @@ -208736,7 +208367,7 @@ webhooks: - string - 'null' format: uri - repository: *598 + repository: *597 sender: *4 required: - action @@ -208812,10 +208443,10 @@ webhooks: type: string enum: - published - enterprise: *595 - installation: *596 - organization: *597 - release: &649 + enterprise: *594 + installation: *595 + organization: *596 + release: &648 title: Release description: The [release](https://docs.github.com/rest/releases/releases/#get-a-release) object. @@ -209133,7 +208764,7 @@ webhooks: - string - 'null' format: uri - repository: *598 + repository: *597 sender: *4 required: - action @@ -209209,11 +208840,11 @@ webhooks: type: string enum: - released - enterprise: *595 - installation: *596 - organization: *597 - release: *648 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + release: *647 + repository: *597 sender: *4 required: - action @@ -209289,11 +208920,11 @@ webhooks: type: string enum: - unpublished - enterprise: *595 - installation: *596 - organization: *597 - release: *649 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + release: *648 + repository: *597 sender: *4 required: - action @@ -209369,11 +209000,11 @@ webhooks: type: string enum: - published - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - repository_advisory: *527 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + repository_advisory: *526 sender: *4 required: - action @@ -209449,11 +209080,11 @@ webhooks: type: string enum: - reported - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - repository_advisory: *527 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + repository_advisory: *526 sender: *4 required: - action @@ -209529,10 +209160,10 @@ webhooks: type: string enum: - archived - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -209609,10 +209240,10 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -209690,10 +209321,10 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -209778,10 +209409,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -209896,10 +209527,10 @@ webhooks: - 'null' items: type: string - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -209971,10 +209602,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 status: type: string @@ -210055,10 +209686,10 @@ webhooks: type: string enum: - privatized - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -210135,10 +209766,10 @@ webhooks: type: string enum: - publicized - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -210232,10 +209863,10 @@ webhooks: - name required: - repository - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -210315,11 +209946,11 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - repository_ruleset: *215 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + repository_ruleset: *209 sender: *4 required: - action @@ -210397,11 +210028,11 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - repository_ruleset: *215 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + repository_ruleset: *209 sender: *4 required: - action @@ -210479,11 +210110,11 @@ webhooks: type: string enum: - edited - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - repository_ruleset: *215 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + repository_ruleset: *209 changes: type: object properties: @@ -210502,16 +210133,16 @@ webhooks: properties: added: type: array - items: *209 + items: *203 deleted: type: array - items: *209 + items: *203 updated: type: array items: type: object properties: - condition: *209 + condition: *203 changes: type: object properties: @@ -210544,16 +210175,16 @@ webhooks: properties: added: type: array - items: *214 + items: *208 deleted: type: array - items: *214 + items: *208 updated: type: array items: type: object properties: - rule: *214 + rule: *208 changes: type: object properties: @@ -210790,10 +210421,10 @@ webhooks: - from required: - owner - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -210871,10 +210502,10 @@ webhooks: type: string enum: - unarchived - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -210952,7 +210583,7 @@ webhooks: type: string enum: - create - alert: &650 + alert: &649 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -211076,10 +210707,10 @@ webhooks: type: string enum: - open - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -211289,10 +210920,10 @@ webhooks: type: string enum: - dismissed - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -211370,11 +211001,11 @@ webhooks: type: string enum: - reopen - alert: *650 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + alert: *649 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -211576,10 +211207,10 @@ webhooks: enum: - fixed - open - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -211657,17 +211288,17 @@ webhooks: type: string enum: - created - alert: &651 + alert: &650 type: object properties: - number: *46 - created_at: *47 + number: *44 + created_at: *45 updated_at: anyOf: - type: 'null' - - *48 - url: *49 - html_url: *50 + - *46 + url: *47 + html_url: *48 locations_url: type: string format: uri @@ -211738,6 +211369,12 @@ webhooks: anyOf: - type: 'null' - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. push_protection_bypass_request_comment: type: - string @@ -211761,10 +211398,10 @@ webhooks: - 'null' description: Whether the detected secret was found in multiple repositories in the same organization or business. - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -211845,11 +211482,11 @@ webhooks: type: string enum: - created - alert: *651 - installation: *596 - location: *652 - organization: *597 - repository: *598 + alert: *650 + installation: *595 + location: *651 + organization: *596 + repository: *597 sender: *4 required: - location @@ -212087,11 +211724,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *651 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + alert: *650 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -212169,11 +211806,11 @@ webhooks: type: string enum: - reopened - alert: *651 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + alert: *650 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -212251,11 +211888,11 @@ webhooks: type: string enum: - resolved - alert: *651 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + alert: *650 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -212333,11 +211970,11 @@ webhooks: type: string enum: - validated - alert: *651 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + alert: *650 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -212413,11 +212050,11 @@ webhooks: type: string enum: - published - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - security_advisory: &653 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + security_advisory: &652 description: The details of the security advisory, including summary, description, and severity. type: object @@ -212434,7 +212071,7 @@ webhooks: required: - vector_string - score - cvss_severities: *44 + cvss_severities: *41 cwes: type: array items: @@ -212603,11 +212240,11 @@ webhooks: type: string enum: - updated - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 - security_advisory: *653 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 + security_advisory: *652 sender: *4 required: - action @@ -212680,10 +212317,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -212701,7 +212338,7 @@ webhooks: required: - vector_string - score - cvss_severities: *44 + cvss_severities: *41 cwes: type: array items: @@ -212869,11 +212506,11 @@ webhooks: from: type: object properties: - security_and_analysis: *208 - enterprise: *595 - installation: *596 - organization: *597 - repository: *253 + security_and_analysis: *202 + enterprise: *594 + installation: *595 + organization: *596 + repository: *252 sender: *4 required: - changes @@ -212951,12 +212588,12 @@ webhooks: type: string enum: - cancelled - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - sponsorship: &654 + sponsorship: &653 type: object properties: created_at: @@ -213261,12 +212898,12 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - sponsorship: *654 + sponsorship: *653 required: - action - sponsorship @@ -213354,12 +212991,12 @@ webhooks: type: string required: - from - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - sponsorship: *654 + sponsorship: *653 required: - action - changes @@ -213436,17 +213073,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &655 + effective_date: &654 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: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - sponsorship: *654 + sponsorship: *653 required: - action - sponsorship @@ -213520,7 +213157,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &656 + changes: &655 type: object properties: tier: @@ -213564,13 +213201,13 @@ webhooks: - from required: - tier - effective_date: *655 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + effective_date: *654 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - sponsorship: *654 + sponsorship: *653 required: - action - changes @@ -213647,13 +213284,13 @@ webhooks: type: string enum: - tier_changed - changes: *656 - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + changes: *655 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - sponsorship: *654 + sponsorship: *653 required: - action - changes @@ -213727,10 +213364,10 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -213814,10 +213451,10 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -214250,15 +213887,15 @@ webhooks: type: - string - 'null' - enterprise: *595 + enterprise: *594 id: description: The unique identifier of the status. type: integer - installation: *596 + installation: *595 name: type: string - organization: *597 - repository: *598 + organization: *596 + repository: *597 sender: *4 sha: description: The Commit SHA. @@ -214368,15 +214005,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *72 - parent_issue_repo: *57 + parent_issue: *67 + parent_issue_repo: *52 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *72 - installation: *596 - organization: *597 - repository: *598 + sub_issue: *67 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -214460,15 +214097,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *72 - parent_issue_repo: *57 + parent_issue: *67 + parent_issue_repo: *52 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *72 - installation: *596 - organization: *597 - repository: *598 + sub_issue: *67 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -214552,15 +214189,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *72 - sub_issue_repo: *57 + sub_issue: *67 + sub_issue_repo: *52 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *72 - installation: *596 - organization: *597 - repository: *598 + parent_issue: *67 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -214644,15 +214281,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *72 - sub_issue_repo: *57 + sub_issue: *67 + sub_issue_repo: *52 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *72 - installation: *596 - organization: *597 - repository: *598 + parent_issue: *67 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -214729,12 +214366,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - team: &657 + team: &656 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -214927,9 +214564,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 repository: title: Repository description: A git repository @@ -215399,7 +215036,7 @@ webhooks: - topics - visibility sender: *4 - team: *657 + team: *656 required: - action - team @@ -215475,9 +215112,9 @@ webhooks: type: string enum: - created - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 repository: title: Repository description: A git repository @@ -215947,7 +215584,7 @@ webhooks: - topics - visibility sender: *4 - team: *657 + team: *656 required: - action - team @@ -216024,9 +215661,9 @@ webhooks: type: string enum: - deleted - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 repository: title: Repository description: A git repository @@ -216496,7 +216133,7 @@ webhooks: - topics - visibility sender: *4 - team: *657 + team: *656 required: - action - team @@ -216640,9 +216277,9 @@ webhooks: - from required: - permissions - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 repository: title: Repository description: A git repository @@ -217112,7 +216749,7 @@ webhooks: - topics - visibility sender: *4 - team: *657 + team: *656 required: - action - changes @@ -217190,9 +216827,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *595 - installation: *596 - organization: *597 + enterprise: *594 + installation: *595 + organization: *596 repository: title: Repository description: A git repository @@ -217662,7 +217299,7 @@ webhooks: - topics - visibility sender: *4 - team: *657 + team: *656 required: - action - team @@ -217738,10 +217375,10 @@ webhooks: type: string enum: - started - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 required: - action @@ -217814,17 +217451,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *595 + enterprise: *594 inputs: type: - object - 'null' additionalProperties: true - installation: *596 - organization: *597 + installation: *595 + organization: *596 ref: type: string - repository: *598 + repository: *597 sender: *4 workflow: type: string @@ -217906,10 +217543,10 @@ webhooks: type: string enum: - completed - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 workflow_job: allOf: @@ -218165,7 +217802,7 @@ webhooks: type: string required: - conclusion - deployment: *391 + deployment: *390 required: - action - repository @@ -218244,10 +217881,10 @@ webhooks: type: string enum: - in_progress - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 workflow_job: allOf: @@ -218529,7 +218166,7 @@ webhooks: required: - status - steps - deployment: *391 + deployment: *390 required: - action - repository @@ -218608,10 +218245,10 @@ webhooks: type: string enum: - queued - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 workflow_job: type: object @@ -218757,7 +218394,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *391 + deployment: *390 required: - action - repository @@ -218836,10 +218473,10 @@ webhooks: type: string enum: - waiting - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 workflow_job: type: object @@ -218986,7 +218623,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *391 + deployment: *390 required: - action - repository @@ -219066,12 +218703,12 @@ webhooks: type: string enum: - completed - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - workflow: *610 + workflow: *609 workflow_run: title: Workflow Run type: object @@ -220090,12 +219727,12 @@ webhooks: type: string enum: - in_progress - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - workflow: *610 + workflow: *609 workflow_run: title: Workflow Run type: object @@ -221099,12 +220736,12 @@ webhooks: type: string enum: - requested - enterprise: *595 - installation: *596 - organization: *597 - repository: *598 + enterprise: *594 + installation: *595 + organization: *596 + repository: *597 sender: *4 - workflow: *610 + workflow: *609 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index a9c03dcf4..0dd30c4c7 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -29069,7 +29069,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-user-management" @@ -29725,7 +29725,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-metrics" @@ -30085,7 +30085,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-usage" @@ -32449,664 +32449,7780 @@ "string", "null" ], - "description": "Short description of the property" + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "minItems": 1, + "maxItems": 100 + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + } + }, + "/enterprises/{enterprise}/properties/schema/{custom_property_name}": { + "get": { + "summary": "Get a custom property for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/get-enterprise-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-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": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + }, + "put": { + "summary": "Create or update a custom property for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new or updates an existing custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/create-or-update-enterprise-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-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": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + }, + "required": [ + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + }, + "delete": { + "summary": "Remove a custom property for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemove a custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/remove-enterprise-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-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": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "A header with no content is returned." + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + } + }, + "/enterprises/{enterprise}/rulesets": { + "post": { + "summary": "Create an enterprise repository ruleset", + "description": "Create a repository ruleset for an enterprise.", + "tags": [ + "repos" + ], + "operationId": "repos/create-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset" + }, + "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" + } + } + ], + "requestBody": { + "description": "Request body", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ], + "default": "branch" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "EnterpriseOwner" + ], + "description": "The type of actor that can bypass a ruleset" + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "conditions": { + "title": "Enterprise ruleset conditions", + "type": "object", + "description": "Conditions for an enterprise ruleset. The conditions object should contain either the `organization_id` or `organization_name` property and the `repository_name` or `repository_property` property. For branch and tag rulesets, the conditions object should also contain the `ref_name` property.", + "oneOf": [ + { + "type": "object", + "title": "organization_name_and_repository_name", + "description": "Conditions to target organizations by name and all repositories", + "allOf": [ + { + "title": "Repository ruleset conditions for organization names", + "type": "object", + "description": "Parameters for an organization name condition", + "properties": { + "organization_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "organization_name" + ] + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_name_and_repository_property", + "description": "Conditions to target organizations by name and repositories by property", + "allOf": [ + { + "title": "Repository ruleset conditions for organization names", + "type": "object", + "description": "Parameters for an organization name condition", + "properties": { + "organization_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "organization_name" + ] + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_name", + "description": "Conditions to target organizations by id and all repositories", + "allOf": [ + { + "title": "Repository ruleset conditions for organization IDs", + "type": "object", + "description": "Parameters for an organization ID condition", + "properties": { + "organization_id": { + "type": "object", + "properties": { + "organization_ids": { + "type": "array", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "organization_id" + ] + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_property", + "description": "Conditions to target organization by id and repositories by property", + "allOf": [ + { + "title": "Repository ruleset conditions for organization IDs", + "type": "object", + "description": "Parameters for an organization ID condition", + "properties": { + "organization_id": { + "type": "object", + "properties": { + "organization_ids": { + "type": "array", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "organization_id" + ] + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + } + ] + }, + "rules": { + "type": "array", + "description": "An array of rules within the ruleset.", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths", + "minimum": 1, + "maximum": 256 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + } + ] + } + } + }, + "required": [ + "name", + "enforcement" + ] + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "repository", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "org_name": { + "include": [ + "important_org" + ], + "exclude": [ + "unimportant_org" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] + }, + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "EnterpriseOwner" + ], + "description": "The type of actor that can bypass a ruleset" + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": [ + "object", + "null" + ], + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + } + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + } + ] + } + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "rules": { + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths", + "minimum": 1, + "maximum": 256 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + } + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "examples": { + "default": { + "value": { + "id": 21, + "name": "super cool ruleset", + "target": "repository", + "source_type": "Enterprise", + "source": "my-enterprise", + "enforcement": "active", + "conditions": { + "organization_name": { + "include": [ + "important_organization" + ] + }, + "repository_name": { + "include": [ + "~ALL" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/enterprises/my-enterprise/rulesets/21" + }, + "html": { + "href": "https://github.com/enterprise/my-enterprise/settings/policies/repositories/21" + } + }, + "created_at": "2024-08-15T08:43:03Z", + "updated_at": "2024-09-23T16:29:47Z" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "rules" + } + } + }, + "/enterprises/{enterprise}/rulesets/{ruleset_id}": { + "get": { + "summary": "Get an enterprise repository ruleset", + "description": "Get a repository ruleset for an enterprise.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", + "tags": [ + "repos" + ], + "operationId": "repos/get-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset" + }, + "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": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] + }, + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "EnterpriseOwner" + ], + "description": "The type of actor that can bypass a ruleset" + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": [ + "object", + "null" + ], + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + } + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + } + ] + } + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "rules": { + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths", + "minimum": 1, + "maximum": 256 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + } + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "examples": { + "default": { + "value": { + "id": 21, + "name": "super cool ruleset", + "target": "repository", + "source_type": "Enterprise", + "source": "my-enterprise", + "enforcement": "active", + "conditions": { + "organization_name": { + "include": [ + "important_organization" + ] + }, + "repository_name": { + "include": [ + "~ALL" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/enterprises/my-enterprise/rulesets/21" + }, + "html": { + "href": "https://github.com/enterprise/my-enterprise/settings/policies/repositories/21" + } + }, + "created_at": "2024-08-15T08:43:03Z", + "updated_at": "2024-09-23T16:29:47Z" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "rules" + } + }, + "put": { + "summary": "Update an enterprise repository ruleset", + "description": "Update a ruleset for an enterprise.", + "tags": [ + "repos" + ], + "operationId": "repos/update-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset" + }, + "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": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "description": "Request body", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "EnterpriseOwner" + ], + "description": "The type of actor that can bypass a ruleset" + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "conditions": { + "title": "Enterprise ruleset conditions", + "type": "object", + "description": "Conditions for an enterprise ruleset. The conditions object should contain either the `organization_id` or `organization_name` property and the `repository_name` or `repository_property` property. For branch and tag rulesets, the conditions object should also contain the `ref_name` property.", + "oneOf": [ + { + "type": "object", + "title": "organization_name_and_repository_name", + "description": "Conditions to target organizations by name and all repositories", + "allOf": [ + { + "title": "Repository ruleset conditions for organization names", + "type": "object", + "description": "Parameters for an organization name condition", + "properties": { + "organization_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "organization_name" + ] + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_name_and_repository_property", + "description": "Conditions to target organizations by name and repositories by property", + "allOf": [ + { + "title": "Repository ruleset conditions for organization names", + "type": "object", + "description": "Parameters for an organization name condition", + "properties": { + "organization_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "organization_name" + ] + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_name", + "description": "Conditions to target organizations by id and all repositories", + "allOf": [ + { + "title": "Repository ruleset conditions for organization IDs", + "type": "object", + "description": "Parameters for an organization ID condition", + "properties": { + "organization_id": { + "type": "object", + "properties": { + "organization_ids": { + "type": "array", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "organization_id" + ] + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_property", + "description": "Conditions to target organization by id and repositories by property", + "allOf": [ + { + "title": "Repository ruleset conditions for organization IDs", + "type": "object", + "description": "Parameters for an organization ID condition", + "properties": { + "organization_id": { + "type": "object", + "properties": { + "organization_ids": { + "type": "array", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "organization_id" + ] + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + } + ] + }, + "rules": { + "description": "An array of rules within the ruleset.", + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths", + "minimum": 1, + "maximum": 256 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } }, - "allowed_values": { - "type": [ - "array", - "null" + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } - }, - "required": [ - "property_name", - "value_type" ] - }, - "minItems": 1, - "maxItems": 100 + } } - }, - "required": [ - "properties" - ] + } }, "examples": { "default": { "value": { - "properties": [ - { - "property_name": "environment", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ], - "values_editable_by": "org_actors" - }, - { - "property_name": "service", - "value_type": "string" - }, + "name": "super cool ruleset", + "target": "repository", + "enforcement": "active", + "bypass_actors": [ { - "property_name": "team", - "value_type": "string", - "description": "Team owning the repository" + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ], - "examples": [ - "organization" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null + ], + "conditions": { + "org_name": { + "include": [ + "important_org" ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" + "exclude": [ + "unimportant_org" ] } }, - "required": [ - "property_name", - "value_type" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ], - "values_editable_by": "org_actors" - }, - { - "property_name": "service", - "url": "https://api.github.com/orgs/github/properties/schema/service", - "source_type": "organization", - "value_type": "string" - }, + "rules": [ { - "property_name": "team", - "url": "https://api.github.com/orgs/github/properties/schema/team", - "source_type": "organization", - "value_type": "string", - "description": "Team owning the repository" + "type": "repository_delete" } ] } } } } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } } }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "enterprise-admin", - "subcategory": "custom-properties" - } - } - }, - "/enterprises/{enterprise}/properties/schema/{custom_property_name}": { - "get": { - "summary": "Get a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.", - "tags": [ - "enterprise-admin" - ], - "operationId": "enterprise-admin/get-enterprise-custom-property", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-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": "custom_property_name", - "description": "The custom property name", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", + "title": "Repository ruleset", "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" + "id": { + "type": "integer", + "description": "The ID of the ruleset" }, - "url": { + "name": { "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + "description": "The name of the ruleset" }, - "source_type": { + "target": { "type": "string", - "description": "The source type of the property", + "description": "The target of the ruleset", "enum": [ - "organization", - "enterprise" - ], - "examples": [ - "organization" + "branch", + "tag", + "push", + "repository" ] }, - "value_type": { + "source_type": { "type": "string", + "description": "The type of the source of the ruleset", "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] - } - }, - "required": [ - "property_name", - "value_type" - ] - }, - "examples": { - "default": { - "value": { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" + "Repository", + "Organization", + "Enterprise" ] - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "enterprise-admin", - "subcategory": "custom-properties" - } - }, - "put": { - "summary": "Create or update a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new or updates an existing custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", - "tags": [ - "enterprise-admin" - ], - "operationId": "enterprise-admin/create-or-update-enterprise-custom-property", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-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": "custom_property_name", - "description": "The custom property name", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" }, - "url": { + "source": { "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + "description": "The name of the source" }, - "source_type": { + "enforcement": { "type": "string", - "description": "The source type of the property", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ - "organization", - "enterprise" - ], - "examples": [ - "organization" + "disabled", + "active", + "evaluate" ] }, - "value_type": { + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "EnterpriseOwner" + ], + "description": "The type of actor that can bypass a ruleset" + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" + "always", + "pull_requests_only", + "never" ] }, - "required": { - "type": "boolean", - "description": "Whether the property is required." + "node_id": { + "type": "string" }, - "default_value": { - "oneOf": [ - { - "type": "string" + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } }, + "html": { + "type": [ + "object", + "null" + ], + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "anyOf": [ { - "type": "array", - "items": { - "type": "string" + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } } + }, + { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + } + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + } + ] + } + ] } ], - "description": "Default value of the property", "type": [ "null", - "string", - "array" + "object" ] }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], + "rules": { + "type": "array", "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths", + "minimum": 1, + "maximum": 256 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + } + ] + } }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } - }, - "required": [ - "property_name", - "value_type" - ] + } }, "examples": { "default": { "value": { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ] + "id": 21, + "name": "super cool ruleset", + "target": "repository", + "source_type": "Enterprise", + "source": "my-enterprise", + "enforcement": "active", + "conditions": { + "organization_name": { + "include": [ + "important_organization" + ] + }, + "repository_name": { + "include": [ + "~ALL" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/enterprises/my-enterprise/rulesets/21" + }, + "html": { + "href": "https://github.com/enterprise/my-enterprise/settings/policies/repositories/21" + } + }, + "created_at": "2024-08-15T08:43:03Z", + "updated_at": "2024-09-23T16:29:47Z" } } } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -33131,8 +40247,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -33162,19 +40278,19 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "custom-properties" + "subcategory": "rules" } }, "delete": { - "summary": "Remove a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemove a custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "summary": "Delete an enterprise repository ruleset", + "description": "Delete a ruleset for an enterprise.", "tags": [ - "enterprise-admin" + "repos" ], - "operationId": "enterprise-admin/remove-enterprise-custom-property", + "operationId": "repos/delete-enterprise-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset" }, "parameters": [ { @@ -33187,21 +40303,21 @@ } }, { - "name": "custom_property_name", - "description": "The custom property name", + "name": "ruleset_id", + "description": "The ID of the ruleset.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { "204": { - "description": "A header with no content is returned." + "description": "Response" }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -33226,8 +40342,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -33257,7 +40373,7 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "custom-properties" + "subcategory": "rules" } } }, @@ -34583,6 +41699,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -34775,6 +41898,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -34866,6 +41990,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -37126,7 +44251,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-metrics" @@ -37495,7 +44620,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-usage" @@ -83506,6 +90631,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -147377,6 +154505,8 @@ "content": { "application/json": { "schema": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", "type": "object", "properties": { "value_type": { @@ -154784,7 +161914,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -154792,7 +161923,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -154801,7 +161933,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -154919,7 +162051,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -155390,6 +162522,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -156134,13 +163273,14 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ], "default": "branch" }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -156192,7 +163332,7 @@ "conditions": { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -156658,6 +163798,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -157331,7 +164478,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -157339,7 +164487,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -157348,7 +164497,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -157466,7 +164615,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -157937,6 +165086,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -159268,7 +166424,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -159276,7 +166433,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -159285,7 +166443,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -159403,7 +166561,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -159874,6 +167032,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -160644,12 +167809,13 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -160701,7 +167867,7 @@ "conditions": { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -161167,6 +168333,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -161836,7 +169009,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -161844,7 +169018,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -161853,7 +169028,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -161971,7 +169146,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -162442,6 +169617,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -164584,6 +171766,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -164776,6 +171965,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -164867,6 +172057,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -190619,6 +197810,30 @@ "reset", "used" ] + }, + "code_scanning_autofix": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] } }, "required": [ @@ -190719,6 +197934,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -226355,6 +233576,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -482908,6 +490132,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -483780,7 +491011,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -483788,7 +491020,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -483797,7 +491030,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -483915,7 +491148,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -484386,6 +491619,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -485145,7 +492385,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -485445,6 +492685,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -486108,7 +493355,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -486116,7 +493364,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -486125,7 +493374,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -486243,7 +493492,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -486714,6 +493963,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -488064,7 +495320,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -488072,7 +495329,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -488081,7 +495339,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -488199,7 +495457,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -488670,6 +495928,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -489444,7 +496709,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -489744,6 +497009,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -490403,7 +497675,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -490411,7 +497684,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -490420,7 +497694,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -490538,7 +497812,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -491009,6 +498283,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -492615,6 +499896,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -492733,6 +500021,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -492757,6 +500046,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -493484,6 +500774,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -493543,6 +500840,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -494322,6 +501620,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -494400,6 +501705,7 @@ "push_protection_bypassed_by": null, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": "Example comment", @@ -622504,6 +629810,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -666626,6 +673935,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -668841,6 +676157,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -671056,6 +678379,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -673271,6 +680601,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -673315,6 +680652,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -675520,6 +682864,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -675564,6 +682915,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -677769,6 +685127,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -679984,6 +687349,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -682199,6 +689571,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -684414,6 +691793,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -684458,6 +691844,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -686663,6 +694056,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -686707,6 +694107,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -1263943,7 +1271350,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1263951,7 +1271359,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1263960,7 +1271369,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -1264078,7 +1271487,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -1264549,6 +1271958,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1267150,7 +1274566,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1267158,7 +1274575,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1267167,7 +1274585,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -1267285,7 +1274703,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -1267756,6 +1275174,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1270357,7 +1277782,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1270365,7 +1277791,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1270374,7 +1277801,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -1270492,7 +1277919,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -1270963,6 +1278390,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1271947,6 +1279381,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1272759,6 +1280200,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1273574,6 +1281022,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1287868,6 +1295323,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1290509,6 +1297971,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1293584,6 +1301053,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1296225,6 +1303701,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1298866,6 +1306349,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1301507,6 +1308997,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index aa209a7e2..4acf176e1 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -896,7 +896,7 @@ paths: - subscriptions_url - type - url - type: &284 + type: &291 type: string description: The type of credit the user is receiving. enum: @@ -1029,7 +1029,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &142 + schema: &154 title: Validation Error Simple description: Validation Error Simple type: object @@ -1062,7 +1062,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &587 + - &594 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1593,7 +1593,7 @@ paths: schema: type: integer default: 30 - - &212 + - &224 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 @@ -1609,7 +1609,7 @@ paths: application/json: schema: type: array - items: &213 + items: &225 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1702,7 +1702,7 @@ paths: - installation_id - repository_id examples: - default: &214 + default: &226 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1734,7 +1734,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &597 + schema: &604 title: Scim Error description: Scim Error type: object @@ -1765,7 +1765,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &141 + schema: &153 title: Validation Error description: Validation Error type: object @@ -1837,7 +1837,7 @@ paths: description: Response content: application/json: - schema: &215 + schema: &227 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1972,7 +1972,7 @@ paths: - request - response examples: - default: &216 + default: &228 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2032,7 +2032,7 @@ paths: parameters: - *16 responses: - '202': &144 + '202': &156 description: Accepted content: application/json: @@ -2241,7 +2241,7 @@ paths: parameters: - *17 - *18 - - &106 + - &118 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) @@ -3003,7 +3003,7 @@ paths: license: anyOf: - type: 'null' - - &117 + - &129 title: License Simple description: License Simple type: object @@ -7598,7 +7598,7 @@ paths: description: Response content: application/json: - schema: &145 + schema: &157 type: object properties: total_active_caches_count: @@ -7613,7 +7613,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &146 + default: &158 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7708,7 +7708,7 @@ paths: - all - local_only - selected - selected_actions_url: &149 + selected_actions_url: &161 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` @@ -8089,7 +8089,7 @@ paths: description: Success response content: application/json: - schema: &152 + schema: &164 type: object properties: default_workflow_permissions: &44 @@ -8137,7 +8137,7 @@ paths: required: true content: application/json: - schema: &153 + schema: &165 type: object properties: default_workflow_permissions: *44 @@ -8966,7 +8966,7 @@ paths: application/json: schema: type: array - items: &157 + items: &169 title: Runner Application description: Runner Application type: object @@ -8991,7 +8991,7 @@ paths: - download_url - filename examples: - default: &158 + default: &170 value: - os: osx architecture: x64 @@ -9075,7 +9075,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &159 + '201': &171 description: Response content: application/json: @@ -9189,7 +9189,7 @@ paths: - token - expires_at examples: - default: &160 + default: &172 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -9229,7 +9229,7 @@ paths: application/json: schema: *56 examples: - default: &161 + default: &173 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -9261,7 +9261,7 @@ paths: application/json: schema: *53 examples: - default: &162 + default: &174 value: id: 23 name: MBP @@ -9475,7 +9475,7 @@ paths: - *38 - *52 responses: - '200': &163 + '200': &175 description: Response content: application/json: @@ -9531,7 +9531,7 @@ paths: parameters: - *38 - *52 - - &164 + - &176 name: name description: The name of a self-hosted runner's custom label. in: path @@ -9628,7 +9628,7 @@ paths: required: true content: application/json: - schema: &171 + schema: &183 title: Enterprise Announcement description: Enterprise global announcement type: object @@ -9699,7 +9699,7 @@ paths: required: false schema: type: string - - &172 + - &184 name: include description: |- The event types to include: @@ -9717,7 +9717,7 @@ paths: - web - git - all - - &173 + - &185 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. @@ -9725,7 +9725,7 @@ paths: required: false schema: type: string - - &174 + - &186 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. @@ -9733,7 +9733,7 @@ paths: required: false schema: type: string - - &175 + - &187 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -9755,7 +9755,7 @@ paths: application/json: schema: type: array - items: &176 + items: &188 type: object properties: "@timestamp": @@ -9877,7 +9877,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &177 + default: &189 value: - "@timestamp": 1606929874512 action: team.add_member @@ -10441,7 +10441,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *38 - - &179 + - &191 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`, @@ -10451,7 +10451,7 @@ paths: schema: &77 type: string description: The name of the tool used to generate the code scanning analysis. - - &180 + - &192 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 @@ -10475,7 +10475,7 @@ paths: be returned. in: query required: false - schema: &181 + schema: &193 type: string description: State of a code scanning alert. enum: @@ -10500,7 +10500,7 @@ paths: application/json: schema: type: array - items: &182 + items: &194 type: object properties: number: &81 @@ -10529,7 +10529,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &392 + instances_url: &399 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -10565,7 +10565,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &393 + dismissed_reason: &400 type: - string - 'null' @@ -10576,14 +10576,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &394 + dismissed_comment: &401 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &395 + rule: &402 type: object properties: id: @@ -10644,7 +10644,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &396 + tool: &403 type: object properties: name: *77 @@ -10655,15 +10655,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *78 - most_recent_instance: &397 + most_recent_instance: &404 type: object properties: - ref: &390 + ref: &397 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &403 + analysis_key: &410 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -10674,7 +10674,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &404 + category: &411 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -11058,7 +11058,7 @@ paths: - most_recent_instance - repository examples: - default: &183 + default: &195 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -11289,7 +11289,7 @@ paths: headers: Link: *37 '404': *6 - '503': &96 + '503': &108 description: Service unavailable content: application/json: @@ -11716,7 +11716,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &190 + items: &202 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -11731,7 +11731,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &234 + - &246 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -11790,7 +11790,7 @@ paths: parent: anyOf: - type: 'null' - - &247 + - &259 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -11988,7 +11988,7 @@ paths: - created_at additionalProperties: false examples: - default: &191 + default: &203 value: total_seats: 2 seats: @@ -12066,7 +12066,7 @@ paths: '403': *27 '404': *6 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-user-management @@ -12123,7 +12123,7 @@ paths: application/json: schema: type: array - items: &98 + items: &110 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -12439,7 +12439,7 @@ paths: - date additionalProperties: true examples: - default: &99 + default: &111 value: - date: '2024-06-24' total_active_users: 24 @@ -12541,14 +12541,14 @@ paths: '500': *80 '403': *27 '404': *6 - '422': &100 + '422': &112 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: application/json: schema: *3 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-metrics @@ -12611,7 +12611,7 @@ paths: application/json: schema: type: array - items: &101 + items: &113 title: Copilot Usage Metrics description: Summary of Copilot usage. type: object @@ -12768,7 +12768,7 @@ paths: '403': *27 '404': *6 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage @@ -12791,7 +12791,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *38 - - &198 + - &210 name: state in: query description: |- @@ -12800,7 +12800,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &199 + - &211 name: severity in: query description: |- @@ -12809,7 +12809,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &200 + - &212 name: ecosystem in: query description: |- @@ -12818,14 +12818,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &201 + - &213 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 - - &202 + - &214 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -12835,7 +12835,7 @@ paths: enum: - development - runtime - - &203 + - &215 name: sort in: query description: |- @@ -12851,7 +12851,7 @@ paths: - *76 - *74 - *75 - - &204 + - &216 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -12864,7 +12864,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &205 + - &217 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -12884,7 +12884,7 @@ paths: application/json: schema: type: array - items: &206 + items: &218 type: object description: A Dependabot alert. properties: @@ -12936,7 +12936,7 @@ paths: - development - runtime - - security_advisory: &441 + security_advisory: &448 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -13171,7 +13171,7 @@ paths: dismissal. maxLength: 280 fixed_at: *90 - auto_dismissed_at: &442 + auto_dismissed_at: &449 type: - string - 'null' @@ -13198,7 +13198,7 @@ paths: - repository additionalProperties: false examples: - default: &207 + default: &219 value: - number: 2 state: dismissed @@ -13854,6 +13854,67 @@ paths: parameters: - *38 - *94 + requestBody: + required: true + content: + application/json: + schema: &275 + title: Custom Property Set Payload + description: Custom property set payload + type: object + properties: + value_type: + type: string + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + required: + - value_type + examples: + default: + value: + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development responses: '200': description: Response @@ -13888,7 +13949,7 @@ paths: - *38 - *94 responses: - '204': &185 + '204': &197 description: A header with no content is returned. '403': *27 '404': *6 @@ -13897,6 +13958,1263 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: custom-properties + "/enterprises/{enterprise}/rulesets": + post: + summary: Create an enterprise repository ruleset + description: Create a repository ruleset for an enterprise. + tags: + - repos + operationId: repos/create-enterprise-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset + parameters: + - *38 + requestBody: + description: Request body + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the ruleset. + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + default: branch + enforcement: &102 + type: string + description: The enforcement level of the ruleset. `evaluate` allows + admins to test rules before enforcing them. Admins can view insights + on the Rule Insights page. `evaluate` is not available for the + `repository` target. + enum: + - disabled + - active + - evaluate + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: &103 + title: Repository Ruleset Bypass Actor + type: object + description: An actor that can bypass rules in a ruleset + required: + - actor_type + properties: + actor_id: + type: + - integer + - 'null' + description: The ID of the actor that can bypass a ruleset. + If `actor_type` is `OrganizationAdmin`, this should be `1`. + If `actor_type` is `DeployKey`, this should be null. If + `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. + `OrganizationAdmin` and `EnterpriseOwner` are not applicable + for personal repositories. + actor_type: + type: string + enum: + - Integration + - OrganizationAdmin + - RepositoryRole + - Team + - DeployKey + - EnterpriseOwner + description: The type of actor that can bypass a ruleset + bypass_mode: + type: string + description: When the specified actor can bypass the ruleset. + `pull_request` means that an actor can only bypass rules + on pull requests. `pull_request` is not applicable for the + `DeployKey` actor type. Also, `pull_request` is only applicable + to branch rulesets. + enum: + - always + - pull_request + default: always + conditions: &107 + title: Enterprise ruleset conditions + type: object + description: Conditions for an enterprise ruleset. The conditions + object should contain either the `organization_id` or `organization_name` + property and the `repository_name` or `repository_property` property. + For branch and tag rulesets, the conditions object should also + contain the `ref_name` property. + oneOf: + - type: object + title: organization_name_and_repository_name + description: Conditions to target organizations by name and all + repositories + allOf: + - &96 + title: Repository ruleset conditions for organization names + type: object + description: Parameters for an organization name condition + properties: + organization_name: + type: object + properties: + include: + type: array + description: Array of organization names or patterns + to include. One of these patterns must match for the + condition to pass. Also accepts `~ALL` to include + all organizations and ~EMUS to target all enterprise + managed user accounts. + items: + type: string + exclude: + type: array + description: Array of organization names or patterns + to exclude. The condition will not pass if any of + these patterns match. + items: + type: string + required: + - organization_name + - &99 + title: Repository ruleset conditions for repository names + type: object + description: Parameters for a repository name condition + properties: + repository_name: + type: object + properties: + include: + type: array + description: Array of repository names or patterns to + include. One of these patterns must match for the + condition to pass. Also accepts `~ALL` to include + all repositories. + items: + type: string + exclude: + type: array + description: Array of repository names or patterns to + exclude. The condition will not pass if any of these + patterns match. + items: + type: string + protected: + type: boolean + description: Whether renaming of target repositories + is prevented. + required: + - repository_name + - &98 + title: Repository ruleset conditions for ref names + type: object + description: Parameters for a repository ruleset ref name condition + properties: + ref_name: + type: object + properties: + include: + type: array + description: Array of ref names or patterns to include. + One of these patterns must match for the condition + to pass. Also accepts `~DEFAULT_BRANCH` to include + the default branch or `~ALL` to include all branches. + items: + type: string + exclude: + type: array + description: Array of ref names or patterns to exclude. + The condition will not pass if any of these patterns + match. + items: + type: string + - type: object + title: organization_name_and_repository_property + description: Conditions to target organizations by name and repositories + by property + allOf: + - *96 + - &101 + title: Repository ruleset conditions for repository properties + type: object + description: Parameters for a repository property condition + properties: + repository_property: + type: object + properties: + include: + type: array + description: The repository properties and values to + include. All of these properties must match for the + condition to pass. + items: &97 + title: Repository ruleset property targeting definition + type: object + description: Parameters for a targeting a repository + property + properties: + name: + type: string + description: The name of the repository property + to target + property_values: + type: array + description: The values to match for the repository + property + items: + type: string + source: + type: string + description: The source of the repository property. + Defaults to 'custom' if not specified. + enum: + - custom + - system + required: + - name + - property_values + exclude: + type: array + description: The repository properties and values to + exclude. The condition will not pass if any of these + properties match. + items: *97 + required: + - repository_property + - *98 + - type: object + title: organization_id_and_repository_name + description: Conditions to target organizations by id and all + repositories + allOf: + - &100 + title: Repository ruleset conditions for organization IDs + type: object + description: Parameters for an organization ID condition + properties: + organization_id: + type: object + properties: + organization_ids: + type: array + description: The organization IDs that the ruleset applies + to. One of these IDs must match for the condition + to pass. + items: + type: integer + required: + - organization_id + - *99 + - *98 + - type: object + title: organization_id_and_repository_property + description: Conditions to target organization by id and repositories + by property + allOf: + - *100 + - *101 + - *98 + rules: + type: array + description: An array of rules within the ruleset. + items: &104 + title: Repository Rule + type: object + description: A repository rule. + oneOf: + - &555 + title: creation + description: Only allow users with bypass permission to create + matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - creation + - &556 + title: update + description: Only allow users with bypass permission to update + matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - update + parameters: + type: object + properties: + update_allows_fetch_and_merge: + type: boolean + description: Branch can pull changes from its upstream + repository + required: + - update_allows_fetch_and_merge + - &558 + title: deletion + description: Only allow users with bypass permissions to delete + matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - deletion + - &559 + title: required_linear_history + description: Prevent merge commits from being pushed to matching + refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_linear_history + - &560 + title: merge_queue + description: Merges must be performed via a merge queue. + type: object + required: + - type + properties: + type: + type: string + enum: + - merge_queue + parameters: + type: object + properties: + check_response_timeout_minutes: + type: integer + description: Maximum time for a required status check + to report a conclusion. After this much time has elapsed, + checks that have not reported a conclusion will be + assumed to have failed + minimum: 1 + maximum: 360 + grouping_strategy: + type: string + description: When set to ALLGREEN, the merge commit + created by merge queue for each PR in the group must + pass all required checks to merge. When set to HEADGREEN, + only the commit at the head of the merge group, i.e. + the commit containing changes from all of the PRs + in the group, must pass its required checks to merge. + enum: + - ALLGREEN + - HEADGREEN + max_entries_to_build: + type: integer + description: Limit the number of queued pull requests + requesting checks and workflow runs at the same time. + minimum: 0 + maximum: 100 + max_entries_to_merge: + type: integer + description: The maximum number of PRs that will be + merged together in a group. + minimum: 0 + maximum: 100 + merge_method: + type: string + description: Method to use when merging changes from + queued pull requests. + enum: + - MERGE + - SQUASH + - REBASE + min_entries_to_merge: + type: integer + description: The minimum number of PRs that will be + merged together in a group. + minimum: 0 + maximum: 100 + min_entries_to_merge_wait_minutes: + type: integer + description: The time merge queue should wait after + the first PR is added to the queue for the minimum + group size to be met. After this time has elapsed, + the minimum group size will be ignored and a smaller + group will be merged. + minimum: 0 + maximum: 360 + required: + - check_response_timeout_minutes + - grouping_strategy + - max_entries_to_build + - max_entries_to_merge + - merge_method + - min_entries_to_merge + - min_entries_to_merge_wait_minutes + - &561 + title: required_deployments + description: Choose which environments must be successfully + deployed to before refs can be pushed into a ref that matches + this rule. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_deployments + parameters: + type: object + properties: + required_deployment_environments: + type: array + description: The environments that must be successfully + deployed to before branches can be merged. + items: + type: string + required: + - required_deployment_environments + - &562 + title: required_signatures + description: Commits pushed to matching refs must have verified + signatures. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_signatures + - &563 + title: pull_request + description: Require all commits be made to a non-target branch + and submitted via a pull request before they can be merged. + type: object + required: + - type + properties: + type: + type: string + enum: + - pull_request + parameters: + type: object + properties: + allowed_merge_methods: + type: array + description: When merging pull requests, you can allow + any combination of merge commits, squashing, or rebasing. + At least one option must be enabled. + items: + type: string + dismiss_stale_reviews_on_push: + type: boolean + description: New, reviewable commits pushed will dismiss + previous pull request review approvals. + require_code_owner_review: + type: boolean + description: Require an approving review in pull requests + that modify files that have a designated code owner. + require_last_push_approval: + type: boolean + description: Whether the most recent reviewable push + must be approved by someone other than the person + who pushed it. + required_approving_review_count: + type: integer + description: The number of approving reviews that are + required before a pull request can be merged. + minimum: 0 + maximum: 10 + required_review_thread_resolution: + type: boolean + description: All conversations on code must be resolved + before a pull request can be merged. + required: + - dismiss_stale_reviews_on_push + - require_code_owner_review + - require_last_push_approval + - required_approving_review_count + - required_review_thread_resolution + - &564 + title: required_status_checks + description: Choose which status checks must pass before the + ref is updated. When enabled, commits must first be pushed + to another ref where the checks pass. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_status_checks + parameters: + type: object + properties: + do_not_enforce_on_create: + type: boolean + description: Allow repositories and branches to be created + if a check would otherwise prohibit it. + required_status_checks: + type: array + description: Status checks that are required. + items: + title: StatusCheckConfiguration + description: Required status check + type: object + properties: + context: + type: string + description: The status check context name that + must be present on the commit. + integration_id: + type: integer + description: The optional integration ID that + this status check must originate from. + required: + - context + strict_required_status_checks_policy: + type: boolean + description: Whether pull requests targeting a matching + branch must be tested with the latest code. This setting + will not take effect unless at least one status check + is enabled. + required: + - required_status_checks + - strict_required_status_checks_policy + - &565 + title: non_fast_forward + description: Prevent users with push access from force pushing + to refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - non_fast_forward + - &566 + title: commit_message_pattern + description: Parameters to be used for the commit_message_pattern + rule + type: object + required: + - type + properties: + type: + type: string + enum: + - commit_message_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern + matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + - &567 + title: commit_author_email_pattern + description: Parameters to be used for the commit_author_email_pattern + rule + type: object + required: + - type + properties: + type: + type: string + enum: + - commit_author_email_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern + matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + - &568 + title: committer_email_pattern + description: Parameters to be used for the committer_email_pattern + rule + type: object + required: + - type + properties: + type: + type: string + enum: + - committer_email_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern + matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + - &569 + title: branch_name_pattern + description: Parameters to be used for the branch_name_pattern + rule + type: object + required: + - type + properties: + type: + type: string + enum: + - branch_name_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern + matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + - &570 + title: tag_name_pattern + description: Parameters to be used for the tag_name_pattern + rule + type: object + required: + - type + properties: + type: + type: string + enum: + - tag_name_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern + matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + - title: file_path_restriction + description: Prevent commits that include changes in specified + file paths from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_path_restriction + parameters: + type: object + properties: + restricted_file_paths: + type: array + description: The file paths that are restricted from + being pushed to the commit graph. + items: + type: string + required: + - restricted_file_paths + - title: max_file_path_length + description: Prevent commits that include file paths that exceed + a specified character limit from being pushed to the commit + graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_path_length + parameters: + type: object + properties: + max_file_path_length: + type: integer + description: The maximum amount of characters allowed + in file paths + minimum: 1 + maximum: 256 + required: + - max_file_path_length + - title: file_extension_restriction + description: Prevent commits that include files with specified + file extensions from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_extension_restriction + parameters: + type: object + properties: + restricted_file_extensions: + type: array + description: The file extensions that are restricted + from being pushed to the commit graph. + items: + type: string + required: + - restricted_file_extensions + - title: max_file_size + description: Prevent commits that exceed a specified file size + limit from being pushed to the commit. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_size + parameters: + type: object + properties: + max_file_size: + type: integer + description: The maximum file size allowed in megabytes. + This limit does not apply to Git Large File Storage + (Git LFS). + minimum: 1 + maximum: 100 + required: + - max_file_size + - &571 + title: workflows + description: Require all changes made to a targeted branch to + pass the specified workflows before they can be merged. + type: object + required: + - type + properties: + type: + type: string + enum: + - workflows + parameters: + type: object + properties: + do_not_enforce_on_create: + type: boolean + description: Allow repositories and branches to be created + if a check would otherwise prohibit it. + workflows: + type: array + description: Workflows that must pass for this rule + to pass. + items: + title: WorkflowFileReference + description: A workflow that must run for this rule + to pass + type: object + properties: + path: + type: string + description: The path to the workflow file + ref: + type: string + description: The ref (branch or tag) of the workflow + file to use + repository_id: + type: integer + description: The ID of the repository where the + workflow is defined + sha: + type: string + description: The commit SHA of the workflow file + to use + required: + - path + - repository_id + required: + - workflows + - &572 + title: code_scanning + description: Choose which tools must provide code scanning results + before the reference is updated. When configured, code scanning + must be enabled and have results for both the commit and the + reference being updated. + type: object + required: + - type + properties: + type: + type: string + enum: + - code_scanning + parameters: + type: object + properties: + code_scanning_tools: + type: array + description: Tools that must provide code scanning results + for this rule to pass. + items: + title: CodeScanningTool + description: A tool that must provide code scanning + results for this rule to pass. + type: object + properties: + alerts_threshold: + type: string + description: The severity level at which code + scanning results that raise alerts block a reference + update. For more information on alert severity + levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + enum: + - none + - errors + - errors_and_warnings + - all + security_alerts_threshold: + type: string + description: The severity level at which code + scanning results that raise security alerts + block a reference update. For more information + on security severity levels, see "[About code + scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + enum: + - none + - critical + - high_or_higher + - medium_or_higher + - all + tool: + type: string + description: The name of a code scanning tool + required: + - alerts_threshold + - security_alerts_threshold + - tool + required: + - code_scanning_tools + required: + - name + - enforcement + examples: + default: + value: + name: super cool ruleset + target: repository + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + org_name: + include: + - important_org + exclude: + - unimportant_org + rules: + - type: repository_delete + responses: + '201': + description: Response + content: + application/json: + schema: &105 + title: Repository ruleset + type: object + description: A set of rules to apply when specified conditions are + met. + required: + - id + - name + - source + - enforcement + properties: + id: + type: integer + description: The ID of the ruleset + name: + type: string + description: The name of the ruleset + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + source_type: + type: string + description: The type of the source of the ruleset + enum: + - Repository + - Organization + - Enterprise + source: + type: string + description: The name of the source + enforcement: *102 + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: *103 + current_user_can_bypass: + type: string + description: |- + The bypass type of the user making the API request for this ruleset. This field is only returned when + querying the repository-level endpoint. + enum: + - always + - pull_requests_only + - never + node_id: + type: string + _links: + type: object + properties: + self: + type: object + properties: + href: + type: string + description: The URL of the ruleset + html: + type: + - object + - 'null' + properties: + href: + type: string + description: The html URL of the ruleset + conditions: + anyOf: + - *98 + - &280 + title: Organization ruleset conditions + type: object + description: |- + Conditions for an organization ruleset. + The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + The push rulesets conditions object does not require the `ref_name` property. + For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. + oneOf: + - type: object + title: repository_name_and_ref_name + description: Conditions to target repositories by name and + refs by name + allOf: + - *98 + - *99 + - type: object + title: repository_id_and_ref_name + description: Conditions to target repositories by id and refs + by name + allOf: + - *98 + - title: Repository ruleset conditions for repository IDs + type: object + description: Parameters for a repository ID condition + properties: + repository_id: + type: object + properties: + repository_ids: + type: array + description: The repository IDs that the ruleset + applies to. One of these IDs must match for the + condition to pass. + items: + type: integer + required: + - repository_id + - type: object + title: repository_property_and_ref_name + description: Conditions to target repositories by property + and refs by name + allOf: + - *98 + - *101 + type: + - 'null' + - object + rules: + type: array + items: *104 + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + examples: + default: &106 + value: + id: 21 + name: super cool ruleset + target: repository + source_type: Enterprise + source: my-enterprise + enforcement: active + conditions: + organization_name: + include: + - important_organization + repository_name: + include: + - "~ALL" + rules: + - type: repository_delete + node_id: RRS_lACkVXNlcgQB + _links: + self: + href: https://api.github.com/enterprises/my-enterprise/rulesets/21 + html: + href: https://github.com/enterprise/my-enterprise/settings/policies/repositories/21 + created_at: '2024-08-15T08:43:03Z' + updated_at: '2024-09-23T16:29:47Z' + '404': *6 + '500': *80 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: rules + "/enterprises/{enterprise}/rulesets/{ruleset_id}": + get: + summary: Get an enterprise repository ruleset + description: |- + Get a repository ruleset for an enterprise. + + **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + making the API request has write access to the ruleset. + tags: + - repos + operationId: repos/get-enterprise-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset + parameters: + - *38 + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *105 + examples: + default: *106 + '404': *6 + '500': *80 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: rules + put: + summary: Update an enterprise repository ruleset + description: Update a ruleset for an enterprise. + tags: + - repos + operationId: repos/update-enterprise-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset + parameters: + - *38 + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + requestBody: + description: Request body + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the ruleset. + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + enforcement: *102 + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: *103 + conditions: *107 + rules: + description: An array of rules within the ruleset. + type: array + items: *104 + examples: + default: + value: + name: super cool ruleset + target: repository + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + org_name: + include: + - important_org + exclude: + - unimportant_org + rules: + - type: repository_delete + responses: + '200': + description: Response + content: + application/json: + schema: *105 + examples: + default: *106 + '404': *6 + '500': *80 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: rules + delete: + summary: Delete an enterprise repository ruleset + description: Delete a ruleset for an enterprise. + tags: + - repos + operationId: repos/delete-enterprise-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset + parameters: + - *38 + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '404': *6 + '500': *80 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: rules "/enterprises/{enterprise}/secret-scanning/alerts": get: summary: List secret scanning alerts for an enterprise @@ -13911,7 +15229,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *38 - - &275 + - &282 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -13922,7 +15240,7 @@ paths: enum: - open - resolved - - &276 + - &283 name: secret_type in: query description: |- @@ -13932,7 +15250,7 @@ paths: required: false schema: type: string - - &277 + - &284 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -13941,7 +15259,7 @@ paths: required: false schema: type: string - - &278 + - &285 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. @@ -13957,7 +15275,7 @@ paths: - *17 - *74 - *75 - - &279 + - &286 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -13966,7 +15284,7 @@ paths: required: false schema: type: string - - &280 + - &287 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -13975,7 +15293,7 @@ paths: schema: type: boolean default: false - - &281 + - &288 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -13991,7 +15309,7 @@ paths: application/json: schema: type: array - items: &282 + items: &289 type: object properties: number: *81 @@ -14007,14 +15325,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &579 + state: &586 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: &580 + resolution: &587 type: - string - 'null' @@ -14070,6 +15388,12 @@ paths: anyOf: - type: 'null' - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. push_protection_bypass_request_comment: type: - string @@ -14107,7 +15431,7 @@ paths: description: Whether the detected secret was found in multiple repositories in the same organization or enterprise. examples: - default: &283 + default: &290 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -14244,6 +15568,7 @@ paths: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true + push_protection_bypass_request_reviewer_comment: Example response push_protection_bypass_request_comment: Example comment push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment @@ -14331,6 +15656,7 @@ paths: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -14340,7 +15666,7 @@ paths: headers: Link: *37 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14368,7 +15694,7 @@ paths: description: Response content: application/json: - schema: &285 + schema: &292 type: object properties: total_minutes_used: @@ -14438,7 +15764,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &286 + default: &293 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -14476,7 +15802,7 @@ paths: description: Success content: application/json: - schema: &287 + schema: &294 type: object properties: total_advanced_security_committers: @@ -14539,7 +15865,7 @@ paths: required: - repositories examples: - default: &288 + default: &295 value: total_advanced_security_committers: 2 total_count: 2 @@ -14627,7 +15953,7 @@ paths: '400': *14 '403': *27 '500': *80 - '503': *96 + '503': *108 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14648,7 +15974,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-users-to-a-cost-center parameters: - *38 - - &97 + - &109 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -14690,13 +16016,13 @@ paths: message: Resources successfully added to the cost center. '400': *14 '403': *27 - '409': &143 + '409': &155 description: Conflict content: application/json: schema: *3 '500': *80 - '503': *96 + '503': *108 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14716,7 +16042,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-users-from-a-cost-center parameters: - *38 - - *97 + - *109 requestBody: required: true content: @@ -14754,7 +16080,7 @@ paths: '400': *14 '403': *27 '500': *80 - '503': *96 + '503': *108 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14782,7 +16108,7 @@ paths: description: Response content: application/json: - schema: &289 + schema: &296 type: object properties: total_gigabytes_bandwidth_used: @@ -14800,7 +16126,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &290 + default: &297 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -14832,7 +16158,7 @@ paths: description: Response content: application/json: - schema: &291 + schema: &298 type: object properties: days_left_in_billing_cycle: @@ -14850,7 +16176,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &292 + default: &299 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -14875,7 +16201,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *38 - - &132 + - &144 name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, @@ -14884,7 +16210,7 @@ paths: required: false schema: type: integer - - &133 + - &145 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. @@ -14892,7 +16218,7 @@ paths: required: false schema: type: integer - - &134 + - &146 name: day description: If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. @@ -14900,7 +16226,7 @@ paths: required: false schema: type: integer - - &135 + - &147 name: hour description: If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. @@ -14920,7 +16246,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &136 + schema: &148 type: object properties: usageItems: @@ -14973,7 +16299,7 @@ paths: - netAmount - organizationName examples: - default: &137 + default: &149 value: usageItems: - date: '2023-08-01' @@ -14990,7 +16316,7 @@ paths: '400': *14 '403': *27 '500': *80 - '503': *96 + '503': *108 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -15061,15 +16387,15 @@ paths: application/json: schema: type: array - items: *98 + items: *110 examples: - default: *99 + default: *111 '500': *80 '403': *27 '404': *6 - '422': *100 + '422': *112 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-metrics @@ -15102,7 +16428,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team parameters: - *38 - - &246 + - &258 name: team_slug description: The slug of the team name. in: path @@ -15140,9 +16466,9 @@ paths: application/json: schema: type: array - items: *101 + items: *113 examples: - default: &192 + default: &204 value: - day: '2023-10-15' total_suggestions_count: 1000 @@ -15211,7 +16537,7 @@ paths: '403': *27 '404': *6 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage @@ -15298,7 +16624,7 @@ paths: application/json: schema: type: array - items: &127 + items: &139 title: Event description: Event type: object @@ -15309,7 +16635,7 @@ paths: type: - string - 'null' - actor: &102 + actor: &114 title: Actor description: Actor type: object @@ -15350,13 +16676,13 @@ paths: - id - name - url - org: *102 + org: *114 payload: type: object properties: action: type: string - issue: &116 + issue: &128 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -15476,7 +16802,7 @@ paths: milestone: anyOf: - type: 'null' - - &429 + - &436 title: Milestone description: A collection of related issues and pull requests. @@ -15653,7 +16979,7 @@ paths: anyOf: - type: 'null' - *5 - author_association: &103 + author_association: &115 title: author_association type: string description: How the author is associated with the repository. @@ -15668,7 +16994,7 @@ paths: - OWNER examples: - OWNER - reactions: &104 + reactions: &116 title: Reaction Rollup type: object properties: @@ -15740,7 +17066,7 @@ paths: - author_association - created_at - updated_at - comment: &488 + comment: &495 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -15790,12 +17116,12 @@ paths: issue_url: type: string format: uri - author_association: *103 + author_association: *115 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *104 + reactions: *116 required: - id - node_id @@ -15892,7 +17218,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *35 '403': *27 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15982,7 +17308,7 @@ paths: _links: type: object properties: - timeline: &105 + timeline: &117 title: Link With Type description: Hypermedia Link with Type type: object @@ -15994,17 +17320,17 @@ paths: required: - href - type - user: *105 - security_advisories: *105 - current_user: *105 - current_user_public: *105 - current_user_actor: *105 - current_user_organization: *105 + user: *117 + security_advisories: *117 + current_user: *117 + current_user_public: *117 + current_user_actor: *117 + current_user_organization: *117 current_user_organizations: type: array - items: *105 - repository_discussions: *105 - repository_discussions_category: *105 + items: *117 + repository_discussions: *117 + repository_discussions_category: *117 required: - timeline - user @@ -16066,7 +17392,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *106 + - *118 - *17 - *18 responses: @@ -16076,7 +17402,7 @@ paths: application/json: schema: type: array - items: &107 + items: &119 title: Base Gist description: Base Gist type: object @@ -16171,7 +17497,7 @@ paths: - created_at - updated_at examples: - default: &108 + default: &120 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -16295,7 +17621,7 @@ paths: description: Response content: application/json: - schema: &109 + schema: &121 title: Gist Simple description: Gist Simple type: object @@ -16313,7 +17639,7 @@ paths: url: type: string format: uri - user: &636 + user: &643 title: Public User description: Public User type: object @@ -16683,7 +18009,7 @@ paths: truncated: type: boolean examples: - default: &110 + default: &122 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -16786,7 +18112,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *106 + - *118 - *17 - *18 responses: @@ -16796,9 +18122,9 @@ paths: application/json: schema: type: array - items: *107 + items: *119 examples: - default: *108 + default: *120 headers: Link: *37 '422': *15 @@ -16820,7 +18146,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *106 + - *118 - *17 - *18 responses: @@ -16830,9 +18156,9 @@ paths: application/json: schema: type: array - items: *107 + items: *119 examples: - default: *108 + default: *120 headers: Link: *37 '401': *23 @@ -16860,7 +18186,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &111 + - &123 name: gist_id description: The unique identifier of the gist. in: path @@ -16872,10 +18198,10 @@ paths: description: Response content: application/json: - schema: *109 + schema: *121 examples: - default: *110 - '403': &114 + default: *122 + '403': &126 description: Forbidden Gist content: application/json: @@ -16924,7 +18250,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *111 + - *123 requestBody: required: true content: @@ -16988,9 +18314,9 @@ paths: description: Response content: application/json: - schema: *109 + schema: *121 examples: - updateGist: *110 + updateGist: *122 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -17148,7 +18474,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *111 + - *123 responses: '204': description: Response @@ -17177,7 +18503,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *111 + - *123 - *17 - *18 responses: @@ -17187,7 +18513,7 @@ paths: application/json: schema: type: array - items: &112 + items: &124 title: Gist Comment description: A comment made to a gist. type: object @@ -17225,7 +18551,7 @@ paths: format: date-time examples: - '2011-04-18T23:23:56Z' - author_association: *103 + author_association: *115 required: - url - id @@ -17290,7 +18616,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *111 + - *123 requestBody: required: true content: @@ -17316,9 +18642,9 @@ paths: description: Response content: application/json: - schema: *112 + schema: *124 examples: - default: &113 + default: &125 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -17376,8 +18702,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *111 - - &115 + - *123 + - &127 name: comment_id description: The unique identifier of the comment. in: path @@ -17390,12 +18716,12 @@ paths: description: Response content: application/json: - schema: *112 + schema: *124 examples: - default: *113 + default: *125 '304': *35 '404': *6 - '403': *114 + '403': *126 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -17417,8 +18743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *111 - - *115 + - *123 + - *127 requestBody: required: true content: @@ -17444,9 +18770,9 @@ paths: description: Response content: application/json: - schema: *112 + schema: *124 examples: - default: *113 + default: *125 '404': *6 x-github: githubCloudOnly: false @@ -17463,8 +18789,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *111 - - *115 + - *123 + - *127 responses: '204': description: Response @@ -17487,7 +18813,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *111 + - *123 - *17 - *18 responses: @@ -17588,7 +18914,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *111 + - *123 - *17 - *18 responses: @@ -17598,7 +18924,7 @@ paths: application/json: schema: type: array - items: *109 + items: *121 examples: default: value: @@ -17663,13 +18989,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *111 + - *123 responses: '201': description: Response content: application/json: - schema: *107 + schema: *119 examples: default: value: @@ -17740,7 +19066,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *111 + - *123 responses: '204': description: Response if gist is starred @@ -17770,7 +19096,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *111 + - *123 responses: '204': description: Response @@ -17792,7 +19118,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *111 + - *123 responses: '204': description: Response @@ -17821,7 +19147,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *111 + - *123 - name: sha in: path required: true @@ -17832,9 +19158,9 @@ paths: description: Response content: application/json: - schema: *109 + schema: *121 examples: - default: *110 + default: *122 '422': *15 '404': *6 '403': *27 @@ -18203,7 +19529,7 @@ paths: - closed - all default: open - - &235 + - &247 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -18222,7 +19548,7 @@ paths: - comments default: created - *76 - - *106 + - *118 - name: collab in: query required: false @@ -18252,9 +19578,9 @@ paths: application/json: schema: type: array - items: *116 + items: *128 examples: - default: &236 + default: &248 value: - id: 1 node_id: MDU6SXNzdWUx @@ -18534,7 +19860,7 @@ paths: application/json: schema: type: array - items: *117 + items: *129 examples: default: value: @@ -18831,7 +20157,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &118 + X-CommonMarker-Version: &130 example: 0.17.4 schema: type: string @@ -18886,7 +20212,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *118 + X-CommonMarker-Version: *130 content: text/html: schema: @@ -18915,7 +20241,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: - - &121 + - &133 name: account_id description: account_id parameter in: path @@ -18927,7 +20253,7 @@ paths: description: Response content: application/json: - schema: &120 + schema: &132 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -18961,7 +20287,7 @@ paths: - 'null' id: type: integer - plan: &119 + plan: &131 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -19064,7 +20390,7 @@ paths: - 'null' updated_at: type: string - plan: *119 + plan: *131 required: - url - id @@ -19072,7 +20398,7 @@ paths: - login - marketplace_purchase examples: - default: &122 + default: &134 value: url: https://api.github.com/orgs/github type: Organization @@ -19157,9 +20483,9 @@ paths: application/json: schema: type: array - items: *119 + items: *131 examples: - default: &123 + default: &135 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -19199,14 +20525,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &124 + - &136 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &125 + - &137 name: sort description: The property to sort the results by. in: query @@ -19236,9 +20562,9 @@ paths: application/json: schema: type: array - items: *120 + items: *132 examples: - default: &126 + default: &138 value: - url: https://api.github.com/orgs/github type: Organization @@ -19312,15 +20638,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: - - *121 + - *133 responses: '200': description: Response content: application/json: - schema: *120 + schema: *132 examples: - default: *122 + default: *134 '404': description: Not Found when the account has not purchased the listing '401': *23 @@ -19352,9 +20678,9 @@ paths: application/json: schema: type: array - items: *119 + items: *131 examples: - default: *123 + default: *135 headers: Link: *37 '401': *23 @@ -19377,8 +20703,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *124 - - *125 + - *136 + - *137 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -19398,9 +20724,9 @@ paths: application/json: schema: type: array - items: *120 + items: *132 examples: - default: *126 + default: *138 headers: Link: *37 '401': *23 @@ -19650,14 +20976,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: - - &312 + - &319 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &313 + - &320 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -19674,7 +21000,7 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: default: value: @@ -19728,7 +21054,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &326 + '301': &333 description: Moved permanently content: application/json: @@ -19750,7 +21076,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &517 + - &524 name: all description: If `true`, show notifications marked as read. in: query @@ -19758,7 +21084,7 @@ paths: schema: type: boolean default: false - - &518 + - &525 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -19767,8 +21093,8 @@ paths: schema: type: boolean default: false - - *106 - - &519 + - *118 + - &526 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: @@ -19793,14 +21119,14 @@ paths: application/json: schema: type: array - items: &128 + items: &140 title: Thread description: Thread type: object properties: id: type: string - repository: &156 + repository: &168 title: Minimal Repository description: Minimal Repository type: object @@ -20139,7 +21465,7 @@ paths: type: boolean examples: - false - security_and_analysis: &264 + security_and_analysis: &277 type: - object - 'null' @@ -20294,7 +21620,7 @@ paths: - url - subscription_url examples: - default: &520 + default: &527 value: - id: '1' repository: @@ -20460,7 +21786,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &129 + - &141 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 @@ -20474,7 +21800,7 @@ paths: description: Response content: application/json: - schema: *128 + schema: *140 examples: default: value: @@ -20577,7 +21903,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *129 + - *141 responses: '205': description: Reset Content @@ -20600,7 +21926,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *129 + - *141 responses: '204': description: No content @@ -20623,13 +21949,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: - - *129 + - *141 responses: '200': description: Response content: application/json: - schema: &130 + schema: &142 title: Thread Subscription description: Thread Subscription type: object @@ -20673,7 +21999,7 @@ paths: - url - subscribed examples: - default: &131 + default: &143 value: subscribed: true ignored: false @@ -20704,7 +22030,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *129 + - *141 requestBody: required: false content: @@ -20725,9 +22051,9 @@ paths: description: Response content: application/json: - schema: *130 + schema: *142 examples: - default: *131 + default: *143 '304': *35 '403': *27 '401': *23 @@ -20750,7 +22076,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *129 + - *141 responses: '204': description: Response @@ -20847,7 +22173,7 @@ paths: type: array items: *50 examples: - default: &653 + default: &660 value: - login: github id: 1 @@ -20912,7 +22238,7 @@ paths: - 3 custom_roles: type: array - items: &193 + items: &205 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -20961,7 +22287,7 @@ paths: - created_at - updated_at examples: - default: &194 + default: &206 value: id: 8030 name: Security Engineer @@ -21007,29 +22333,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - &138 + - &150 name: org description: The organization name. The name is not case sensitive. in: path required: true schema: type: string - - *132 - - *133 - - *134 - - *135 + - *144 + - *145 + - *146 + - *147 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *136 + schema: *148 examples: - default: *137 + default: *149 '400': *14 '403': *27 '500': *80 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21055,13 +22381,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: &139 + schema: &151 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -21431,7 +22757,7 @@ paths: - updated_at - archived_at examples: - default-response: &140 + default-response: &152 value: login: github id: 1 @@ -21524,7 +22850,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *138 + - *150 requestBody: required: false content: @@ -21748,18 +23074,18 @@ paths: description: Response content: application/json: - schema: *139 + schema: *151 examples: - default: *140 + default: *152 '422': description: Validation failed content: application/json: schema: oneOf: - - *141 - - *142 - '409': *143 + - *153 + - *154 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21782,9 +23108,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *138 + - *150 responses: - '202': *144 + '202': *156 '404': *6 '403': *27 x-github: @@ -21807,15 +23133,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: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: *145 + schema: *157 examples: - default: *146 + default: *158 headers: Link: *37 x-github: @@ -21838,7 +23164,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: - - *138 + - *150 - *17 - *18 responses: @@ -21856,7 +23182,7 @@ paths: type: integer repository_cache_usages: type: array - items: &331 + items: &338 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -21914,13 +23240,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: - - *138 + - *150 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &147 + schema: &159 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -21934,7 +23260,7 @@ paths: required: - include_claim_keys examples: - default: &148 + default: &160 value: include_claim_keys: - repo @@ -21956,20 +23282,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: - - *138 + - *150 requestBody: required: true content: application/json: - schema: *147 + schema: *159 examples: - default: *148 + default: *160 responses: '201': description: Empty response content: application/json: - schema: &167 + schema: &179 title: Empty Object description: An object without any properties. type: object @@ -21999,7 +23325,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: - - *138 + - *150 responses: '200': description: Response @@ -22008,7 +23334,7 @@ paths: schema: type: object properties: - enabled_repositories: &150 + enabled_repositories: &162 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -22022,7 +23348,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *40 - selected_actions_url: *149 + selected_actions_url: *161 required: - enabled_repositories examples: @@ -22051,7 +23377,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: - - *138 + - *150 responses: '204': description: Response @@ -22062,7 +23388,7 @@ paths: schema: type: object properties: - enabled_repositories: *150 + enabled_repositories: *162 allowed_actions: *40 required: - enabled_repositories @@ -22090,7 +23416,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: - - *138 + - *150 - *17 - *18 responses: @@ -22110,7 +23436,7 @@ paths: type: array items: *55 examples: - default: &647 + default: &654 value: total_count: 1 repositories: @@ -22250,7 +23576,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: - - *138 + - *150 responses: '204': description: Response @@ -22294,8 +23620,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: - - *138 - - &151 + - *150 + - &163 name: repository_id description: The unique identifier of the repository. in: path @@ -22323,8 +23649,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: - - *138 - - *151 + - *150 + - *163 responses: '204': description: Response @@ -22347,7 +23673,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: - - *138 + - *150 responses: '200': description: Response @@ -22378,7 +23704,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: - - *138 + - *150 responses: '204': description: Response @@ -22410,13 +23736,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: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: *152 + schema: *164 examples: default: *46 x-github: @@ -22439,7 +23765,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: - - *138 + - *150 responses: '204': description: Success response @@ -22450,7 +23776,7 @@ paths: required: false content: application/json: - schema: *153 + schema: *165 examples: default: *46 x-github: @@ -22472,7 +23798,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: - - *138 + - *150 - *17 - *18 - name: visible_to_repository @@ -22497,7 +23823,7 @@ paths: type: number runner_groups: type: array - items: &154 + items: &166 type: object properties: id: @@ -22610,7 +23936,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: - - *138 + - *150 requestBody: required: true content: @@ -22680,9 +24006,9 @@ paths: description: Response content: application/json: - schema: *154 + schema: *166 examples: - default: &155 + default: &167 value: id: 2 name: octo-runner-group @@ -22717,14 +24043,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: - - *138 + - *150 - *49 responses: '200': description: Response content: application/json: - schema: *154 + schema: *166 examples: default: value: @@ -22760,7 +24086,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: - - *138 + - *150 - *49 requestBody: required: true @@ -22812,9 +24138,9 @@ paths: description: Response content: application/json: - schema: *154 + schema: *166 examples: - default: *155 + default: *167 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22833,7 +24159,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: - - *138 + - *150 - *49 responses: '204': @@ -22857,7 +24183,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: - - *138 + - *150 - *49 - *18 - *17 @@ -22876,9 +24202,9 @@ paths: type: number repositories: type: array - items: *156 + items: *168 examples: - default: &639 + default: &646 value: total_count: 1 repositories: @@ -23130,7 +24456,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: - - *138 + - *150 - *49 requestBody: required: true @@ -23175,9 +24501,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: - - *138 + - *150 - *49 - - *151 + - *163 responses: '204': description: Response @@ -23199,9 +24525,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: - - *138 + - *150 - *49 - - *151 + - *163 responses: '204': description: Response @@ -23224,7 +24550,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: - - *138 + - *150 - *49 - *17 - *18 @@ -23266,7 +24592,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: - - *138 + - *150 - *49 requestBody: required: true @@ -23311,7 +24637,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: - - *138 + - *150 - *49 - *52 responses: @@ -23335,7 +24661,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: - - *138 + - *150 - *49 - *52 responses: @@ -23367,7 +24693,7 @@ paths: in: query schema: type: string - - *138 + - *150 - *17 - *18 responses: @@ -23411,7 +24737,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: - - *138 + - *150 responses: '200': description: Response @@ -23419,9 +24745,9 @@ paths: application/json: schema: type: array - items: *157 + items: *169 examples: - default: *158 + default: *170 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23443,7 +24769,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: - - *138 + - *150 requestBody: required: true content: @@ -23486,7 +24812,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *159 + '201': *171 '404': *6 '422': *7 x-github: @@ -23516,7 +24842,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: - - *138 + - *150 responses: '201': description: Response @@ -23524,7 +24850,7 @@ paths: application/json: schema: *56 examples: - default: *160 + default: *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23552,7 +24878,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: - - *138 + - *150 responses: '201': description: Response @@ -23560,7 +24886,7 @@ paths: application/json: schema: *56 examples: - default: *161 + default: *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23582,7 +24908,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: - - *138 + - *150 - *52 responses: '200': @@ -23591,7 +24917,7 @@ paths: application/json: schema: *53 examples: - default: *162 + default: *174 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23612,7 +24938,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: - - *138 + - *150 - *52 responses: '204': @@ -23638,7 +24964,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: - - *138 + - *150 - *52 responses: '200': *58 @@ -23663,7 +24989,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: - - *138 + - *150 - *52 requestBody: required: true @@ -23712,7 +25038,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: - - *138 + - *150 - *52 requestBody: required: true @@ -23762,10 +25088,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: - - *138 + - *150 - *52 responses: - '200': *163 + '200': *175 '404': *6 x-github: githubCloudOnly: false @@ -23792,9 +25118,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: - - *138 + - *150 - *52 - - *164 + - *176 responses: '200': *58 '404': *6 @@ -23821,7 +25147,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *138 + - *150 - *17 - *18 responses: @@ -23839,7 +25165,7 @@ paths: type: integer secrets: type: array - items: &165 + items: &177 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -23914,13 +25240,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: &351 + schema: &358 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -23955,7 +25281,7 @@ paths: - key_id - key examples: - default: &352 + default: &359 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -23980,8 +25306,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *138 - - &166 + - *150 + - &178 name: secret_name description: The name of the secret. in: path @@ -23993,7 +25319,7 @@ paths: description: Response content: application/json: - schema: *165 + schema: *177 examples: default: value: @@ -24023,8 +25349,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *138 - - *166 + - *150 + - *178 requestBody: required: true content: @@ -24079,7 +25405,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -24105,8 +25431,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *138 - - *166 + - *150 + - *178 responses: '204': description: Response @@ -24132,8 +25458,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: - - *138 - - *166 + - *150 + - *178 - *18 - *17 responses: @@ -24151,9 +25477,9 @@ paths: type: integer repositories: type: array - items: *156 + items: *168 examples: - default: &170 + default: &182 value: total_count: 1 repositories: @@ -24245,8 +25571,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: - - *138 - - *166 + - *150 + - *178 requestBody: required: true content: @@ -24298,8 +25624,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: - - *138 - - *166 + - *150 + - *178 - name: repository_id in: path required: true @@ -24332,8 +25658,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: - - *138 - - *166 + - *150 + - *178 - name: repository_id in: path required: true @@ -24365,8 +25691,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *138 - - &336 + - *150 + - &343 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)." @@ -24390,7 +25716,7 @@ paths: type: integer variables: type: array - items: &168 + items: &180 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -24480,7 +25806,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *138 + - *150 requestBody: required: true content: @@ -24528,7 +25854,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -24553,8 +25879,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *138 - - &169 + - *150 + - &181 name: name description: The name of the variable. in: path @@ -24566,7 +25892,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *180 examples: default: value: @@ -24596,8 +25922,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *138 - - *169 + - *150 + - *181 requestBody: required: true content: @@ -24659,8 +25985,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *138 - - *169 + - *150 + - *181 responses: '204': description: Response @@ -24686,8 +26012,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: - - *138 - - *169 + - *150 + - *181 - *18 - *17 responses: @@ -24705,9 +26031,9 @@ paths: type: integer repositories: type: array - items: *156 + items: *168 examples: - default: *170 + default: *182 '409': description: Response when the visibility of the variable is not set to `selected` @@ -24733,8 +26059,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: - - *138 - - *169 + - *150 + - *181 requestBody: required: true content: @@ -24783,8 +26109,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: - - *138 - - *169 + - *150 + - *181 - name: repository_id in: path required: true @@ -24818,8 +26144,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: - - *138 - - *169 + - *150 + - *181 - name: repository_id in: path required: true @@ -24850,7 +26176,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *138 + - *150 responses: '200': description: Response @@ -24877,11 +26203,11 @@ paths: required: true content: application/json: - schema: *171 + schema: *183 examples: default: *61 parameters: - - *138 + - *150 responses: '200': description: Response @@ -24905,7 +26231,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *138 + - *150 responses: '204': description: Response @@ -24933,7 +26259,7 @@ paths: - *17 - *74 - *75 - - *138 + - *150 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -24973,8 +26299,10 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: - default: &365 + default: &372 value: attestations: - bundle: @@ -25092,7 +26420,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: - - *138 + - *150 - 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). @@ -25100,10 +26428,10 @@ paths: required: false schema: type: string - - *172 - - *173 - - *174 - - *175 + - *184 + - *185 + - *186 + - *187 - *17 responses: '200': @@ -25112,9 +26440,9 @@ paths: application/json: schema: type: array - items: *176 + items: *188 examples: - default: *177 + default: *189 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -25131,7 +26459,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *138 + - *150 - *17 - *18 responses: @@ -25143,7 +26471,7 @@ paths: type: array items: *4 examples: - default: &237 + default: &249 value: - login: octocat id: 1 @@ -25181,8 +26509,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: - - *138 - - &178 + - *150 + - &190 name: username description: The handle for the GitHub user account. in: path @@ -25213,8 +26541,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response @@ -25234,8 +26562,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response @@ -25260,9 +26588,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: - - *138 - - *179 - - *180 + - *150 + - *191 + - *192 - *74 - *75 - *18 @@ -25273,7 +26601,7 @@ paths: be returned. in: query required: false - schema: *181 + schema: *193 - name: sort description: The property by which to sort the results. in: query @@ -25289,7 +26617,7 @@ paths: be returned. in: query required: false - schema: &391 + schema: &398 type: string description: Severity of a code scanning alert. enum: @@ -25307,13 +26635,13 @@ paths: application/json: schema: type: array - items: *182 + items: *194 examples: - default: *183 + default: *195 headers: Link: *37 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25335,7 +26663,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: - - *138 + - *150 - name: target_type in: query description: The target type of the code security configuration @@ -25363,7 +26691,7 @@ paths: application/json: schema: type: array - items: &184 + items: &196 type: object description: A code security configuration properties: @@ -25625,7 +26953,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *138 + - *150 requestBody: required: true content: @@ -25698,7 +27026,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &188 + code_scanning_default_setup_options: &200 type: - object - 'null' @@ -25817,9 +27145,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *184 + schema: *196 examples: - default: &186 + default: &198 value: id: 1325 target_type: organization @@ -25868,7 +27196,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *138 + - *150 responses: '200': description: Response @@ -25888,7 +27216,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *184 + configuration: *196 examples: default: value: @@ -25978,7 +27306,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *138 + - *150 requestBody: required: true content: @@ -26001,11 +27329,11 @@ paths: - 32 - 91 responses: - '204': *185 + '204': *197 '400': *14 '403': *27 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26027,8 +27355,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *138 - - &187 + - *150 + - &199 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -26040,9 +27368,9 @@ paths: description: Response content: application/json: - schema: *184 + schema: *196 examples: - default: *186 + default: *198 '304': *35 '403': *27 '404': *6 @@ -26066,8 +27394,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *138 - - *187 + - *150 + - *199 requestBody: required: true content: @@ -26133,7 +27461,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *188 + code_scanning_default_setup_options: *200 secret_scanning: type: string description: The enablement status of secret scanning @@ -26220,7 +27548,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *184 + schema: *196 examples: default: value: @@ -26274,14 +27602,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *138 - - *187 + - *150 + - *199 responses: - '204': *185 + '204': *197 '400': *14 '403': *27 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26305,8 +27633,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *138 - - *187 + - *150 + - *199 requestBody: required: true content: @@ -26345,7 +27673,7 @@ paths: - 32 - 91 responses: - '202': *144 + '202': *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26369,8 +27697,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: - - *138 - - *187 + - *150 + - *199 requestBody: required: true content: @@ -26410,12 +27738,12 @@ paths: - none - private_and_internal - public - configuration: *184 + configuration: *196 examples: default: value: default_for_new_repos: all - configuration: *186 + configuration: *198 '403': *27 '404': *6 x-github: @@ -26439,8 +27767,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: - - *138 - - *187 + - *150 + - *199 - 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)." @@ -26583,7 +27911,7 @@ paths: parameters: - *17 - *18 - - *138 + - *150 responses: '200': description: Response @@ -26599,7 +27927,7 @@ paths: type: integer codespaces: type: array - items: &238 + items: &250 type: object title: Codespace description: A codespace. @@ -26630,11 +27958,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *156 + repository: *168 machine: anyOf: - type: 'null' - - &417 + - &424 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -26921,7 +28249,7 @@ paths: - pulls_url - recent_folders examples: - default: &239 + default: &251 value: total_count: 3 codespaces: @@ -27353,7 +28681,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *138 + - *150 deprecated: true requestBody: required: true @@ -27420,7 +28748,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: - - *138 + - *150 deprecated: true requestBody: required: true @@ -27475,7 +28803,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *138 + - *150 requestBody: required: true content: @@ -27527,7 +28855,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *138 + - *150 - *17 - *18 responses: @@ -27545,7 +28873,7 @@ paths: type: integer secrets: type: array - items: &189 + items: &201 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -27586,7 +28914,7 @@ paths: - updated_at - visibility examples: - default: &418 + default: &425 value: total_count: 2 secrets: @@ -27618,13 +28946,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: &419 + schema: &426 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -27659,7 +28987,7 @@ paths: - key_id - key examples: - default: &420 + default: &427 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -27682,16 +29010,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *138 - - *166 + - *150 + - *178 responses: '200': description: Response content: application/json: - schema: *189 + schema: *201 examples: - default: &422 + default: &429 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -27718,8 +29046,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: - - *138 - - *166 + - *150 + - *178 requestBody: required: true content: @@ -27774,7 +29102,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -27800,8 +29128,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *138 - - *166 + - *150 + - *178 responses: '204': description: Response @@ -27826,8 +29154,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: - - *138 - - *166 + - *150 + - *178 - *18 - *17 responses: @@ -27845,9 +29173,9 @@ paths: type: integer repositories: type: array - items: *156 + items: *168 examples: - default: *170 + default: *182 '404': *6 x-github: githubCloudOnly: false @@ -27869,8 +29197,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: - - *138 - - *166 + - *150 + - *178 requestBody: required: true content: @@ -27920,8 +29248,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: - - *138 - - *166 + - *150 + - *178 - name: repository_id in: path required: true @@ -27954,8 +29282,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: - - *138 - - *166 + - *150 + - *178 - name: repository_id in: path required: true @@ -27994,7 +29322,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: - - *138 + - *150 responses: '200': description: OK @@ -28137,7 +29465,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: - - *138 + - *150 - *18 - name: per_page description: The number of results per page (max 100). For more information, @@ -28160,9 +29488,9 @@ paths: currently being billed. seats: type: array - items: *190 + items: *202 examples: - default: *191 + default: *203 headers: Link: *37 '500': *80 @@ -28198,7 +29526,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: - - *138 + - *150 requestBody: content: application/json: @@ -28276,7 +29604,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: - - *138 + - *150 requestBody: content: application/json: @@ -28356,7 +29684,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: - - *138 + - *150 requestBody: content: application/json: @@ -28433,7 +29761,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: - - *138 + - *150 requestBody: content: application/json: @@ -28514,7 +29842,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *138 + - *150 - 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`). @@ -28546,13 +29874,13 @@ paths: application/json: schema: type: array - items: *98 + items: *110 examples: - default: *99 + default: *111 '500': *80 '403': *27 '404': *6 - '422': *100 + '422': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28583,7 +29911,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: - - *138 + - *150 - 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`). @@ -28615,9 +29943,9 @@ paths: application/json: schema: type: array - items: *101 + items: *113 examples: - default: *192 + default: *204 '500': *80 '401': *23 '403': *27 @@ -28643,7 +29971,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: - - *138 + - *150 - *17 - name: page description: Page token @@ -28802,7 +30130,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: - - *138 + - *150 - name: credential_id in: path required: true @@ -28833,7 +30161,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: - - *138 + - *150 responses: '200': description: Response - list of custom role names @@ -28849,7 +30177,7 @@ paths: - 3 custom_roles: type: array - items: *193 + items: *205 examples: default: value: @@ -28936,12 +30264,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *138 + - *150 requestBody: required: true content: application/json: - schema: &196 + schema: &208 type: object properties: name: @@ -28983,9 +30311,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *205 examples: - default: *194 + default: *206 '422': *15 '404': *6 x-github: @@ -29009,8 +30337,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *138 - - &195 + - *150 + - &207 name: role_id description: The unique identifier of the role. in: path @@ -29022,9 +30350,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *205 examples: - default: *194 + default: *206 '404': *6 x-github: githubCloudOnly: true @@ -29046,13 +30374,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *138 - - *195 + - *150 + - *207 requestBody: required: true content: application/json: - schema: &197 + schema: &209 type: object properties: name: @@ -29091,9 +30419,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *205 examples: - default: *194 + default: *206 '422': *15 '404': *6 x-github: @@ -29117,8 +30445,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *138 - - *195 + - *150 + - *207 responses: '204': description: Response @@ -29146,12 +30474,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: - - *138 + - *150 requestBody: required: true content: application/json: - schema: *196 + schema: *208 examples: default: value: @@ -29165,9 +30493,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *205 examples: - default: *194 + default: *206 '422': *15 '404': *6 x-github: @@ -29197,16 +30525,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: - - *138 - - *195 + - *150 + - *207 responses: '200': description: Response content: application/json: - schema: *193 + schema: *205 examples: - default: *194 + default: *206 '404': *6 x-github: githubCloudOnly: true @@ -29234,13 +30562,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: - - *138 - - *195 + - *150 + - *207 requestBody: required: true content: application/json: - schema: *197 + schema: *209 examples: default: value: @@ -29255,9 +30583,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *205 examples: - default: *194 + default: *206 '422': *15 '404': *6 x-github: @@ -29287,8 +30615,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: - - *138 - - *195 + - *150 + - *207 responses: '204': description: Response @@ -29316,18 +30644,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *138 - - *198 - - *199 - - *200 - - *201 - - *202 - - *203 + - *150 + - *210 + - *211 + - *212 + - *213 + - *214 + - *215 - *76 - *74 - *75 - - *204 - - *205 + - *216 + - *217 - *17 responses: '200': @@ -29336,9 +30664,9 @@ paths: application/json: schema: type: array - items: *206 + items: *218 examples: - default: *207 + default: *219 '304': *35 '400': *14 '403': *27 @@ -29364,7 +30692,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *138 + - *150 - *17 - *18 responses: @@ -29382,7 +30710,7 @@ paths: type: integer secrets: type: array - items: &208 + items: &220 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -29455,13 +30783,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: &445 + schema: &452 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -29480,7 +30808,7 @@ paths: - key_id - key examples: - default: &446 + default: &453 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -29503,14 +30831,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *138 - - *166 + - *150 + - *178 responses: '200': description: Response content: application/json: - schema: *208 + schema: *220 examples: default: value: @@ -29538,8 +30866,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *138 - - *166 + - *150 + - *178 requestBody: required: true content: @@ -29594,7 +30922,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -29618,8 +30946,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *138 - - *166 + - *150 + - *178 responses: '204': description: Response @@ -29643,8 +30971,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: - - *138 - - *166 + - *150 + - *178 - *18 - *17 responses: @@ -29662,9 +30990,9 @@ paths: type: integer repositories: type: array - items: *156 + items: *168 examples: - default: *170 + default: *182 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29685,8 +31013,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: - - *138 - - *166 + - *150 + - *178 requestBody: required: true content: @@ -29736,8 +31064,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: - - *138 - - *166 + - *150 + - *178 - name: repository_id in: path required: true @@ -29768,8 +31096,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: - - *138 - - *166 + - *150 + - *178 - name: repository_id in: path required: true @@ -29799,7 +31127,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: - - *138 + - *150 responses: '200': description: Response @@ -29807,7 +31135,7 @@ paths: application/json: schema: type: array - items: &249 + items: &261 title: Package description: A software package type: object @@ -29860,7 +31188,7 @@ paths: repository: anyOf: - type: 'null' - - *156 + - *168 created_at: type: string format: date-time @@ -29878,7 +31206,7 @@ paths: - created_at - updated_at examples: - default: &250 + default: &262 value: - id: 197 name: hello_docker @@ -29956,7 +31284,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *138 + - *150 - *17 - *18 responses: @@ -29966,7 +31294,7 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: 200-response: value: @@ -30036,7 +31364,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *138 + - *150 - name: group_id description: The unique identifier of the group. in: path @@ -30062,7 +31390,7 @@ paths: description: Response content: application/json: - schema: &307 + schema: &314 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -30152,7 +31480,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &308 + default: &315 value: group_id: '123' group_name: Octocat admins @@ -30190,7 +31518,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: - - *138 + - *150 - *17 - name: page description: Page token @@ -30207,7 +31535,7 @@ paths: description: Response content: application/json: - schema: &305 + schema: &312 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -30247,7 +31575,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &306 + default: &313 value: groups: - group_id: '123' @@ -30281,7 +31609,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *138 + - *150 - *17 - *18 responses: @@ -30291,7 +31619,7 @@ paths: application/json: schema: type: array - items: &231 + items: &243 title: Organization Invitation description: Organization Invitation type: object @@ -30345,7 +31673,7 @@ paths: - invitation_teams_url - node_id examples: - default: &232 + default: &244 value: - id: 1 login: monalisa @@ -30404,7 +31732,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: - - *138 + - *150 responses: '200': description: Response @@ -30412,7 +31740,7 @@ paths: application/json: schema: type: array - items: &265 + items: &278 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -30426,7 +31754,7 @@ paths: - name - description examples: - default: &266 + default: &279 value: - name: add_assignee description: Assign or remove a user @@ -30457,7 +31785,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *138 + - *150 - *17 - *18 responses: @@ -30467,7 +31795,7 @@ paths: application/json: schema: type: array - items: &209 + items: &221 title: Org Hook description: Org Hook type: object @@ -30588,7 +31916,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *138 + - *150 requestBody: required: true content: @@ -30650,9 +31978,9 @@ paths: description: Response content: application/json: - schema: *209 + schema: *221 examples: - default: &210 + default: &222 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -30696,8 +32024,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *138 - - &211 + - *150 + - &223 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. @@ -30710,9 +32038,9 @@ paths: description: Response content: application/json: - schema: *209 + schema: *221 examples: - default: *210 + default: *222 '404': *6 x-github: githubCloudOnly: false @@ -30733,8 +32061,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *138 - - *211 + - *150 + - *223 requestBody: required: false content: @@ -30780,7 +32108,7 @@ paths: description: Response content: application/json: - schema: *209 + schema: *221 examples: default: value: @@ -30819,8 +32147,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *138 - - *211 + - *150 + - *223 responses: '204': description: Response @@ -30845,8 +32173,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: - - *138 - - *211 + - *150 + - *223 responses: '200': description: Response @@ -30874,8 +32202,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: - - *138 - - *211 + - *150 + - *223 requestBody: required: false content: @@ -30923,10 +32251,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *138 - - *211 + - *150 + - *223 - *17 - - *212 + - *224 responses: '200': description: Response @@ -30934,9 +32262,9 @@ paths: application/json: schema: type: array - items: *213 + items: *225 examples: - default: *214 + default: *226 '400': *14 '422': *15 x-github: @@ -30959,17 +32287,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: - - *138 - - *211 + - *150 + - *223 - *16 responses: '200': description: Response content: application/json: - schema: *215 + schema: *227 examples: - default: *216 + default: *228 '400': *14 '422': *15 x-github: @@ -30992,11 +32320,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: - - *138 - - *211 + - *150 + - *223 - *16 responses: - '202': *144 + '202': *156 '400': *14 '422': *15 x-github: @@ -31019,8 +32347,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *138 - - *211 + - *150 + - *223 responses: '204': description: Response @@ -31042,8 +32370,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *138 - - &221 + - *150 + - &233 name: actor_type in: path description: The type of the actor @@ -31056,14 +32384,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &222 + - &234 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &217 + - &229 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -31071,7 +32399,7 @@ paths: required: true schema: type: string - - &218 + - &230 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -31165,13 +32493,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - - *138 - - *217 - - *218 + - *150 + - *229 + - *230 - *18 - *17 - *76 - - &227 + - &239 name: sort description: The property to sort the results by. in: query @@ -31250,15 +32578,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - - *138 - - *217 - - *218 + - *150 + - *229 + - *230 responses: '200': description: Response content: application/json: - schema: &219 + schema: &231 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -31274,7 +32602,7 @@ paths: type: integer format: int64 examples: - default: &220 + default: &232 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -31294,24 +32622,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *138 - - &223 + - *150 + - &235 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *217 - - *218 + - *229 + - *230 responses: '200': description: Response content: application/json: - schema: *219 + schema: *231 examples: - default: *220 + default: *232 x-github: enabledForGitHubApps: true category: orgs @@ -31329,19 +32657,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *138 - - *217 - - *218 - - *221 - - *222 + - *150 + - *229 + - *230 + - *233 + - *234 responses: '200': description: Response content: application/json: - schema: *219 + schema: *231 examples: - default: *220 + default: *232 x-github: enabledForGitHubApps: true category: orgs @@ -31358,10 +32686,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - - *138 - - *217 - - *218 - - &224 + - *150 + - *229 + - *230 + - &236 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -31374,7 +32702,7 @@ paths: description: Response content: application/json: - schema: &225 + schema: &237 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -31390,7 +32718,7 @@ paths: type: integer format: int64 examples: - default: &226 + default: &238 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -31426,19 +32754,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - - *138 - - *223 - - *217 - - *218 - - *224 + - *150 + - *235 + - *229 + - *230 + - *236 responses: '200': description: Response content: application/json: - schema: *225 + schema: *237 examples: - default: *226 + default: *238 x-github: enabledForGitHubApps: true category: orgs @@ -31455,20 +32783,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *138 - - *221 - - *222 - - *217 - - *218 - - *224 + - *150 + - *233 + - *234 + - *229 + - *230 + - *236 responses: '200': description: Response content: application/json: - schema: *225 + schema: *237 examples: - default: *226 + default: *238 x-github: enabledForGitHubApps: true category: orgs @@ -31485,14 +32813,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - - *138 - - *223 - - *217 - - *218 + - *150 + - *235 + - *229 + - *230 - *18 - *17 - *76 - - *227 + - *239 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -31568,7 +32896,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: - - *138 + - *150 responses: '200': description: Response @@ -31576,7 +32904,7 @@ paths: application/json: schema: *20 examples: - default: &484 + default: &491 value: id: 1 account: @@ -31645,7 +32973,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *138 + - *150 - *17 - *18 responses: @@ -31734,7 +33062,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *138 + - *150 responses: '200': description: Response @@ -31742,12 +33070,12 @@ paths: application/json: schema: anyOf: - - &229 + - &241 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &228 + limit: &240 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -31775,7 +33103,7 @@ paths: properties: {} additionalProperties: false examples: - default: &230 + default: &242 value: limit: collaborators_only origin: organization @@ -31799,18 +33127,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *138 + - *150 requestBody: required: true content: application/json: - schema: &485 + schema: &492 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *228 + limit: *240 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -31835,9 +33163,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *241 examples: - default: *230 + default: *242 '422': *15 x-github: githubCloudOnly: false @@ -31855,7 +33183,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *138 + - *150 responses: '204': description: Response @@ -31881,7 +33209,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *138 + - *150 - *17 - *18 - name: role @@ -31915,9 +33243,9 @@ paths: application/json: schema: type: array - items: *231 + items: *243 examples: - default: *232 + default: *244 headers: Link: *37 '404': *6 @@ -31941,7 +33269,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *138 + - *150 requestBody: required: false content: @@ -31995,7 +33323,7 @@ paths: description: Response content: application/json: - schema: *231 + schema: *243 examples: default: value: @@ -32051,8 +33379,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *138 - - &233 + - *150 + - &245 name: invitation_id description: The unique identifier of the invitation. in: path @@ -32085,8 +33413,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *138 - - *233 + - *150 + - *245 - *17 - *18 responses: @@ -32096,9 +33424,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - default: &248 + default: &260 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -32143,7 +33471,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: - - *138 + - *150 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -32173,7 +33501,7 @@ paths: - closed - all default: open - - *235 + - *247 - name: sort description: What to sort results by. in: query @@ -32186,7 +33514,7 @@ paths: - comments default: created - *76 - - *106 + - *118 - *17 - *18 responses: @@ -32196,9 +33524,9 @@ paths: application/json: schema: type: array - items: *116 + items: *128 examples: - default: *236 + default: *248 headers: Link: *37 '404': *6 @@ -32220,7 +33548,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *138 + - *150 - 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) @@ -32256,7 +33584,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 '422': *15 @@ -32276,8 +33604,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response if requester is an organization member and user is @@ -32308,8 +33636,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response @@ -32335,8 +33663,8 @@ paths: parameters: - *17 - *18 - - *138 - - *178 + - *150 + - *190 responses: '200': description: Response @@ -32352,9 +33680,9 @@ paths: type: integer codespaces: type: array - items: *238 + items: *250 examples: - default: *239 + default: *251 '304': *35 '500': *80 '401': *23 @@ -32379,9 +33707,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *138 - - *178 - - &240 + - *150 + - *190 + - &252 name: codespace_name in: path required: true @@ -32389,7 +33717,7 @@ paths: schema: type: string responses: - '202': *144 + '202': *156 '304': *35 '500': *80 '401': *23 @@ -32414,17 +33742,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: - - *138 - - *178 - - *240 + - *150 + - *190 + - *252 responses: '200': description: Response content: application/json: - schema: *238 + schema: *250 examples: - default: &416 + default: &423 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -32597,14 +33925,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: - - *138 - - *178 + - *150 + - *190 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *190 + schema: *202 examples: default: value: @@ -32672,14 +34000,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *138 - - *178 + - *150 + - *190 responses: '200': description: Response content: application/json: - schema: &241 + schema: &253 title: Org Membership description: Org Membership type: object @@ -32732,7 +34060,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &242 + response-if-user-has-an-active-admin-membership-with-organization: &254 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -32800,8 +34128,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *138 - - *178 + - *150 + - *190 requestBody: required: false content: @@ -32829,9 +34157,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *253 examples: - response-if-user-already-had-membership-with-organization: *242 + response-if-user-already-had-membership-with-organization: *254 '422': *15 '403': *27 x-github: @@ -32852,8 +34180,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response @@ -32878,7 +34206,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *138 + - *150 - *17 - *18 - name: exclude @@ -32900,7 +34228,7 @@ paths: application/json: schema: type: array - items: &243 + items: &255 title: Migration description: A migration. type: object @@ -33157,7 +34485,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *138 + - *150 requestBody: required: true content: @@ -33238,7 +34566,7 @@ paths: description: Response content: application/json: - schema: *243 + schema: *255 examples: default: value: @@ -33416,8 +34744,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *138 - - &244 + - *150 + - &256 name: migration_id description: The unique identifier of the migration. in: path @@ -33445,7 +34773,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *243 + schema: *255 examples: default: value: @@ -33614,8 +34942,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *138 - - *244 + - *150 + - *256 responses: '302': description: Response @@ -33636,8 +34964,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *138 - - *244 + - *150 + - *256 responses: '204': description: Response @@ -33660,9 +34988,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *138 - - *244 - - &652 + - *150 + - *256 + - &659 name: repo_name description: repo_name parameter in: path @@ -33689,8 +35017,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *138 - - *244 + - *150 + - *256 - *17 - *18 responses: @@ -33700,9 +35028,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: &255 + default: &267 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -33841,7 +35169,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: - - *138 + - *150 responses: '200': description: Response @@ -33895,7 +35223,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: - - *138 + - *150 responses: '200': description: Response - list of organization roles @@ -33911,7 +35239,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &245 + items: &257 title: Organization Role description: Organization roles type: object @@ -34073,7 +35401,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *138 + - *150 requestBody: required: true content: @@ -34120,7 +35448,7 @@ paths: description: Response content: application/json: - schema: *245 + schema: *257 examples: default: value: @@ -34149,7 +35477,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *15 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -34171,8 +35499,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: - - *138 - - *246 + - *150 + - *258 responses: '204': description: Response @@ -34197,9 +35525,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: - - *138 - - *246 - - *195 + - *150 + - *258 + - *207 responses: '204': description: Response @@ -34228,9 +35556,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: - - *138 - - *246 - - *195 + - *150 + - *258 + - *207 responses: '204': description: Response @@ -34255,8 +35583,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: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response @@ -34281,9 +35609,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: - - *138 - - *178 - - *195 + - *150 + - *190 + - *207 responses: '204': description: Response @@ -34313,9 +35641,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: - - *138 - - *178 - - *195 + - *150 + - *190 + - *207 responses: '204': description: Response @@ -34343,14 +35671,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *138 - - *195 + - *150 + - *207 responses: '200': description: Response content: application/json: - schema: *245 + schema: *257 examples: default: value: @@ -34407,8 +35735,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *138 - - *195 + - *150 + - *207 requestBody: required: true content: @@ -34447,7 +35775,7 @@ paths: description: Response content: application/json: - schema: *245 + schema: *257 examples: default: value: @@ -34475,7 +35803,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *15 - '409': *143 + '409': *155 '404': *6 x-github: githubCloudOnly: true @@ -34500,8 +35828,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *138 - - *195 + - *150 + - *207 responses: '204': description: Response @@ -34526,8 +35854,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: - - *138 - - *195 + - *150 + - *207 - *17 - *18 responses: @@ -34606,7 +35934,7 @@ paths: parent: anyOf: - type: 'null' - - *247 + - *259 required: - id - node_id @@ -34620,7 +35948,7 @@ paths: - slug - parent examples: - default: *248 + default: *260 headers: Link: *37 '404': @@ -34649,8 +35977,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: - - *138 - - *195 + - *150 + - *207 - *17 - *18 responses: @@ -34679,7 +36007,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *247 + items: *259 name: type: - string @@ -34796,7 +36124,7 @@ paths: - type - url examples: - default: *237 + default: *249 headers: Link: *37 '404': @@ -34820,7 +36148,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: - - *138 + - *150 - 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) @@ -34844,7 +36172,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 x-github: @@ -34869,8 +36197,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: - - *138 - - *178 + - *150 + - *190 requestBody: required: false content: @@ -34927,8 +36255,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: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response @@ -34985,8 +36313,8 @@ paths: - docker - nuget - container - - *138 - - &654 + - *150 + - &661 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -35022,12 +36350,12 @@ paths: application/json: schema: type: array - items: *249 + items: *261 examples: - default: *250 + default: *262 '403': *27 '401': *23 - '400': &656 + '400': &663 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -35049,7 +36377,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &251 + - &263 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 @@ -35067,20 +36395,20 @@ paths: - docker - nuget - container - - &252 + - &264 name: package_name description: The name of the package. in: path required: true schema: type: string - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: *249 + schema: *261 examples: default: value: @@ -35132,9 +36460,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *251 - - *252 - - *138 + - *263 + - *264 + - *150 responses: '204': description: Response @@ -35166,9 +36494,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *251 - - *252 - - *138 + - *263 + - *264 + - *150 - name: token description: package token schema: @@ -35200,9 +36528,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: - - *251 - - *252 - - *138 + - *263 + - *264 + - *150 - *18 - *17 - name: state @@ -35222,7 +36550,7 @@ paths: application/json: schema: type: array - items: &253 + items: &265 title: Package Version description: A version of a software package type: object @@ -35357,10 +36685,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: - - *251 - - *252 - - *138 - - &254 + - *263 + - *264 + - *150 + - &266 name: package_version_id description: Unique identifier of the package version. in: path @@ -35372,7 +36700,7 @@ paths: description: Response content: application/json: - schema: *253 + schema: *265 examples: default: value: @@ -35408,10 +36736,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *251 - - *252 - - *138 - - *254 + - *263 + - *264 + - *150 + - *266 responses: '204': description: Response @@ -35443,10 +36771,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *251 - - *252 - - *138 - - *254 + - *263 + - *264 + - *150 + - *266 responses: '204': description: Response @@ -35473,10 +36801,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: - - *138 + - *150 - *17 - *18 - - &256 + - &268 name: sort description: The property by which to sort the results. in: query @@ -35487,7 +36815,7 @@ paths: - created_at default: created_at - *76 - - &257 + - &269 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -35499,7 +36827,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &258 + - &270 name: repository description: The name of the repository to use to filter the results. in: query @@ -35508,7 +36836,7 @@ paths: type: string examples: - Hello-World - - &259 + - &271 name: permission description: The permission to use to filter the results. in: query @@ -35517,7 +36845,7 @@ paths: type: string examples: - issues_read - - &260 + - &272 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) @@ -35527,7 +36855,7 @@ paths: schema: type: string format: date-time - - &261 + - &273 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) @@ -35693,7 +37021,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: - - *138 + - *150 requestBody: required: true content: @@ -35739,7 +37067,7 @@ paths: '422': *15 '404': *6 '403': *27 - '202': *144 + '202': *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35760,7 +37088,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: - - *138 + - *150 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -35801,7 +37129,7 @@ paths: '422': *15 '404': *6 '403': *27 - '204': *185 + '204': *197 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35822,7 +37150,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: - - *138 + - *150 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -35842,9 +37170,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 x-github: @@ -35867,16 +37195,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: - - *138 + - *150 - *17 - *18 - - *256 + - *268 - *76 - - *257 - - *258 - - *259 - - *260 - - *261 + - *269 + - *270 + - *271 + - *272 + - *273 responses: '500': *80 '422': *15 @@ -36027,7 +37355,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: - - *138 + - *150 requestBody: required: true content: @@ -36064,7 +37392,7 @@ paths: responses: '500': *80 '404': *6 - '202': *144 + '202': *156 '403': *27 '422': *15 x-github: @@ -36087,7 +37415,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: - - *138 + - *150 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -36117,7 +37445,7 @@ paths: responses: '500': *80 '404': *6 - '204': *185 + '204': *197 '403': *27 '422': *15 x-github: @@ -36139,7 +37467,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: - - *138 + - *150 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -36158,9 +37486,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 x-github: @@ -36182,7 +37510,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-organization-projects parameters: - - *138 + - *150 - name: state description: Indicates the state of the projects to return. in: query @@ -36203,7 +37531,7 @@ paths: application/json: schema: type: array - items: &262 + items: &274 title: Project description: Projects are a way to organize columns and cards of work. @@ -36356,7 +37684,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-an-organization-project parameters: - - *138 + - *150 requestBody: required: true content: @@ -36382,7 +37710,7 @@ paths: description: Response content: application/json: - schema: *262 + schema: *274 examples: default: value: @@ -36420,7 +37748,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': &323 + '410': &330 description: Gone content: application/json: @@ -36444,7 +37772,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: - - *138 + - *150 responses: '200': description: Response @@ -36477,7 +37805,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: - - *138 + - *150 requestBody: required: true content: @@ -36541,7 +37869,7 @@ 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: - - *138 + - *150 - *94 responses: '200': @@ -36573,57 +37901,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *138 + - *150 - *94 requestBody: required: true content: application/json: - schema: - type: object - properties: - value_type: - type: string - enum: - - string - - single_select - - multi_select - - true_false - description: The type of the value for the property - examples: - - single_select - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - description: Default value of the property - type: - - 'null' - - string - - array - description: - type: - - string - - 'null' - description: Short description of the property - allowed_values: - type: - - array - - 'null' - items: - type: string - maxLength: 75 - maxItems: 200 - description: |- - An ordered list of the allowed values of the property. - The property can have up to 200 allowed values. - required: - - value_type + schema: *275 examples: default: value: @@ -36664,10 +37948,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: - - *138 + - *150 - *94 responses: - '204': *185 + '204': *197 '403': *27 '404': *6 x-github: @@ -36688,7 +37972,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: - - *138 + - *150 - *17 - *18 - name: repository_query @@ -36729,7 +38013,7 @@ paths: - octocat/Hello-World properties: type: array - items: &263 + items: &276 title: Custom Property Value description: Custom property name and associated value type: object @@ -36799,7 +38083,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: - - *138 + - *150 requestBody: required: true content: @@ -36819,7 +38103,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *263 + items: *276 required: - repository_names - properties @@ -36860,7 +38144,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *138 + - *150 - *17 - *18 responses: @@ -36872,7 +38156,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 x-github: @@ -36891,8 +38175,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: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response if user is a public member @@ -36916,8 +38200,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: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response @@ -36938,8 +38222,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: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response @@ -36963,7 +38247,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *138 + - *150 - 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 @@ -37010,9 +38294,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 x-github: @@ -37033,7 +38317,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *138 + - *150 requestBody: required: true content: @@ -37216,7 +38500,7 @@ paths: description: Response content: application/json: - schema: &325 + schema: &332 title: Full Repository description: Full Repository type: object @@ -37662,7 +38946,7 @@ paths: license: anyOf: - type: 'null' - - *117 + - *129 organization: anyOf: - type: 'null' @@ -37681,7 +38965,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &435 + code_of_conduct: &442 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -37711,7 +38995,7 @@ paths: - key - name - html_url - security_and_analysis: *264 + security_and_analysis: *277 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -37795,7 +39079,7 @@ paths: - network_count - subscribers_count examples: - default: &327 + default: &334 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -38313,7 +39597,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: - - *138 + - *150 responses: '200': description: Response @@ -38321,9 +39605,9 @@ paths: application/json: schema: type: array - items: *265 + items: *278 examples: - default: *266 + default: *279 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -38345,10 +39629,10 @@ paths: category: orgs subcategory: rules parameters: - - *138 + - *150 - *17 - *18 - - &566 + - &573 name: targets description: | A comma-separated list of rule targets to filter by. @@ -38367,935 +39651,7 @@ paths: application/json: schema: type: array - items: &273 - title: Repository ruleset - type: object - description: A set of rules to apply when specified conditions are - met. - required: - - id - - name - - source - - enforcement - properties: - id: - type: integer - description: The ID of the ruleset - name: - type: string - description: The name of the ruleset - target: - type: string - description: The target of the ruleset - enum: - - branch - - tag - - push - source_type: - type: string - description: The type of the source of the ruleset - enum: - - Repository - - Organization - source: - type: string - description: The name of the source - enforcement: &269 - type: string - description: The enforcement level of the ruleset. `evaluate` - allows admins to test rules before enforcing them. Admins - can view insights on the Rule Insights page. - enum: - - disabled - - active - - evaluate - bypass_actors: - type: array - description: The actors that can bypass the rules in this ruleset - items: &270 - title: Repository Ruleset Bypass Actor - type: object - description: An actor that can bypass rules in a ruleset - required: - - actor_type - properties: - actor_id: - type: - - integer - - 'null' - description: The ID of the actor that can bypass a ruleset. - If `actor_type` is `OrganizationAdmin`, this should - be `1`. If `actor_type` is `DeployKey`, this should - be null. If `actor_type` is `EnterpriseOwner`, `actor_id` - is ignored. `OrganizationAdmin` and `EnterpriseOwner` - are not applicable for personal repositories. - actor_type: - type: string - enum: - - Integration - - OrganizationAdmin - - RepositoryRole - - Team - - DeployKey - - EnterpriseOwner - description: The type of actor that can bypass a ruleset - bypass_mode: - type: string - description: When the specified actor can bypass the ruleset. - `pull_request` means that an actor can only bypass rules - on pull requests. `pull_request` is not applicable for - the `DeployKey` actor type. Also, `pull_request` is - only applicable to branch rulesets. - enum: - - always - - pull_request - default: always - current_user_can_bypass: - type: string - description: |- - The bypass type of the user making the API request for this ruleset. This field is only returned when - querying the repository-level endpoint. - enum: - - always - - pull_requests_only - - never - node_id: - type: string - _links: - type: object - properties: - self: - type: object - properties: - href: - type: string - description: The URL of the ruleset - html: - type: - - object - - 'null' - properties: - href: - type: string - description: The html URL of the ruleset - conditions: - anyOf: - - &267 - title: Repository ruleset conditions for ref names - type: object - description: Parameters for a repository ruleset ref name - condition - properties: - ref_name: - type: object - properties: - include: - type: array - description: Array of ref names or patterns to include. - One of these patterns must match for the condition - to pass. Also accepts `~DEFAULT_BRANCH` to include - the default branch or `~ALL` to include all branches. - items: - type: string - exclude: - type: array - description: Array of ref names or patterns to exclude. - The condition will not pass if any of these patterns - match. - items: - type: string - - &271 - title: Organization ruleset conditions - type: object - description: |- - Conditions for an organization ruleset. - The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. - The push rulesets conditions object does not require the `ref_name` property. - oneOf: - - type: object - title: repository_name_and_ref_name - description: Conditions to target repositories by name and - refs by name - allOf: - - *267 - - title: Repository ruleset conditions for repository names - type: object - description: Parameters for a repository name condition - properties: - repository_name: - type: object - properties: - include: - type: array - description: Array of repository names or patterns - to include. One of these patterns must match - for the condition to pass. Also accepts `~ALL` - to include all repositories. - items: - type: string - exclude: - type: array - description: Array of repository names or patterns - to exclude. The condition will not pass if any - of these patterns match. - items: - type: string - protected: - type: boolean - description: Whether renaming of target repositories - is prevented. - required: - - repository_name - - type: object - title: repository_id_and_ref_name - description: Conditions to target repositories by id and - refs by name - allOf: - - *267 - - title: Repository ruleset conditions for repository IDs - type: object - description: Parameters for a repository ID condition - properties: - repository_id: - type: object - properties: - repository_ids: - type: array - description: The repository IDs that the ruleset - applies to. One of these IDs must match for - the condition to pass. - items: - type: integer - required: - - repository_id - - type: object - title: repository_property_and_ref_name - description: Conditions to target repositories by property - and refs by name - allOf: - - *267 - - title: Repository ruleset conditions for repository properties - type: object - description: Parameters for a repository property condition - properties: - repository_property: - type: object - properties: - include: - type: array - description: The repository properties and values - to include. All of these properties must match - for the condition to pass. - items: &268 - title: Repository ruleset property targeting - definition - type: object - description: Parameters for a targeting a repository - property - properties: - name: - type: string - description: The name of the repository - property to target - property_values: - type: array - description: The values to match for the - repository property - items: - type: string - source: - type: string - description: The source of the repository - property. Defaults to 'custom' if not - specified. - enum: - - custom - - system - required: - - name - - property_values - exclude: - type: array - description: The repository properties and values - to exclude. The condition will not pass if any - of these properties match. - items: *268 - required: - - repository_property - type: - - 'null' - - object - rules: - type: array - items: &272 - title: Repository Rule - type: object - description: A repository rule. - oneOf: - - &548 - title: creation - description: Only allow users with bypass permission to - create matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - creation - - &549 - title: update - description: Only allow users with bypass permission to - update matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - update - parameters: - type: object - properties: - update_allows_fetch_and_merge: - type: boolean - description: Branch can pull changes from its upstream - repository - required: - - update_allows_fetch_and_merge - - &551 - title: deletion - description: Only allow users with bypass permissions to - delete matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - deletion - - &552 - title: required_linear_history - description: Prevent merge commits from being pushed to - matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_linear_history - - &553 - title: merge_queue - description: Merges must be performed via a merge queue. - type: object - required: - - type - properties: - type: - type: string - enum: - - merge_queue - parameters: - type: object - properties: - check_response_timeout_minutes: - type: integer - description: Maximum time for a required status - check to report a conclusion. After this much - time has elapsed, checks that have not reported - a conclusion will be assumed to have failed - minimum: 1 - maximum: 360 - grouping_strategy: - type: string - description: When set to ALLGREEN, the merge commit - created by merge queue for each PR in the group - must pass all required checks to merge. When set - to HEADGREEN, only the commit at the head of the - merge group, i.e. the commit containing changes - from all of the PRs in the group, must pass its - required checks to merge. - enum: - - ALLGREEN - - HEADGREEN - max_entries_to_build: - type: integer - description: Limit the number of queued pull requests - requesting checks and workflow runs at the same - time. - minimum: 0 - maximum: 100 - max_entries_to_merge: - type: integer - description: The maximum number of PRs that will - be merged together in a group. - minimum: 0 - maximum: 100 - merge_method: - type: string - description: Method to use when merging changes - from queued pull requests. - enum: - - MERGE - - SQUASH - - REBASE - min_entries_to_merge: - type: integer - description: The minimum number of PRs that will - be merged together in a group. - minimum: 0 - maximum: 100 - min_entries_to_merge_wait_minutes: - type: integer - description: The time merge queue should wait after - the first PR is added to the queue for the minimum - group size to be met. After this time has elapsed, - the minimum group size will be ignored and a smaller - group will be merged. - minimum: 0 - maximum: 360 - required: - - check_response_timeout_minutes - - grouping_strategy - - max_entries_to_build - - max_entries_to_merge - - merge_method - - min_entries_to_merge - - min_entries_to_merge_wait_minutes - - &554 - title: required_deployments - description: Choose which environments must be successfully - deployed to before refs can be pushed into a ref that - matches this rule. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_deployments - parameters: - type: object - properties: - required_deployment_environments: - type: array - description: The environments that must be successfully - deployed to before branches can be merged. - items: - type: string - required: - - required_deployment_environments - - &555 - title: required_signatures - description: Commits pushed to matching refs must have verified - signatures. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_signatures - - &556 - title: pull_request - description: Require all commits be made to a non-target - branch and submitted via a pull request before they can - be merged. - type: object - required: - - type - properties: - type: - type: string - enum: - - pull_request - parameters: - type: object - properties: - dismiss_stale_reviews_on_push: - type: boolean - description: New, reviewable commits pushed will - dismiss previous pull request review approvals. - require_code_owner_review: - type: boolean - description: Require an approving review in pull - requests that modify files that have a designated - code owner. - require_last_push_approval: - type: boolean - description: Whether the most recent reviewable - push must be approved by someone other than the - person who pushed it. - required_approving_review_count: - type: integer - description: The number of approving reviews that - are required before a pull request can be merged. - minimum: 0 - maximum: 10 - required_review_thread_resolution: - type: boolean - description: All conversations on code must be resolved - before a pull request can be merged. - required: - - dismiss_stale_reviews_on_push - - require_code_owner_review - - require_last_push_approval - - required_approving_review_count - - required_review_thread_resolution - - &557 - title: required_status_checks - description: Choose which status checks must pass before - the ref is updated. When enabled, commits must first be - pushed to another ref where the checks pass. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_status_checks - parameters: - type: object - properties: - do_not_enforce_on_create: - type: boolean - description: Allow repositories and branches to - be created if a check would otherwise prohibit - it. - required_status_checks: - type: array - description: Status checks that are required. - items: - title: StatusCheckConfiguration - description: Required status check - type: object - properties: - context: - type: string - description: The status check context name - that must be present on the commit. - integration_id: - type: integer - description: The optional integration ID that - this status check must originate from. - required: - - context - strict_required_status_checks_policy: - type: boolean - description: Whether pull requests targeting a matching - branch must be tested with the latest code. This - setting will not take effect unless at least one - status check is enabled. - required: - - required_status_checks - - strict_required_status_checks_policy - - &558 - title: non_fast_forward - description: Prevent users with push access from force pushing - to refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - non_fast_forward - - &559 - title: commit_message_pattern - description: Parameters to be used for the commit_message_pattern - rule - type: object - required: - - type - properties: - type: - type: string - enum: - - commit_message_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the - pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - - &560 - title: commit_author_email_pattern - description: Parameters to be used for the commit_author_email_pattern - rule - type: object - required: - - type - properties: - type: - type: string - enum: - - commit_author_email_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the - pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - - &561 - title: committer_email_pattern - description: Parameters to be used for the committer_email_pattern - rule - type: object - required: - - type - properties: - type: - type: string - enum: - - committer_email_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the - pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - - &562 - title: branch_name_pattern - description: Parameters to be used for the branch_name_pattern - rule - type: object - required: - - type - properties: - type: - type: string - enum: - - branch_name_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the - pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - - &563 - title: tag_name_pattern - description: Parameters to be used for the tag_name_pattern - rule - type: object - required: - - type - properties: - type: - type: string - enum: - - tag_name_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the - pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - - title: file_path_restriction - description: Prevent commits that include changes in specified - file paths from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_path_restriction - parameters: - type: object - properties: - restricted_file_paths: - type: array - description: The file paths that are restricted - from being pushed to the commit graph. - items: - type: string - required: - - restricted_file_paths - - title: max_file_path_length - description: Prevent commits that include file paths that - exceed a specified character limit from being pushed to - the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_path_length - parameters: - type: object - properties: - max_file_path_length: - type: integer - description: The maximum amount of characters allowed - in file paths - minimum: 1 - maximum: 256 - required: - - max_file_path_length - - title: file_extension_restriction - description: Prevent commits that include files with specified - file extensions from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_extension_restriction - parameters: - type: object - properties: - restricted_file_extensions: - type: array - description: The file extensions that are restricted - from being pushed to the commit graph. - items: - type: string - required: - - restricted_file_extensions - - title: max_file_size - description: Prevent commits that exceed a specified file - size limit from being pushed to the commit. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_size - parameters: - type: object - properties: - max_file_size: - type: integer - description: The maximum file size allowed in megabytes. - This limit does not apply to Git Large File Storage - (Git LFS). - minimum: 1 - maximum: 100 - required: - - max_file_size - - &564 - title: workflows - description: Require all changes made to a targeted branch - to pass the specified workflows before they can be merged. - type: object - required: - - type - properties: - type: - type: string - enum: - - workflows - parameters: - type: object - properties: - do_not_enforce_on_create: - type: boolean - description: Allow repositories and branches to - be created if a check would otherwise prohibit - it. - workflows: - type: array - description: Workflows that must pass for this rule - to pass. - items: - title: WorkflowFileReference - description: A workflow that must run for this - rule to pass - type: object - properties: - path: - type: string - description: The path to the workflow file - ref: - type: string - description: The ref (branch or tag) of the - workflow file to use - repository_id: - type: integer - description: The ID of the repository where - the workflow is defined - sha: - type: string - description: The commit SHA of the workflow - file to use - required: - - path - - repository_id - required: - - workflows - - &565 - title: code_scanning - description: Choose which tools must provide code scanning - results before the reference is updated. When configured, - code scanning must be enabled and have results for both - the commit and the reference being updated. - type: object - required: - - type - properties: - type: - type: string - enum: - - code_scanning - parameters: - type: object - properties: - code_scanning_tools: - type: array - description: Tools that must provide code scanning - results for this rule to pass. - items: - title: CodeScanningTool - description: A tool that must provide code scanning - results for this rule to pass. - type: object - properties: - alerts_threshold: - type: string - description: The severity level at which code - scanning results that raise alerts block - a reference update. For more information - on alert severity levels, see "[About code - scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." - enum: - - none - - errors - - errors_and_warnings - - all - security_alerts_threshold: - type: string - description: The severity level at which code - scanning results that raise security alerts - block a reference update. For more information - on security severity levels, see "[About - code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." - enum: - - none - - critical - - high_or_higher - - medium_or_higher - - all - tool: - type: string - description: The name of a code scanning tool - required: - - alerts_threshold - - security_alerts_threshold - - tool - required: - - code_scanning_tools - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time + items: *105 examples: default: value: @@ -39342,7 +39698,7 @@ paths: category: orgs subcategory: rules parameters: - - *138 + - *150 requestBody: description: Request body required: true @@ -39361,17 +39717,18 @@ paths: - branch - tag - push + - repository default: branch - enforcement: *269 + enforcement: *102 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *270 - conditions: *271 + items: *103 + conditions: *280 rules: type: array description: An array of rules within the ruleset. - items: *272 + items: *104 required: - name - enforcement @@ -39409,9 +39766,9 @@ paths: description: Response content: application/json: - schema: *273 + schema: *105 examples: - default: &274 + default: &281 value: id: 21 name: super cool ruleset @@ -39465,8 +39822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *138 - - &567 + - *150 + - &574 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 @@ -39481,7 +39838,7 @@ paths: in: query schema: type: string - - &568 + - &575 name: time_period description: |- The time period to filter by. @@ -39497,14 +39854,14 @@ paths: - week - month default: day - - &569 + - &576 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &570 + - &577 name: rule_suite_result description: The rule results to filter on. When specified, only suites with this result will be returned. @@ -39524,7 +39881,7 @@ paths: description: Response content: application/json: - schema: &571 + schema: &578 title: Rule Suites description: Response type: array @@ -39580,7 +39937,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &572 + default: &579 value: - id: 21 actor_id: 12 @@ -39623,8 +39980,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *138 - - &573 + - *150 + - &580 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -39640,7 +39997,7 @@ paths: description: Response content: application/json: - schema: &574 + schema: &581 title: Rule Suite description: Response type: object @@ -39747,7 +40104,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &575 + default: &582 value: id: 21 actor_id: 12 @@ -39808,7 +40165,7 @@ paths: category: orgs subcategory: rules parameters: - - *138 + - *150 - name: ruleset_id description: The ID of the ruleset. in: path @@ -39820,9 +40177,9 @@ paths: description: Response content: application/json: - schema: *273 + schema: *105 examples: - default: *274 + default: *281 '404': *6 '500': *80 put: @@ -39840,7 +40197,7 @@ paths: category: orgs subcategory: rules parameters: - - *138 + - *150 - name: ruleset_id description: The ID of the ruleset. in: path @@ -39865,16 +40222,17 @@ paths: - branch - tag - push - enforcement: *269 + - repository + enforcement: *102 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *270 - conditions: *271 + items: *103 + conditions: *280 rules: description: An array of rules within the ruleset. type: array - items: *272 + items: *104 examples: default: value: @@ -39909,9 +40267,9 @@ paths: description: Response content: application/json: - schema: *273 + schema: *105 examples: - default: *274 + default: *281 '404': *6 '500': *80 delete: @@ -39929,7 +40287,7 @@ paths: category: orgs subcategory: rules parameters: - - *138 + - *150 - name: ruleset_id description: The ID of the ruleset. in: path @@ -39957,15 +40315,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: - - *138 - - *275 - - *276 - - *277 - - *278 + - *150 + - *282 + - *283 + - *284 + - *285 - *76 - *18 - *17 - - &577 + - &584 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 @@ -39975,7 +40333,7 @@ paths: required: false schema: type: string - - &578 + - &585 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 @@ -39985,9 +40343,9 @@ paths: required: false schema: type: string - - *279 - - *280 - - *281 + - *286 + - *287 + - *288 responses: '200': description: Response @@ -39995,13 +40353,13 @@ paths: application/json: schema: type: array - items: *282 + items: *289 examples: - default: *283 + default: *290 headers: Link: *37 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40023,7 +40381,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: - - *138 + - *150 - *76 - name: sort description: The property to sort the results by. @@ -40067,7 +40425,7 @@ paths: application/json: schema: type: array - items: &585 + items: &592 description: A repository security advisory. type: object properties: @@ -40311,7 +40669,7 @@ paths: login: type: string description: The username of the user credited. - type: *284 + type: *291 credits_detailed: type: - array @@ -40322,7 +40680,7 @@ paths: type: object properties: user: *4 - type: *284 + type: *291 state: type: string description: The state of the user's acceptance of the @@ -40348,7 +40706,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *234 + items: *246 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -40386,7 +40744,7 @@ paths: - private_fork additionalProperties: false examples: - default: &586 + default: &593 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -40768,7 +41126,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *138 + - *150 responses: '200': description: Response @@ -40776,9 +41134,9 @@ paths: application/json: schema: type: array - items: *247 + items: *259 examples: - default: *248 + default: *260 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40801,8 +41159,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *138 - - *246 + - *150 + - *258 responses: '204': description: Response @@ -40827,8 +41185,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *138 - - *246 + - *150 + - *258 responses: '204': description: Response @@ -40854,15 +41212,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: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: *285 + schema: *292 examples: - default: *286 + default: *293 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -40886,7 +41244,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: - - *138 + - *150 - *17 - *18 responses: @@ -40894,9 +41252,9 @@ paths: description: Success content: application/json: - schema: *287 + schema: *294 examples: - default: *288 + default: *295 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -40918,15 +41276,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: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: *289 + schema: *296 examples: - default: *290 + default: *297 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -40948,15 +41306,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: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: *291 + schema: *298 examples: - default: *292 + default: *299 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -40973,7 +41331,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: - - *138 + - *150 - *17 - name: page description: Page token @@ -40992,7 +41350,7 @@ paths: description: Response content: application/json: - schema: &314 + schema: &321 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -41044,7 +41402,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &315 + default: &322 value: groups: - group_id: '123' @@ -41089,8 +41447,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *138 - - *246 + - *150 + - *258 - 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`). @@ -41122,13 +41480,13 @@ paths: application/json: schema: type: array - items: *98 + items: *110 examples: - default: *99 + default: *111 '500': *80 '403': *27 '404': *6 - '422': *100 + '422': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41162,8 +41520,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team parameters: - - *138 - - *246 + - *150 + - *258 - 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`). @@ -41195,9 +41553,9 @@ paths: application/json: schema: type: array - items: *101 + items: *113 examples: - default: *192 + default: *204 '500': *80 '401': *23 '403': *27 @@ -41219,7 +41577,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *138 + - *150 - *17 - *18 responses: @@ -41229,9 +41587,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - default: *248 + default: *260 headers: Link: *37 '403': *27 @@ -41253,7 +41611,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *138 + - *150 requestBody: required: true content: @@ -41325,7 +41683,7 @@ paths: description: Response content: application/json: - schema: &293 + schema: &300 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -41399,7 +41757,7 @@ paths: parent: anyOf: - type: 'null' - - *247 + - *259 members_count: type: integer examples: @@ -41705,7 +42063,7 @@ paths: - repos_count - organization examples: - default: &294 + default: &301 value: id: 1 node_id: MDQ6VGVhbTE= @@ -41775,16 +42133,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *138 - - *246 + - *150 + - *258 responses: '200': description: Response content: application/json: - schema: *293 + schema: *300 examples: - default: *294 + default: *301 '404': *6 x-github: githubCloudOnly: false @@ -41805,8 +42163,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *138 - - *246 + - *150 + - *258 requestBody: required: false content: @@ -41869,16 +42227,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *293 + schema: *300 examples: - default: *294 + default: *301 '201': description: Response content: application/json: - schema: *293 + schema: *300 examples: - default: *294 + default: *301 '404': *6 '422': *15 '403': *27 @@ -41903,8 +42261,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *138 - - *246 + - *150 + - *258 responses: '204': description: Response @@ -41930,8 +42288,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *138 - - *246 + - *150 + - *258 - *76 - *17 - *18 @@ -41948,7 +42306,7 @@ paths: application/json: schema: type: array - items: &295 + items: &302 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -42039,7 +42397,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *104 + reactions: *116 required: - author - body @@ -42059,7 +42417,7 @@ paths: - updated_at - url examples: - default: &626 + default: &633 value: - author: login: octocat @@ -42133,8 +42491,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *138 - - *246 + - *150 + - *258 requestBody: required: true content: @@ -42168,9 +42526,9 @@ paths: description: Response content: application/json: - schema: *295 + schema: *302 examples: - default: &296 + default: &303 value: author: login: octocat @@ -42242,9 +42600,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *138 - - *246 - - &297 + - *150 + - *258 + - &304 name: discussion_number description: The number that identifies the discussion. in: path @@ -42256,9 +42614,9 @@ paths: description: Response content: application/json: - schema: *295 + schema: *302 examples: - default: *296 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42280,9 +42638,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *138 - - *246 - - *297 + - *150 + - *258 + - *304 requestBody: required: false content: @@ -42305,9 +42663,9 @@ paths: description: Response content: application/json: - schema: *295 + schema: *302 examples: - default: &627 + default: &634 value: author: login: octocat @@ -42377,9 +42735,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *138 - - *246 - - *297 + - *150 + - *258 + - *304 responses: '204': description: Response @@ -42405,9 +42763,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *138 - - *246 - - *297 + - *150 + - *258 + - *304 - *76 - *17 - *18 @@ -42418,7 +42776,7 @@ paths: application/json: schema: type: array - items: &298 + items: &305 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -42483,7 +42841,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *104 + reactions: *116 required: - author - body @@ -42498,7 +42856,7 @@ paths: - updated_at - url examples: - default: &628 + default: &635 value: - author: login: octocat @@ -42566,9 +42924,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *138 - - *246 - - *297 + - *150 + - *258 + - *304 requestBody: required: true content: @@ -42590,9 +42948,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: &299 + default: &306 value: author: login: octocat @@ -42658,10 +43016,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *138 - - *246 - - *297 - - &300 + - *150 + - *258 + - *304 + - &307 name: comment_number description: The number that identifies the comment. in: path @@ -42673,9 +43031,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42697,10 +43055,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *138 - - *246 - - *297 - - *300 + - *150 + - *258 + - *304 + - *307 requestBody: required: true content: @@ -42722,9 +43080,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: &629 + default: &636 value: author: login: octocat @@ -42788,10 +43146,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *138 - - *246 - - *297 - - *300 + - *150 + - *258 + - *304 + - *307 responses: '204': description: Response @@ -42817,10 +43175,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: - - *138 - - *246 - - *297 - - *300 + - *150 + - *258 + - *304 + - *307 - 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. @@ -42846,7 +43204,7 @@ paths: application/json: schema: type: array - items: &301 + items: &308 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -42890,7 +43248,7 @@ paths: - content - created_at examples: - default: &303 + default: &310 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -42940,10 +43298,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: - - *138 - - *246 - - *297 - - *300 + - *150 + - *258 + - *304 + - *307 requestBody: required: true content: @@ -42976,9 +43334,9 @@ paths: team discussion comment content: application/json: - schema: *301 + schema: *308 examples: - default: &302 + default: &309 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -43007,9 +43365,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43032,11 +43390,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *138 - - *246 - - *297 - - *300 - - &304 + - *150 + - *258 + - *304 + - *307 + - &311 name: reaction_id description: The unique identifier of the reaction. in: path @@ -43068,9 +43426,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *138 - - *246 - - *297 + - *150 + - *258 + - *304 - 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. @@ -43096,9 +43454,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *303 + default: *310 headers: Link: *37 x-github: @@ -43124,9 +43482,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *138 - - *246 - - *297 + - *150 + - *258 + - *304 requestBody: required: true content: @@ -43158,16 +43516,16 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '201': description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -43190,10 +43548,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *138 - - *246 - - *297 + - *150 + - *258 - *304 + - *311 responses: '204': description: Response @@ -43216,16 +43574,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: - - *138 - - *246 + - *150 + - *258 responses: '200': description: Response content: application/json: - schema: *305 + schema: *312 examples: - default: *306 + default: *313 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -43244,8 +43602,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: - - *138 - - *246 + - *150 + - *258 requestBody: required: true content: @@ -43269,9 +43627,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *314 examples: - default: *308 + default: *315 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -43290,8 +43648,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: - - *138 - - *246 + - *150 + - *258 responses: '204': description: Response @@ -43315,8 +43673,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *138 - - *246 + - *150 + - *258 - *17 - *18 responses: @@ -43326,9 +43684,9 @@ paths: application/json: schema: type: array - items: *231 + items: *243 examples: - default: *232 + default: *244 headers: Link: *37 x-github: @@ -43350,8 +43708,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *138 - - *246 + - *150 + - *258 - name: role description: Filters members returned by their role in the team. in: query @@ -43374,7 +43732,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 x-github: @@ -43404,15 +43762,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *138 - - *246 - - *178 + - *150 + - *258 + - *190 responses: '200': description: Response content: application/json: - schema: &309 + schema: &316 title: Team Membership description: Team Membership type: object @@ -43440,7 +43798,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &630 + response-if-user-is-a-team-maintainer: &637 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -43476,9 +43834,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: - - *138 - - *246 - - *178 + - *150 + - *258 + - *190 requestBody: required: false content: @@ -43503,9 +43861,9 @@ paths: description: Response content: application/json: - schema: *309 + schema: *316 examples: - response-if-users-membership-with-team-is-now-pending: &631 + response-if-users-membership-with-team-is-now-pending: &638 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -43540,9 +43898,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *138 - - *246 - - *178 + - *150 + - *258 + - *190 responses: '204': description: Response @@ -43568,8 +43926,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - - *138 - - *246 + - *150 + - *258 - *17 - *18 responses: @@ -43579,7 +43937,7 @@ paths: application/json: schema: type: array - items: &310 + items: &317 title: Team Project description: A team's access to a project. type: object @@ -43648,7 +44006,7 @@ paths: - updated_at - permissions examples: - default: &632 + default: &639 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -43709,9 +44067,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - - *138 - - *246 - - &311 + - *150 + - *258 + - &318 name: project_id description: The unique identifier of the project. in: path @@ -43723,9 +44081,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *317 examples: - default: &633 + default: &640 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -43785,9 +44143,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - - *138 - - *246 - - *311 + - *150 + - *258 + - *318 requestBody: required: false content: @@ -43852,9 +44210,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - - *138 - - *246 - - *311 + - *150 + - *258 + - *318 responses: '204': description: Response @@ -43878,8 +44236,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *138 - - *246 + - *150 + - *258 - *17 - *18 responses: @@ -43889,9 +44247,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 x-github: @@ -43920,16 +44278,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *138 - - *246 - - *312 - - *313 + - *150 + - *258 + - *319 + - *320 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &634 + schema: &641 title: Team Repository description: A team's access to a repository. type: object @@ -43955,7 +44313,7 @@ paths: license: anyOf: - type: 'null' - - *117 + - *129 forks: type: integer permissions: @@ -44570,10 +44928,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *138 - - *246 - - *312 - - *313 + - *150 + - *258 + - *319 + - *320 requestBody: required: false content: @@ -44618,10 +44976,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *138 - - *246 - - *312 - - *313 + - *150 + - *258 + - *319 + - *320 responses: '204': description: Response @@ -44647,16 +45005,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: - - *138 - - *246 + - *150 + - *258 responses: '200': description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -44678,8 +45036,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: - - *138 - - *246 + - *150 + - *258 requestBody: required: true content: @@ -44722,7 +45080,7 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: default: value: @@ -44754,8 +45112,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *138 - - *246 + - *150 + - *258 - *17 - *18 responses: @@ -44765,9 +45123,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - response-if-child-teams-exist: &635 + response-if-child-teams-exist: &642 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -44820,7 +45178,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: - - *138 + - *150 - name: security_product in: path description: The security feature to enable or disable. @@ -44891,7 +45249,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#get-a-project-card parameters: - - &316 + - &323 name: card_id description: The unique identifier of the card. in: path @@ -44903,7 +45261,7 @@ paths: description: Response content: application/json: - schema: &317 + schema: &324 title: Project Card description: Project cards represent a scope of work. type: object @@ -44978,7 +45336,7 @@ paths: - created_at - updated_at examples: - default: &318 + default: &325 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -45028,7 +45386,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#update-an-existing-project-card parameters: - - *316 + - *323 requestBody: required: false content: @@ -45058,9 +45416,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *324 examples: - default: *318 + default: *325 '304': *35 '403': *27 '401': *23 @@ -45081,7 +45439,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#delete-a-project-card parameters: - - *316 + - *323 responses: '204': description: Response @@ -45119,7 +45477,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#move-a-project-card parameters: - - *316 + - *323 requestBody: required: true content: @@ -45226,7 +45584,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#get-a-project-column parameters: - - &319 + - &326 name: column_id description: The unique identifier of the column. in: path @@ -45238,7 +45596,7 @@ paths: description: Response content: application/json: - schema: &320 + schema: &327 title: Project Column description: Project columns contain cards of work. type: object @@ -45292,7 +45650,7 @@ paths: - created_at - updated_at examples: - default: &321 + default: &328 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -45321,7 +45679,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#update-an-existing-project-column parameters: - - *319 + - *326 requestBody: required: true content: @@ -45346,9 +45704,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '304': *35 '403': *27 '401': *23 @@ -45367,7 +45725,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#delete-a-project-column parameters: - - *319 + - *326 responses: '204': description: Response @@ -45390,7 +45748,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#list-project-cards parameters: - - *319 + - *326 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -45411,7 +45769,7 @@ paths: application/json: schema: type: array - items: *317 + items: *324 examples: default: value: @@ -45464,7 +45822,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#create-a-project-card parameters: - - *319 + - *326 requestBody: required: true content: @@ -45508,9 +45866,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *324 examples: - default: *318 + default: *325 '304': *35 '403': *27 '401': *23 @@ -45520,8 +45878,8 @@ paths: application/json: schema: oneOf: - - *141 - - *142 + - *153 + - *154 '503': description: Response content: @@ -45560,7 +45918,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#move-a-project-column parameters: - - *319 + - *326 requestBody: required: true content: @@ -45617,15 +45975,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-a-project parameters: - - *311 + - *318 responses: '200': description: Response content: application/json: - schema: *262 + schema: *274 examples: - default: &322 + default: &329 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -45678,7 +46036,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#update-a-project parameters: - - *311 + - *318 requestBody: required: false content: @@ -45727,9 +46085,9 @@ paths: description: Response content: application/json: - schema: *262 + schema: *274 examples: - default: *322 + default: *329 '404': description: Not Found if the authenticated user does not have access to the project @@ -45750,7 +46108,7 @@ paths: items: type: string '401': *23 - '410': *323 + '410': *330 '422': *7 x-github: githubCloudOnly: false @@ -45768,7 +46126,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#delete-a-project parameters: - - *311 + - *318 responses: '204': description: Delete Success @@ -45789,7 +46147,7 @@ paths: items: type: string '401': *23 - '410': *323 + '410': *330 '404': *6 x-github: githubCloudOnly: false @@ -45812,7 +46170,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#list-project-collaborators parameters: - - *311 + - *318 - 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 @@ -45839,7 +46197,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 '404': *6 @@ -45864,8 +46222,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#add-project-collaborator parameters: - - *311 - - *178 + - *318 + - *190 requestBody: required: false content: @@ -45914,8 +46272,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#remove-user-as-a-collaborator parameters: - - *311 - - *178 + - *318 + - *190 responses: '204': description: Response @@ -45943,8 +46301,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#get-project-permission-for-a-user parameters: - - *311 - - *178 + - *318 + - *190 responses: '200': description: Response @@ -46008,7 +46366,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#list-project-columns parameters: - - *311 + - *318 - *17 - *18 responses: @@ -46018,7 +46376,7 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: default: value: @@ -46050,7 +46408,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#create-a-project-column parameters: - - *311 + - *318 requestBody: required: true content: @@ -46074,7 +46432,7 @@ paths: description: Response content: application/json: - schema: *320 + schema: *327 examples: default: value: @@ -46135,7 +46493,7 @@ paths: resources: type: object properties: - core: &324 + core: &331 title: Rate Limit type: object properties: @@ -46152,19 +46510,20 @@ paths: - remaining - reset - used - graphql: *324 - search: *324 - code_search: *324 - source_import: *324 - integration_manifest: *324 - code_scanning_upload: *324 - actions_runner_registration: *324 - scim: *324 - dependency_snapshots: *324 + graphql: *331 + search: *331 + code_search: *331 + source_import: *331 + integration_manifest: *331 + code_scanning_upload: *331 + actions_runner_registration: *331 + scim: *331 + dependency_snapshots: *331 + code_scanning_autofix: *331 required: - core - search - rate: *324 + rate: *331 required: - rate - resources @@ -46222,6 +46581,11 @@ paths: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -46263,14 +46627,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: *325 + schema: *332 examples: default-response: summary: Default response @@ -46775,7 +47139,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *326 + '301': *333 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46793,8 +47157,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: false content: @@ -47041,10 +47405,10 @@ paths: description: Response content: application/json: - schema: *325 + schema: *332 examples: - default: *327 - '307': &328 + default: *334 + '307': &335 description: Temporary Redirect content: application/json: @@ -47073,8 +47437,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -47096,7 +47460,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': *328 + '307': *335 '404': *6 x-github: githubCloudOnly: false @@ -47119,11 +47483,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 - - &343 + - &350 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -47146,7 +47510,7 @@ paths: type: integer artifacts: type: array - items: &329 + items: &336 title: Artifact description: An artifact type: object @@ -47232,7 +47596,7 @@ paths: - expires_at - updated_at examples: - default: &344 + default: &351 value: total_count: 2 artifacts: @@ -47291,9 +47655,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *312 - - *313 - - &330 + - *319 + - *320 + - &337 name: artifact_id description: The unique identifier of the artifact. in: path @@ -47305,7 +47669,7 @@ paths: description: Response content: application/json: - schema: *329 + schema: *336 examples: default: value: @@ -47342,9 +47706,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *312 - - *313 - - *330 + - *319 + - *320 + - *337 responses: '204': description: Response @@ -47368,9 +47732,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *312 - - *313 - - *330 + - *319 + - *320 + - *337 - name: archive_format in: path required: true @@ -47384,7 +47748,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': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47407,14 +47771,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: *331 + schema: *338 examples: default: value: @@ -47440,11 +47804,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: - - *312 - - *313 + - *319 + - *320 - *17 - *18 - - &332 + - &339 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 @@ -47478,7 +47842,7 @@ paths: description: Response content: application/json: - schema: &333 + schema: &340 title: Repository actions caches description: Repository actions caches type: object @@ -47528,7 +47892,7 @@ paths: - total_count - actions_caches examples: - default: &334 + default: &341 value: total_count: 1 actions_caches: @@ -47560,23 +47924,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: - - *312 - - *313 + - *319 + - *320 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *332 + - *339 responses: '200': description: Response content: application/json: - schema: *333 + schema: *340 examples: - default: *334 + default: *341 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47596,8 +47960,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: - - *312 - - *313 + - *319 + - *320 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -47628,9 +47992,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: - - *312 - - *313 - - &335 + - *319 + - *320 + - &342 name: job_id description: The unique identifier of the job. in: path @@ -47642,7 +48006,7 @@ paths: description: Response content: application/json: - schema: &347 + schema: &354 title: Job description: Information of a job execution in a workflow run type: object @@ -47989,9 +48353,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: - - *312 - - *313 - - *335 + - *319 + - *320 + - *342 responses: '302': description: Response @@ -48019,9 +48383,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: - - *312 - - *313 - - *335 + - *319 + - *320 + - *342 requestBody: required: false content: @@ -48043,7 +48407,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -48067,8 +48431,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Status response @@ -48118,8 +48482,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -48153,7 +48517,7 @@ paths: description: Empty response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -48182,8 +48546,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -48201,7 +48565,7 @@ paths: type: integer secrets: type: array - items: &349 + items: &356 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -48222,7 +48586,7 @@ paths: - created_at - updated_at examples: - default: &350 + default: &357 value: total_count: 2 secrets: @@ -48255,9 +48619,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *312 - - *313 - - *336 + - *319 + - *320 + - *343 - *18 responses: '200': @@ -48274,7 +48638,7 @@ paths: type: integer variables: type: array - items: &353 + items: &360 title: Actions Variable type: object properties: @@ -48308,7 +48672,7 @@ paths: - created_at - updated_at examples: - default: &354 + default: &361 value: total_count: 2 variables: @@ -48341,8 +48705,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -48351,11 +48715,11 @@ paths: schema: type: object properties: - enabled: &337 + enabled: &344 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *40 - selected_actions_url: *149 + selected_actions_url: *161 required: - enabled examples: @@ -48384,8 +48748,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: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -48396,7 +48760,7 @@ paths: schema: type: object properties: - enabled: *337 + enabled: *344 allowed_actions: *40 required: - enabled @@ -48427,14 +48791,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: &338 + schema: &345 type: object properties: access_level: @@ -48452,7 +48816,7 @@ paths: required: - access_level examples: - default: &339 + default: &346 value: access_level: organization x-github: @@ -48477,15 +48841,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: application/json: - schema: *338 + schema: *345 examples: - default: *339 + default: *346 responses: '204': description: Response @@ -48509,8 +48873,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -48541,8 +48905,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: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -48574,14 +48938,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: *152 + schema: *164 examples: default: *46 x-github: @@ -48604,8 +48968,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: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Success response @@ -48616,7 +48980,7 @@ paths: required: true content: application/json: - schema: *153 + schema: *165 examples: default: *46 x-github: @@ -48645,8 +49009,8 @@ paths: in: query schema: type: string - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -48690,8 +49054,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -48699,9 +49063,9 @@ paths: application/json: schema: type: array - items: *157 + items: *169 examples: - default: *158 + default: *170 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48723,8 +49087,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -48767,7 +49131,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *159 + '201': *171 '404': *6 '422': *7 x-github: @@ -48797,8 +49161,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: - - *312 - - *313 + - *319 + - *320 responses: '201': description: Response @@ -48806,7 +49170,7 @@ paths: application/json: schema: *56 examples: - default: *160 + default: *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48834,8 +49198,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: - - *312 - - *313 + - *319 + - *320 responses: '201': description: Response @@ -48843,7 +49207,7 @@ paths: application/json: schema: *56 examples: - default: *161 + default: *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48865,8 +49229,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: - - *312 - - *313 + - *319 + - *320 - *52 responses: '200': @@ -48875,7 +49239,7 @@ paths: application/json: schema: *53 examples: - default: *162 + default: *174 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48896,8 +49260,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: - - *312 - - *313 + - *319 + - *320 - *52 responses: '204': @@ -48923,8 +49287,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: - - *312 - - *313 + - *319 + - *320 - *52 responses: '200': *58 @@ -48949,8 +49313,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: - - *312 - - *313 + - *319 + - *320 - *52 requestBody: required: true @@ -48999,8 +49363,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: - - *312 - - *313 + - *319 + - *320 - *52 requestBody: required: true @@ -49050,11 +49414,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: - - *312 - - *313 + - *319 + - *320 - *52 responses: - '200': *163 + '200': *175 '404': *6 x-github: githubCloudOnly: false @@ -49081,10 +49445,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: - - *312 - - *313 + - *319 + - *320 - *52 - - *164 + - *176 responses: '200': *58 '404': *6 @@ -49112,9 +49476,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: - - *312 - - *313 - - &357 + - *319 + - *320 + - &364 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. @@ -49122,7 +49486,7 @@ paths: required: false schema: type: string - - &358 + - &365 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -49130,7 +49494,7 @@ paths: required: false schema: type: string - - &359 + - &366 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -49139,7 +49503,7 @@ paths: required: false schema: type: string - - &360 + - &367 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 @@ -49166,7 +49530,7 @@ paths: - pending - *17 - *18 - - &361 + - &368 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)." @@ -49175,7 +49539,7 @@ paths: schema: type: string format: date-time - - &340 + - &347 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -49184,13 +49548,13 @@ paths: schema: type: boolean default: false - - &362 + - &369 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &363 + - &370 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -49213,7 +49577,7 @@ paths: type: integer workflow_runs: type: array - items: &341 + items: &348 title: Workflow Run description: An invocation of a workflow type: object @@ -49330,7 +49694,7 @@ paths: type: - array - 'null' - items: &382 + items: &389 title: Pull Request Minimal type: object properties: @@ -49457,7 +49821,7 @@ paths: head_commit: anyOf: - type: 'null' - - &386 + - &393 title: Simple Commit description: A commit. type: object @@ -49531,8 +49895,8 @@ paths: - timestamp - author - committer - repository: *156 - head_repository: *156 + repository: *168 + head_repository: *168 head_repository_id: type: integer examples: @@ -49572,7 +49936,7 @@ paths: - workflow_url - pull_requests examples: - default: &364 + default: &371 value: total_count: 1 workflow_runs: @@ -49808,24 +50172,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *312 - - *313 - - &342 + - *319 + - *320 + - &349 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *340 + - *347 responses: '200': description: Response content: application/json: - schema: *341 + schema: *348 examples: - default: &345 + default: &352 value: id: 30433642 name: Build @@ -50066,9 +50430,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '204': description: Response @@ -50091,9 +50455,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: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '200': description: Response @@ -50221,15 +50585,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: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '201': description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -50256,12 +50620,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 - *17 - *18 - - *343 + - *350 responses: '200': description: Response @@ -50277,9 +50641,9 @@ paths: type: integer artifacts: type: array - items: *329 + items: *336 examples: - default: *344 + default: *351 headers: Link: *37 x-github: @@ -50303,25 +50667,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *312 - - *313 - - *342 - - &346 + - *319 + - *320 + - *349 + - &353 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *340 + - *347 responses: '200': description: Response content: application/json: - schema: *341 + schema: *348 examples: - default: *345 + default: *352 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50344,10 +50708,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: - - *312 - - *313 - - *342 - - *346 + - *319 + - *320 + - *349 + - *353 - *17 - *18 responses: @@ -50365,9 +50729,9 @@ paths: type: integer jobs: type: array - items: *347 + items: *354 examples: - default: &348 + default: &355 value: total_count: 1 jobs: @@ -50480,10 +50844,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *312 - - *313 - - *342 - - *346 + - *319 + - *320 + - *349 + - *353 responses: '302': description: Response @@ -50511,19 +50875,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '202': description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50546,9 +50910,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: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 requestBody: required: true content: @@ -50615,19 +50979,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '202': description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50650,9 +51014,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: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 - 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 @@ -50682,9 +51046,9 @@ paths: type: integer jobs: type: array - items: *347 + items: *354 examples: - default: *348 + default: *355 headers: Link: *37 x-github: @@ -50709,9 +51073,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '302': description: Response @@ -50738,9 +51102,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '204': description: Response @@ -50767,9 +51131,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: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '200': description: Response @@ -50838,7 +51202,7 @@ paths: items: type: object properties: - type: &454 + type: &461 type: string description: The type of reviewer. enum: @@ -50849,7 +51213,7 @@ paths: reviewer: anyOf: - *4 - - *234 + - *246 required: - environment - wait_timer @@ -50924,9 +51288,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: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 requestBody: required: true content: @@ -50976,7 +51340,7 @@ paths: application/json: schema: type: array - items: &449 + items: &456 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -51088,7 +51452,7 @@ paths: - created_at - updated_at examples: - default: &450 + default: &457 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -51144,9 +51508,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 requestBody: required: false content: @@ -51168,7 +51532,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -51191,9 +51555,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: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 requestBody: required: false content: @@ -51215,7 +51579,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -51240,9 +51604,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '200': description: Response @@ -51379,8 +51743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -51398,9 +51762,9 @@ paths: type: integer secrets: type: array - items: *349 + items: *356 examples: - default: *350 + default: *357 headers: Link: *37 x-github: @@ -51425,16 +51789,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: *351 + schema: *358 examples: - default: *352 + default: *359 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51456,17 +51820,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 responses: '200': description: Response content: application/json: - schema: *349 + schema: *356 examples: - default: &467 + default: &474 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -51492,9 +51856,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 requestBody: required: true content: @@ -51522,7 +51886,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -51548,9 +51912,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 responses: '204': description: Response @@ -51575,9 +51939,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *312 - - *313 - - *336 + - *319 + - *320 + - *343 - *18 responses: '200': @@ -51594,9 +51958,9 @@ paths: type: integer variables: type: array - items: *353 + items: *360 examples: - default: *354 + default: *361 headers: Link: *37 x-github: @@ -51619,8 +51983,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -51647,7 +52011,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -51672,17 +52036,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *312 - - *313 - - *169 + - *319 + - *320 + - *181 responses: '200': description: Response content: application/json: - schema: *353 + schema: *360 examples: - default: &468 + default: &475 value: name: USERNAME value: octocat @@ -51708,9 +52072,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *312 - - *313 - - *169 + - *319 + - *320 + - *181 requestBody: required: true content: @@ -51752,9 +52116,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *312 - - *313 - - *169 + - *319 + - *320 + - *181 responses: '204': description: Response @@ -51779,8 +52143,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -51798,7 +52162,7 @@ paths: type: integer workflows: type: array - items: &355 + items: &362 title: Workflow description: A GitHub Actions workflow type: object @@ -51916,9 +52280,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *312 - - *313 - - &356 + - *319 + - *320 + - &363 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -51933,7 +52297,7 @@ paths: description: Response content: application/json: - schema: *355 + schema: *362 examples: default: value: @@ -51966,9 +52330,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *312 - - *313 - - *356 + - *319 + - *320 + - *363 responses: '204': description: Response @@ -51993,9 +52357,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *312 - - *313 - - *356 + - *319 + - *320 + - *363 responses: '204': description: Response @@ -52046,9 +52410,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *312 - - *313 - - *356 + - *319 + - *320 + - *363 responses: '204': description: Response @@ -52075,19 +52439,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: - - *312 - - *313 - - *356 - - *357 - - *358 - - *359 - - *360 + - *319 + - *320 + - *363 + - *364 + - *365 + - *366 + - *367 - *17 - *18 - - *361 - - *340 - - *362 - - *363 + - *368 + - *347 + - *369 + - *370 responses: '200': description: Response @@ -52103,9 +52467,9 @@ paths: type: integer workflow_runs: type: array - items: *341 + items: *348 examples: - default: *364 + default: *371 headers: Link: *37 x-github: @@ -52131,9 +52495,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *312 - - *313 - - *356 + - *319 + - *320 + - *363 responses: '200': description: Response @@ -52194,8 +52558,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *312 - - *313 + - *319 + - *320 - *76 - *17 - *74 @@ -52363,8 +52727,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -52376,7 +52740,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 '404': *6 @@ -52401,8 +52765,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: - - *312 - - *313 + - *319 + - *320 - name: assignee in: path required: true @@ -52438,8 +52802,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -52551,8 +52915,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *74 - *75 @@ -52595,8 +52959,10 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: - default: *365 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52616,8 +52982,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -52625,7 +52991,7 @@ paths: application/json: schema: type: array - items: &366 + items: &373 title: Autolink reference description: An autolink reference. type: object @@ -52679,8 +53045,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -52719,9 +53085,9 @@ paths: description: response content: application/json: - schema: *366 + schema: *373 examples: - default: &367 + default: &374 value: id: 1 key_prefix: TICKET- @@ -52752,9 +53118,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: - - *312 - - *313 - - &368 + - *319 + - *320 + - &375 name: autolink_id description: The unique identifier of the autolink. in: path @@ -52766,9 +53132,9 @@ paths: description: Response content: application/json: - schema: *366 + schema: *373 examples: - default: *367 + default: *374 '404': *6 x-github: githubCloudOnly: false @@ -52788,9 +53154,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: - - *312 - - *313 - - *368 + - *319 + - *320 + - *375 responses: '204': description: Response @@ -52814,8 +53180,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response if Dependabot is enabled @@ -52865,8 +53231,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-automated-security-fixes parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -52887,8 +53253,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-automated-security-fixes parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -52908,8 +53274,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *312 - - *313 + - *319 + - *320 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -52947,7 +53313,7 @@ paths: - url protected: type: boolean - protection: &370 + protection: &377 title: Branch Protection description: Branch Protection type: object @@ -52990,7 +53356,7 @@ paths: required: - contexts - checks - enforce_admins: &373 + enforce_admins: &380 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -53007,7 +53373,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &375 + required_pull_request_reviews: &382 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -53029,7 +53395,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *234 + items: *246 apps: description: The list of apps with review dismissal access. @@ -53061,7 +53427,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *234 + items: *246 apps: description: The list of apps allowed to bypass pull request requirements. @@ -53091,7 +53457,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &372 + restrictions: &379 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -53416,9 +53782,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *312 - - *313 - - &371 + - *319 + - *320 + - &378 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). @@ -53432,14 +53798,14 @@ paths: description: Response content: application/json: - schema: &381 + schema: &388 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &425 + commit: &432 title: Commit description: Commit type: object @@ -53478,7 +53844,7 @@ paths: author: anyOf: - type: 'null' - - &369 + - &376 title: Git User description: Metaproperties for Git author/committer information. @@ -53499,7 +53865,7 @@ paths: committer: anyOf: - type: 'null' - - *369 + - *376 message: type: string examples: @@ -53523,7 +53889,7 @@ paths: required: - sha - url - verification: &474 + verification: &481 title: Verification type: object properties: @@ -53558,14 +53924,14 @@ paths: author: oneOf: - *4 - - *167 + - *179 type: - 'null' - object committer: oneOf: - *4 - - *167 + - *179 type: - 'null' - object @@ -53602,7 +53968,7 @@ paths: type: integer files: type: array - items: &437 + items: &444 title: Diff Entry description: Diff Entry type: object @@ -53696,7 +54062,7 @@ paths: - self protected: type: boolean - protection: *370 + protection: *377 protection_url: type: string format: uri @@ -53805,7 +54171,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *326 + '301': *333 '404': *6 x-github: githubCloudOnly: false @@ -53827,15 +54193,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response content: application/json: - schema: *370 + schema: *377 examples: default: value: @@ -54029,9 +54395,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: true content: @@ -54291,7 +54657,7 @@ paths: url: type: string format: uri - required_status_checks: &378 + required_status_checks: &385 title: Status Check Policy description: Status Check Policy type: object @@ -54372,7 +54738,7 @@ paths: items: *4 teams: type: array - items: *234 + items: *246 apps: type: array items: *5 @@ -54390,7 +54756,7 @@ paths: items: *4 teams: type: array - items: *234 + items: *246 apps: type: array items: *5 @@ -54450,7 +54816,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *372 + restrictions: *379 required_conversation_resolution: type: object properties: @@ -54562,9 +54928,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '204': description: Response @@ -54589,17 +54955,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response content: application/json: - schema: *373 + schema: *380 examples: - default: &374 + default: &381 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -54621,17 +54987,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response content: application/json: - schema: *373 + schema: *380 examples: - default: *374 + default: *381 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54650,9 +55016,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '204': description: Response @@ -54677,17 +55043,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response content: application/json: - schema: *375 + schema: *382 examples: - default: &376 + default: &383 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -54783,9 +55149,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: false content: @@ -54883,9 +55249,9 @@ paths: description: Response content: application/json: - schema: *375 + schema: *382 examples: - default: *376 + default: *383 '422': *15 x-github: githubCloudOnly: false @@ -54906,9 +55272,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '204': description: Response @@ -54935,17 +55301,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response content: application/json: - schema: *373 + schema: *380 examples: - default: &377 + default: &384 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -54968,17 +55334,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response content: application/json: - schema: *373 + schema: *380 examples: - default: *377 + default: *384 '404': *6 x-github: githubCloudOnly: false @@ -54998,9 +55364,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '204': description: Response @@ -55025,17 +55391,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response content: application/json: - schema: *378 + schema: *385 examples: - default: &379 + default: &386 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -55061,9 +55427,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: false content: @@ -55115,9 +55481,9 @@ paths: description: Response content: application/json: - schema: *378 + schema: *385 examples: - default: *379 + default: *386 '404': *6 '422': *15 x-github: @@ -55139,9 +55505,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '204': description: Response @@ -55165,9 +55531,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response @@ -55201,9 +55567,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: false content: @@ -55270,9 +55636,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: false content: @@ -55336,9 +55702,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: content: application/json: @@ -55404,15 +55770,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response content: application/json: - schema: *372 + schema: *379 examples: default: value: @@ -55503,9 +55869,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '204': description: Response @@ -55528,9 +55894,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: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response @@ -55540,7 +55906,7 @@ paths: type: array items: *5 examples: - default: &380 + default: &387 value: - id: 1 slug: octoapp @@ -55597,9 +55963,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: true content: @@ -55633,7 +55999,7 @@ paths: type: array items: *5 examples: - default: *380 + default: *387 '422': *15 x-github: githubCloudOnly: false @@ -55654,9 +56020,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: true content: @@ -55690,7 +56056,7 @@ paths: type: array items: *5 examples: - default: *380 + default: *387 '422': *15 x-github: githubCloudOnly: false @@ -55711,9 +56077,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: true content: @@ -55747,7 +56113,7 @@ paths: type: array items: *5 examples: - default: *380 + default: *387 '422': *15 x-github: githubCloudOnly: false @@ -55769,9 +56135,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: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response @@ -55779,9 +56145,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - default: *248 + default: *260 '404': *6 x-github: githubCloudOnly: false @@ -55801,9 +56167,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: false content: @@ -55839,9 +56205,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - default: *248 + default: *260 '422': *15 x-github: githubCloudOnly: false @@ -55862,9 +56228,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: false content: @@ -55900,9 +56266,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - default: *248 + default: *260 '422': *15 x-github: githubCloudOnly: false @@ -55923,9 +56289,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: content: application/json: @@ -55960,9 +56326,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - default: *248 + default: *260 '422': *15 x-github: githubCloudOnly: false @@ -55984,9 +56350,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: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response @@ -55996,7 +56362,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 '404': *6 x-github: githubCloudOnly: false @@ -56020,9 +56386,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: true content: @@ -56055,7 +56421,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 '422': *15 x-github: githubCloudOnly: false @@ -56080,9 +56446,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: true content: @@ -56115,7 +56481,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 '422': *15 x-github: githubCloudOnly: false @@ -56140,9 +56506,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: true content: @@ -56175,7 +56541,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 '422': *15 x-github: githubCloudOnly: false @@ -56202,9 +56568,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: true content: @@ -56226,7 +56592,7 @@ paths: description: Response content: application/json: - schema: *381 + schema: *388 examples: default: value: @@ -56342,8 +56708,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -56622,7 +56988,7 @@ paths: description: Response content: application/json: - schema: &383 + schema: &390 title: CheckRun description: A check performed on the code of a given code change type: object @@ -56757,8 +57123,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *382 - deployment: &685 + items: *389 + deployment: &692 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -57045,9 +57411,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *312 - - *313 - - &384 + - *319 + - *320 + - &391 name: check_run_id description: The unique identifier of the check run. in: path @@ -57059,9 +57425,9 @@ paths: description: Response content: application/json: - schema: *383 + schema: *390 examples: - default: &385 + default: &392 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -57161,9 +57527,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *312 - - *313 - - *384 + - *319 + - *320 + - *391 requestBody: required: true content: @@ -57403,9 +57769,9 @@ paths: description: Response content: application/json: - schema: *383 + schema: *390 examples: - default: *385 + default: *392 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57425,9 +57791,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *312 - - *313 - - *384 + - *319 + - *320 + - *391 - *17 - *18 responses: @@ -57539,15 +57905,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *312 - - *313 - - *384 + - *319 + - *320 + - *391 responses: '201': description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -57585,8 +57951,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -57608,7 +57974,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &387 + schema: &394 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -57690,12 +58056,12 @@ paths: type: - array - 'null' - items: *382 + items: *389 app: anyOf: - type: 'null' - *5 - repository: *156 + repository: *168 created_at: type: - string @@ -57706,7 +58072,7 @@ paths: - string - 'null' format: date-time - head_commit: *386 + head_commit: *393 latest_check_runs_count: type: integer check_runs_url: @@ -57734,7 +58100,7 @@ paths: - check_runs_url - pull_requests examples: - default: &388 + default: &395 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -58025,9 +58391,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *387 + schema: *394 examples: - default: *388 + default: *395 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58046,8 +58412,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -58108,7 +58474,7 @@ paths: required: - app_id - setting - repository: *156 + repository: *168 examples: default: value: @@ -58356,9 +58722,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *312 - - *313 - - &389 + - *319 + - *320 + - &396 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -58370,9 +58736,9 @@ paths: description: Response content: application/json: - schema: *387 + schema: *394 examples: - default: *388 + default: *395 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58395,17 +58761,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: - - *312 - - *313 - - *389 - - &432 + - *319 + - *320 + - *396 + - &439 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &433 + - &440 name: status description: Returns check runs with the specified `status`. in: query @@ -58444,9 +58810,9 @@ paths: type: integer check_runs: type: array - items: *383 + items: *390 examples: - default: &434 + default: &441 value: total_count: 1 check_runs: @@ -58548,15 +58914,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *312 - - *313 - - *389 + - *319 + - *320 + - *396 responses: '201': description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -58583,21 +58949,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: - - *312 - - *313 - - *179 - - *180 + - *319 + - *320 + - *191 + - *192 - *18 - *17 - - &401 + - &408 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: *390 - - &402 + schema: *397 + - &409 name: pr description: The number of the pull request for the results you want to list. in: query @@ -58622,13 +58988,13 @@ paths: be returned. in: query required: false - schema: *181 + schema: *193 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *391 + schema: *398 responses: '200': description: Response @@ -58644,7 +59010,7 @@ paths: updated_at: *88 url: *85 html_url: *86 - instances_url: *392 + instances_url: *399 state: *79 fixed_at: *90 dismissed_by: @@ -58652,11 +59018,11 @@ paths: - type: 'null' - *4 dismissed_at: *89 - dismissed_reason: *393 - dismissed_comment: *394 - rule: *395 - tool: *396 - most_recent_instance: *397 + dismissed_reason: *400 + dismissed_comment: *401 + rule: *402 + tool: *403 + most_recent_instance: *404 required: - number - created_at @@ -58772,14 +59138,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &398 + '403': &405 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58799,9 +59165,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: - - *312 - - *313 - - &399 + - *319 + - *320 + - &406 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -58815,7 +59181,7 @@ paths: description: Response content: application/json: - schema: &400 + schema: &407 type: object properties: number: *81 @@ -58823,7 +59189,7 @@ paths: updated_at: *88 url: *85 html_url: *86 - instances_url: *392 + instances_url: *399 state: *79 fixed_at: *90 dismissed_by: @@ -58831,8 +59197,8 @@ paths: - type: 'null' - *4 dismissed_at: *89 - dismissed_reason: *393 - dismissed_comment: *394 + dismissed_reason: *400 + dismissed_comment: *401 rule: type: object properties: @@ -58894,8 +59260,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *396 - most_recent_instance: *397 + tool: *403 + most_recent_instance: *404 required: - number - created_at @@ -58984,9 +59350,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *398 + '403': *405 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59004,9 +59370,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: - - *312 - - *313 - - *399 + - *319 + - *320 + - *406 requestBody: required: true content: @@ -59021,8 +59387,8 @@ paths: enum: - open - dismissed - dismissed_reason: *393 - dismissed_comment: *394 + dismissed_reason: *400 + dismissed_comment: *401 required: - state examples: @@ -59037,7 +59403,7 @@ paths: description: Response content: application/json: - schema: *400 + schema: *407 examples: default: value: @@ -59112,14 +59478,14 @@ paths: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '403': &407 + '403': &414 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *96 + '503': *108 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -59139,13 +59505,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: - - *312 - - *313 - - *399 + - *319 + - *320 + - *406 - *18 - *17 - - *401 - - *402 + - *408 + - *409 responses: '200': description: Response @@ -59153,7 +59519,7 @@ paths: application/json: schema: type: array - items: *397 + items: *404 examples: default: value: @@ -59192,9 +59558,9 @@ paths: end_column: 50 classifications: - source - '403': *398 + '403': *405 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59226,25 +59592,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: - - *312 - - *313 - - *179 - - *180 + - *319 + - *320 + - *191 + - *192 - *18 - *17 - - *402 + - *409 - 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: *390 + schema: *397 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &405 + schema: &412 type: string description: An identifier for the upload. examples: @@ -59266,23 +59632,23 @@ paths: application/json: schema: type: array - items: &406 + items: &413 type: object properties: - ref: *390 - commit_sha: &415 + ref: *397 + commit_sha: &422 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: *403 + analysis_key: *410 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *404 + category: *411 error: type: string examples: @@ -59307,8 +59673,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *405 - tool: *396 + sarif_id: *412 + tool: *403 deletable: type: boolean warning: @@ -59370,9 +59736,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *398 + '403': *405 '404': *6 - '503': *96 + '503': *108 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -59406,8 +59772,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: - - *312 - - *313 + - *319 + - *320 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -59420,7 +59786,7 @@ paths: description: Response content: application/json: - schema: *406 + schema: *413 examples: response: summary: application/json response @@ -59474,9 +59840,9 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *398 + '403': *405 '404': *6 - '503': *96 + '503': *108 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -59556,8 +59922,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: - - *312 - - *313 + - *319 + - *320 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -59613,9 +59979,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *407 + '403': *414 '404': *6 - '503': *96 + '503': *108 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -59635,8 +60001,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -59644,7 +60010,7 @@ paths: application/json: schema: type: array - items: &408 + items: &415 title: CodeQL Database description: A CodeQL database. type: object @@ -59756,9 +60122,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': *398 + '403': *405 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59785,8 +60151,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: - - *312 - - *313 + - *319 + - *320 - name: language in: path description: The language of the CodeQL database. @@ -59798,7 +60164,7 @@ paths: description: Response content: application/json: - schema: *408 + schema: *415 examples: default: value: @@ -59830,11 +60196,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': &439 + '302': &446 description: Found - '403': *398 + '403': *405 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59854,8 +60220,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *312 - - *313 + - *319 + - *320 - name: language in: path description: The language of the CodeQL database. @@ -59865,9 +60231,9 @@ paths: responses: '204': description: Response - '403': *407 + '403': *414 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59893,8 +60259,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -59903,7 +60269,7 @@ paths: type: object additionalProperties: false properties: - language: &409 + language: &416 type: string description: The language targeted by the CodeQL query enum: @@ -59981,7 +60347,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &413 + schema: &420 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -59991,7 +60357,7 @@ paths: description: The ID of the variant analysis. controller_repo: *91 actor: *4 - query_language: *409 + query_language: *416 query_pack_url: type: string description: The download url for the query pack. @@ -60039,7 +60405,7 @@ paths: items: type: object properties: - repository: &410 + repository: &417 title: Repository Identifier description: Repository Identifier type: object @@ -60081,7 +60447,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &414 + analysis_status: &421 type: string description: The new status of the CodeQL variant analysis repository task. @@ -60113,7 +60479,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &411 + access_mismatch_repos: &418 type: object properties: repository_count: @@ -60128,7 +60494,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: *410 + items: *417 required: - repository_count - repositories @@ -60151,8 +60517,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *411 - over_limit_repos: *411 + no_codeql_db_repos: *418 + over_limit_repos: *418 required: - access_mismatch_repos - not_found_repos @@ -60168,7 +60534,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &412 + value: &419 summary: Default response value: id: 1 @@ -60320,17 +60686,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *412 + value: *419 repository_lists: summary: Response for a successful variant analysis submission - value: *412 + value: *419 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60351,8 +60717,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: - - *312 - - *313 + - *319 + - *320 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -60364,11 +60730,11 @@ paths: description: Response content: application/json: - schema: *413 + schema: *420 examples: - default: *412 + default: *419 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60389,7 +60755,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: - - *312 + - *319 - name: repo in: path description: The name of the controller repository. @@ -60424,7 +60790,7 @@ paths: type: object properties: repository: *91 - analysis_status: *414 + analysis_status: *421 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -60528,7 +60894,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60549,8 +60915,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -60615,9 +60981,9 @@ paths: query_suite: default updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *398 + '403': *405 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60636,8 +61002,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -60695,7 +61061,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -60720,7 +61086,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *407 + '403': *414 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -60728,7 +61094,7 @@ paths: content: application/json: schema: *3 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60785,8 +61151,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -60794,7 +61160,7 @@ paths: schema: type: object properties: - commit_sha: *415 + commit_sha: *422 ref: type: string description: |- @@ -60854,7 +61220,7 @@ paths: schema: type: object properties: - id: *405 + id: *412 url: type: string description: The REST API URL for checking the status of the upload. @@ -60868,11 +61234,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': *407 + '403': *414 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *96 + '503': *108 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -60891,8 +61257,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: - - *312 - - *313 + - *319 + - *320 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -60940,10 +61306,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': *398 + '403': *405 '404': description: Not Found if the sarif id does not match any upload - '503': *96 + '503': *108 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -60965,8 +61331,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -60990,7 +61356,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *184 + configuration: *196 examples: default: value: @@ -61019,7 +61385,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': *185 + '204': *197 '304': *35 '403': *27 '404': *6 @@ -61044,8 +61410,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *312 - - *313 + - *319 + - *320 - 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 @@ -61173,8 +61539,8 @@ paths: parameters: - *17 - *18 - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -61190,7 +61556,7 @@ paths: type: integer codespaces: type: array - items: *238 + items: *250 examples: default: value: @@ -61488,8 +61854,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -61553,22 +61919,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '400': *14 '401': *23 '403': *27 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -61592,8 +61958,8 @@ paths: parameters: - *17 - *18 - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -61657,8 +62023,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: - - *312 - - *313 + - *319 + - *320 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -61695,9 +62061,9 @@ paths: type: integer machines: type: array - items: *417 + items: *424 examples: - default: &642 + default: &649 value: total_count: 2 machines: @@ -61737,8 +62103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *312 - - *313 + - *319 + - *320 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -61825,8 +62191,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: - - *312 - - *313 + - *319 + - *320 - 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 @@ -61874,7 +62240,7 @@ paths: '403': *27 '404': *6 '422': *15 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61895,8 +62261,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -61914,7 +62280,7 @@ paths: type: integer secrets: type: array - items: &421 + items: &428 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -61935,7 +62301,7 @@ paths: - created_at - updated_at examples: - default: *418 + default: *425 headers: Link: *37 x-github: @@ -61958,16 +62324,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: *419 + schema: *426 examples: - default: *420 + default: *427 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -61987,17 +62353,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 responses: '200': description: Response content: application/json: - schema: *421 + schema: *428 examples: - default: *422 + default: *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62017,9 +62383,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: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 requestBody: required: true content: @@ -62047,7 +62413,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -62071,9 +62437,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 responses: '204': description: Response @@ -62101,8 +62467,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *312 - - *313 + - *319 + - *320 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -62140,7 +62506,7 @@ paths: application/json: schema: type: array - items: &423 + items: &430 title: Collaborator description: Collaborator type: object @@ -62333,9 +62699,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: - - *312 - - *313 - - *178 + - *319 + - *320 + - *190 responses: '204': description: Response if user is a collaborator @@ -62377,9 +62743,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *312 - - *313 - - *178 + - *319 + - *320 + - *190 requestBody: required: false content: @@ -62405,7 +62771,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &487 + schema: &494 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -62417,7 +62783,7 @@ paths: format: int64 examples: - 42 - repository: *156 + repository: *168 invitee: anyOf: - type: 'null' @@ -62626,9 +62992,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *312 - - *313 - - *178 + - *319 + - *320 + - *190 responses: '204': description: No Content when collaborator was removed from the repository. @@ -62657,9 +63023,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *312 - - *313 - - *178 + - *319 + - *320 + - *190 responses: '200': description: if user has admin permissions @@ -62679,7 +63045,7 @@ paths: user: anyOf: - type: 'null' - - *423 + - *430 required: - permission - role_name @@ -62733,8 +63099,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -62744,7 +63110,7 @@ paths: application/json: schema: type: array - items: &424 + items: &431 title: Commit Comment description: Commit Comment type: object @@ -62785,8 +63151,8 @@ paths: updated_at: type: string format: date-time - author_association: *103 - reactions: *104 + author_association: *115 + reactions: *116 required: - url - html_url @@ -62802,7 +63168,7 @@ paths: - created_at - updated_at examples: - default: &427 + default: &434 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -62861,17 +63227,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 responses: '200': description: Response content: application/json: - schema: *424 + schema: *431 examples: - default: &428 + default: &435 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -62928,9 +63294,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 requestBody: required: true content: @@ -62952,7 +63318,7 @@ paths: description: Response content: application/json: - schema: *424 + schema: *431 examples: default: value: @@ -63003,9 +63369,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 responses: '204': description: Response @@ -63026,9 +63392,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 - 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. @@ -63054,9 +63420,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *303 + default: *310 headers: Link: *37 '404': *6 @@ -63077,9 +63443,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 requestBody: required: true content: @@ -63111,16 +63477,16 @@ paths: description: Reaction exists content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '201': description: Reaction created content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '422': *15 x-github: githubCloudOnly: false @@ -63142,10 +63508,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *312 - - *313 - - *115 - - *304 + - *319 + - *320 + - *127 + - *311 responses: '204': description: Response @@ -63194,8 +63560,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *312 - - *313 + - *319 + - *320 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -63251,9 +63617,9 @@ paths: application/json: schema: type: array - items: *425 + items: *432 examples: - default: &535 + default: &542 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -63327,7 +63693,7 @@ paths: '500': *80 '400': *14 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63347,9 +63713,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *312 - - *313 - - &426 + - *319 + - *320 + - &433 name: commit_sha description: The SHA of the commit. in: path @@ -63396,7 +63762,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63421,9 +63787,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *312 - - *313 - - *426 + - *319 + - *320 + - *433 - *17 - *18 responses: @@ -63433,9 +63799,9 @@ paths: application/json: schema: type: array - items: *424 + items: *431 examples: - default: *427 + default: *434 headers: Link: *37 x-github: @@ -63463,9 +63829,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *312 - - *313 - - *426 + - *319 + - *320 + - *433 requestBody: required: true content: @@ -63500,9 +63866,9 @@ paths: description: Response content: application/json: - schema: *424 + schema: *431 examples: - default: *428 + default: *435 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -63530,9 +63896,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: - - *312 - - *313 - - *426 + - *319 + - *320 + - *433 - *17 - *18 responses: @@ -63542,7 +63908,7 @@ paths: application/json: schema: type: array - items: &526 + items: &533 title: Pull Request Simple description: Pull Request Simple type: object @@ -63662,7 +64028,7 @@ paths: milestone: anyOf: - type: 'null' - - *429 + - *436 active_lock_reason: type: - string @@ -63717,7 +64083,7 @@ paths: type: - array - 'null' - items: *234 + items: *246 head: type: object properties: @@ -63761,7 +64127,7 @@ paths: _links: type: object properties: - comments: &430 + comments: &437 title: Link description: Hypermedia Link type: object @@ -63770,13 +64136,13 @@ paths: type: string required: - href - commits: *430 - statuses: *430 - html: *430 - issue: *430 - review_comments: *430 - review_comment: *430 - self: *430 + commits: *437 + statuses: *437 + html: *437 + issue: *437 + review_comments: *437 + review_comment: *437 + self: *437 required: - comments - commits @@ -63786,8 +64152,8 @@ paths: - review_comments - review_comment - self - author_association: *103 - auto_merge: &528 + author_association: *115 + auto_merge: &535 title: Auto merge description: The status of auto merging a pull request. type: @@ -63852,7 +64218,7 @@ paths: - author_association - auto_merge examples: - default: &527 + default: &534 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -64332,7 +64698,7 @@ paths: draft: false headers: Link: *37 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64389,11 +64755,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *312 - - *313 + - *319 + - *320 - *18 - *17 - - &431 + - &438 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)" @@ -64408,9 +64774,9 @@ paths: description: Response content: application/json: - schema: *425 + schema: *432 examples: - default: &514 + default: &521 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -64497,8 +64863,8 @@ paths: '422': *15 '404': *6 '500': *80 - '503': *96 - '409': *143 + '503': *108 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64523,11 +64889,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: - - *312 - - *313 - - *431 - - *432 - - *433 + - *319 + - *320 + - *438 + - *439 + - *440 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -64561,9 +64927,9 @@ paths: type: integer check_runs: type: array - items: *383 + items: *390 examples: - default: *434 + default: *441 headers: Link: *37 x-github: @@ -64588,9 +64954,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: - - *312 - - *313 - - *431 + - *319 + - *320 + - *438 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -64598,7 +64964,7 @@ paths: schema: type: integer example: 1 - - *432 + - *439 - *17 - *18 responses: @@ -64616,7 +64982,7 @@ paths: type: integer check_suites: type: array - items: *387 + items: *394 examples: default: value: @@ -64816,9 +65182,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: - - *312 - - *313 - - *431 + - *319 + - *320 + - *438 - *17 - *18 responses: @@ -64889,7 +65255,7 @@ paths: type: string total_count: type: integer - repository: *156 + repository: *168 commit_url: type: string format: uri @@ -65020,9 +65386,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *312 - - *313 - - *431 + - *319 + - *320 + - *438 - *17 - *18 responses: @@ -65032,7 +65398,7 @@ paths: application/json: schema: type: array - items: &590 + items: &597 title: Status description: The status of a commit. type: object @@ -65113,7 +65479,7 @@ paths: site_admin: false headers: Link: *37 - '301': *326 + '301': *333 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65141,8 +65507,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -65175,11 +65541,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *435 + - *442 code_of_conduct_file: anyOf: - type: 'null' - - &436 + - &443 title: Community Health File type: object properties: @@ -65195,23 +65561,23 @@ paths: license: anyOf: - type: 'null' - - *117 + - *129 contributing: anyOf: - type: 'null' - - *436 + - *443 readme: anyOf: - type: 'null' - - *436 + - *443 issue_template: anyOf: - type: 'null' - - *436 + - *443 pull_request_template: anyOf: - type: 'null' - - *436 + - *443 required: - code_of_conduct - code_of_conduct_file @@ -65340,8 +65706,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *312 - - *313 + - *319 + - *320 - *18 - *17 - name: basehead @@ -65389,8 +65755,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *425 - merge_base_commit: *425 + base_commit: *432 + merge_base_commit: *432 status: type: string enum: @@ -65414,10 +65780,10 @@ paths: - 6 commits: type: array - items: *425 + items: *432 files: type: array - items: *437 + items: *444 required: - url - html_url @@ -65661,7 +66027,7 @@ paths: module Test" '404': *6 '500': *80 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65703,8 +66069,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *312 - - *313 + - *319 + - *320 - name: path description: path parameter in: path @@ -65855,7 +66221,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &438 + response-if-content-is-a-file: &445 summary: Response if content is a file value: type: file @@ -65992,7 +66358,7 @@ paths: - size - type - url - - &540 + - &547 title: Content File description: Content File type: object @@ -66210,7 +66576,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *438 + response-if-content-is-a-file: *445 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -66279,7 +66645,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *439 + '302': *446 '304': *35 x-github: githubCloudOnly: false @@ -66302,8 +66668,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *312 - - *313 + - *319 + - *320 - name: path description: path parameter in: path @@ -66398,7 +66764,7 @@ paths: description: Response content: application/json: - schema: &440 + schema: &447 title: File Commit description: File Commit type: object @@ -66554,7 +66920,7 @@ paths: description: Response content: application/json: - schema: *440 + schema: *447 examples: example-for-creating-a-file: value: @@ -66608,7 +66974,7 @@ paths: schema: oneOf: - *3 - - &469 + - &476 description: Repository rule violation was detected type: object properties: @@ -66629,7 +66995,7 @@ paths: items: type: object properties: - placeholder_id: &582 + placeholder_id: &589 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -66661,8 +67027,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *312 - - *313 + - *319 + - *320 - name: path description: path parameter in: path @@ -66723,7 +67089,7 @@ paths: description: Response content: application/json: - schema: *440 + schema: *447 examples: default: value: @@ -66757,8 +67123,8 @@ paths: verified_at: '422': *15 '404': *6 - '409': *143 - '503': *96 + '409': *155 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66778,8 +67144,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *312 - - *313 + - *319 + - *320 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -66903,20 +67269,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *312 - - *313 - - *198 - - *199 - - *200 - - *201 + - *319 + - *320 + - *210 + - *211 + - *212 + - *213 - 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 - - *202 - - *203 + - *214 + - *215 - *76 - name: page description: "**Closing down notice**. Page number of the results to fetch. @@ -66936,8 +67302,8 @@ paths: default: 30 - *74 - *75 - - *204 - - *205 + - *216 + - *217 responses: '200': description: Response @@ -66945,7 +67311,7 @@ paths: application/json: schema: type: array - items: &443 + items: &450 type: object description: A Dependabot alert. properties: @@ -66980,7 +67346,7 @@ paths: - development - runtime - - security_advisory: *441 + security_advisory: *448 security_vulnerability: *84 url: *85 html_url: *86 @@ -67011,7 +67377,7 @@ paths: dismissal. maxLength: 280 fixed_at: *90 - auto_dismissed_at: *442 + auto_dismissed_at: *449 required: - number - state @@ -67238,9 +67604,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *312 - - *313 - - &444 + - *319 + - *320 + - &451 name: alert_number in: path description: |- @@ -67255,7 +67621,7 @@ paths: description: Response content: application/json: - schema: *443 + schema: *450 examples: default: value: @@ -67365,9 +67731,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *312 - - *313 - - *444 + - *319 + - *320 + - *451 requestBody: required: true content: @@ -67412,7 +67778,7 @@ paths: description: Response content: application/json: - schema: *443 + schema: *450 examples: default: value: @@ -67518,7 +67884,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *143 + '409': *155 '422': *7 x-github: githubCloudOnly: false @@ -67541,8 +67907,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -67560,7 +67926,7 @@ paths: type: integer secrets: type: array - items: &447 + items: &454 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -67614,16 +67980,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: *445 + schema: *452 examples: - default: *446 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67643,15 +68009,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 responses: '200': description: Response content: application/json: - schema: *447 + schema: *454 examples: default: value: @@ -67677,9 +68043,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 requestBody: required: true content: @@ -67707,7 +68073,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -67731,9 +68097,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 responses: '204': description: Response @@ -67755,8 +68121,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: - - *312 - - *313 + - *319 + - *320 - 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 @@ -67930,8 +68296,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -68191,8 +68557,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -68275,7 +68641,7 @@ paths: - version - url additionalProperties: false - metadata: &448 + metadata: &455 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -68314,7 +68680,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *448 + metadata: *455 resolved: type: object description: A collection of resolved package dependencies. @@ -68328,7 +68694,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *448 + metadata: *455 relationship: type: string description: A notation of whether a dependency is requested @@ -68461,8 +68827,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *312 - - *313 + - *319 + - *320 - name: sha description: The SHA recorded at creation time. in: query @@ -68503,9 +68869,9 @@ paths: application/json: schema: type: array - items: *449 + items: *456 examples: - default: *450 + default: *457 headers: Link: *37 x-github: @@ -68571,8 +68937,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -68654,7 +69020,7 @@ paths: description: Response content: application/json: - schema: *449 + schema: *456 examples: simple-example: summary: Simple example @@ -68727,9 +69093,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *312 - - *313 - - &451 + - *319 + - *320 + - &458 name: deployment_id description: deployment_id parameter in: path @@ -68741,7 +69107,7 @@ paths: description: Response content: application/json: - schema: *449 + schema: *456 examples: default: value: @@ -68806,9 +69172,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *312 - - *313 - - *451 + - *319 + - *320 + - *458 responses: '204': description: Response @@ -68830,9 +69196,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *312 - - *313 - - *451 + - *319 + - *320 + - *458 - *17 - *18 responses: @@ -68842,7 +69208,7 @@ paths: application/json: schema: type: array - items: &452 + items: &459 title: Deployment Status description: The status of a deployment. type: object @@ -69006,9 +69372,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *312 - - *313 - - *451 + - *319 + - *320 + - *458 requestBody: required: true content: @@ -69083,9 +69449,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *459 examples: - default: &453 + default: &460 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -69141,9 +69507,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *312 - - *313 - - *451 + - *319 + - *320 + - *458 - name: status_id in: path required: true @@ -69154,9 +69520,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *459 examples: - default: *453 + default: *460 '404': *6 x-github: githubCloudOnly: false @@ -69181,8 +69547,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -69239,8 +69605,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -69258,7 +69624,7 @@ paths: - 5 environments: type: array - items: &455 + items: &462 title: Environment description: Details of a deployment environment type: object @@ -69320,7 +69686,7 @@ paths: type: string examples: - wait_timer - wait_timer: &457 + wait_timer: &464 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -69362,11 +69728,11 @@ paths: items: type: object properties: - type: *454 + type: *461 reviewer: anyOf: - *4 - - *234 + - *246 required: - id - node_id @@ -69389,7 +69755,7 @@ paths: - id - node_id - type - deployment_branch_policy: &458 + deployment_branch_policy: &465 type: - object - 'null' @@ -69506,9 +69872,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *312 - - *313 - - &456 + - *319 + - *320 + - &463 name: environment_name in: path required: true @@ -69521,9 +69887,9 @@ paths: description: Response content: application/json: - schema: *455 + schema: *462 examples: - default: &459 + default: &466 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -69607,9 +69973,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *312 - - *313 - - *456 + - *319 + - *320 + - *463 requestBody: required: false content: @@ -69619,7 +69985,7 @@ paths: - object - 'null' properties: - wait_timer: *457 + wait_timer: *464 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -69638,14 +70004,14 @@ paths: items: type: object properties: - type: *454 + type: *461 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *458 + deployment_branch_policy: *465 additionalProperties: false examples: default: @@ -69665,9 +70031,9 @@ paths: description: Response content: application/json: - schema: *455 + schema: *462 examples: - default: *459 + default: *466 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -69691,9 +70057,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *312 - - *313 - - *456 + - *319 + - *320 + - *463 responses: '204': description: Default response @@ -69718,9 +70084,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *312 - - *313 - - *456 + - *319 + - *320 + - *463 - *17 - *18 responses: @@ -69739,7 +70105,7 @@ paths: - 2 branch_policies: type: array - items: &460 + items: &467 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -69800,9 +70166,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *312 - - *313 - - *456 + - *319 + - *320 + - *463 requestBody: required: true content: @@ -69850,9 +70216,9 @@ paths: description: Response content: application/json: - schema: *460 + schema: *467 examples: - example-wildcard: &461 + example-wildcard: &468 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -69894,10 +70260,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *312 - - *313 - - *456 - - &462 + - *319 + - *320 + - *463 + - &469 name: branch_policy_id in: path required: true @@ -69909,9 +70275,9 @@ paths: description: Response content: application/json: - schema: *460 + schema: *467 examples: - default: *461 + default: *468 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69930,10 +70296,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *312 - - *313 - - *456 - - *462 + - *319 + - *320 + - *463 + - *469 requestBody: required: true content: @@ -69962,9 +70328,9 @@ paths: description: Response content: application/json: - schema: *460 + schema: *467 examples: - default: *461 + default: *468 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69983,10 +70349,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *312 - - *313 - - *456 - - *462 + - *319 + - *320 + - *463 + - *469 responses: '204': description: Response @@ -70011,9 +70377,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: - - *456 - - *313 - - *312 + - *463 + - *320 + - *319 responses: '200': description: List of deployment protection rules @@ -70030,7 +70396,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &463 + items: &470 title: Deployment protection rule description: Deployment protection rule type: object @@ -70052,7 +70418,7 @@ paths: for the environment. examples: - true - app: &464 + app: &471 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -70155,9 +70521,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: - - *456 - - *313 - - *312 + - *463 + - *320 + - *319 requestBody: content: application/json: @@ -70178,9 +70544,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *463 + schema: *470 examples: - default: &465 + default: &472 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -70215,9 +70581,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: - - *456 - - *313 - - *312 + - *463 + - *320 + - *319 - *18 - *17 responses: @@ -70237,7 +70603,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *464 + items: *471 examples: default: value: @@ -70272,10 +70638,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: - - *312 - - *313 - - *456 - - &466 + - *319 + - *320 + - *463 + - &473 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -70287,9 +70653,9 @@ paths: description: Response content: application/json: - schema: *463 + schema: *470 examples: - default: *465 + default: *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70310,10 +70676,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: - - *456 - - *313 - - *312 - - *466 + - *463 + - *320 + - *319 + - *473 responses: '204': description: Response @@ -70339,9 +70705,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *312 - - *313 - - *456 + - *319 + - *320 + - *463 - *17 - *18 responses: @@ -70359,9 +70725,9 @@ paths: type: integer secrets: type: array - items: *349 + items: *356 examples: - default: *350 + default: *357 headers: Link: *37 x-github: @@ -70386,17 +70752,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *312 - - *313 - - *456 + - *319 + - *320 + - *463 responses: '200': description: Response content: application/json: - schema: *351 + schema: *358 examples: - default: *352 + default: *359 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70418,18 +70784,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *312 - - *313 - - *456 - - *166 + - *319 + - *320 + - *463 + - *178 responses: '200': description: Response content: application/json: - schema: *349 + schema: *356 examples: - default: *467 + default: *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70451,10 +70817,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *312 - - *313 - - *456 - - *166 + - *319 + - *320 + - *463 + - *178 requestBody: required: true content: @@ -70485,7 +70851,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -70511,10 +70877,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *312 - - *313 - - *456 - - *166 + - *319 + - *320 + - *463 + - *178 responses: '204': description: Default response @@ -70539,10 +70905,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *312 - - *313 - - *456 - - *336 + - *319 + - *320 + - *463 + - *343 - *18 responses: '200': @@ -70559,9 +70925,9 @@ paths: type: integer variables: type: array - items: *353 + items: *360 examples: - default: *354 + default: *361 headers: Link: *37 x-github: @@ -70584,9 +70950,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *312 - - *313 - - *456 + - *319 + - *320 + - *463 requestBody: required: true content: @@ -70613,7 +70979,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -70638,18 +71004,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *312 - - *313 - - *456 - - *169 + - *319 + - *320 + - *463 + - *181 responses: '200': description: Response content: application/json: - schema: *353 + schema: *360 examples: - default: *468 + default: *475 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70670,10 +71036,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *312 - - *313 - - *169 - - *456 + - *319 + - *320 + - *181 + - *463 requestBody: required: true content: @@ -70715,10 +71081,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *312 - - *313 - - *169 - - *456 + - *319 + - *320 + - *181 + - *463 responses: '204': description: Response @@ -70740,8 +71106,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -70751,7 +71117,7 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: 200-response: value: @@ -70818,8 +71184,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *312 - - *313 + - *319 + - *320 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -70841,7 +71207,7 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: default: value: @@ -70978,8 +71344,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: false content: @@ -71012,9 +71378,9 @@ paths: description: Response content: application/json: - schema: *325 + schema: *332 examples: - default: *327 + default: *334 '400': *14 '422': *15 '403': *27 @@ -71035,8 +71401,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -71087,7 +71453,7 @@ paths: schema: type: string '404': *6 - '409': *143 + '409': *155 '403': *27 '422': description: Validation failed @@ -71095,8 +71461,8 @@ paths: application/json: schema: oneOf: - - *141 - - *469 + - *153 + - *476 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71121,8 +71487,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *312 - - *313 + - *319 + - *320 - name: file_sha in: path required: true @@ -71174,7 +71540,7 @@ paths: '404': *6 '422': *15 '403': *27 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71222,8 +71588,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -71332,7 +71698,7 @@ paths: description: Response content: application/json: - schema: &470 + schema: &477 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -71508,7 +71874,7 @@ paths: type: string '422': *15 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71558,15 +71924,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *312 - - *313 - - *426 + - *319 + - *320 + - *433 responses: '200': description: Response content: application/json: - schema: *470 + schema: *477 examples: default: value: @@ -71597,7 +71963,7 @@ paths: payload: verified_at: '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71622,9 +71988,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *312 - - *313 - - &471 + - *319 + - *320 + - &478 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. @@ -71641,7 +72007,7 @@ paths: application/json: schema: type: array - items: &472 + items: &479 title: Git Reference description: Git references within a repository type: object @@ -71696,7 +72062,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *37 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71717,17 +72083,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *312 - - *313 - - *471 + - *319 + - *320 + - *478 responses: '200': description: Response content: application/json: - schema: *472 + schema: *479 examples: - default: &473 + default: &480 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -71737,7 +72103,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71756,8 +72122,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -71786,16 +72152,16 @@ paths: description: Response content: application/json: - schema: *472 + schema: *479 examples: - default: *473 + default: *480 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71814,9 +72180,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *312 - - *313 - - *471 + - *319 + - *320 + - *478 requestBody: required: true content: @@ -71845,11 +72211,11 @@ paths: description: Response content: application/json: - schema: *472 + schema: *479 examples: - default: *473 + default: *480 '422': *15 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71865,14 +72231,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *312 - - *313 - - *471 + - *319 + - *320 + - *478 responses: '204': description: Response '422': *15 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71920,8 +72286,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -71988,7 +72354,7 @@ paths: description: Response content: application/json: - schema: &475 + schema: &482 title: Git Tag description: Metadata for a Git tag type: object @@ -72044,7 +72410,7 @@ paths: - sha - type - url - verification: *474 + verification: *481 required: - sha - url @@ -72054,7 +72420,7 @@ paths: - tag - message examples: - default: &476 + default: &483 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -72081,7 +72447,7 @@ paths: schema: type: string '422': *15 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72127,8 +72493,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *312 - - *313 + - *319 + - *320 - name: tag_sha in: path required: true @@ -72139,11 +72505,11 @@ paths: description: Response content: application/json: - schema: *475 + schema: *482 examples: - default: *476 + default: *483 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72165,8 +72531,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -72240,7 +72606,7 @@ paths: description: Response content: application/json: - schema: &477 + schema: &484 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -72335,7 +72701,7 @@ paths: '422': *15 '404': *6 '403': *27 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72358,8 +72724,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *312 - - *313 + - *319 + - *320 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -72382,7 +72748,7 @@ paths: description: Response content: application/json: - schema: *477 + schema: *484 examples: default-response: summary: Default response @@ -72423,7 +72789,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72441,8 +72807,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -72452,7 +72818,7 @@ paths: application/json: schema: type: array - items: &478 + items: &485 title: Webhook description: Webhooks for repositories. type: object @@ -72515,7 +72881,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &716 + last_response: &723 title: Hook Response type: object properties: @@ -72592,8 +72958,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: false content: @@ -72646,9 +73012,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *485 examples: - default: &479 + default: &486 value: type: Repository id: 12345678 @@ -72696,17 +73062,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 responses: '200': description: Response content: application/json: - schema: *478 + schema: *485 examples: - default: *479 + default: *486 '404': *6 x-github: githubCloudOnly: false @@ -72726,9 +73092,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 requestBody: required: true content: @@ -72773,9 +73139,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *485 examples: - default: *479 + default: *486 '422': *15 '404': *6 x-github: @@ -72796,9 +73162,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 responses: '204': description: Response @@ -72822,9 +73188,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: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 responses: '200': description: Response @@ -72851,9 +73217,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: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 requestBody: required: false content: @@ -72897,11 +73263,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 - *17 - - *212 + - *224 responses: '200': description: Response @@ -72909,9 +73275,9 @@ paths: application/json: schema: type: array - items: *213 + items: *225 examples: - default: *214 + default: *226 '400': *14 '422': *15 x-github: @@ -72930,18 +73296,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: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 - *16 responses: '200': description: Response content: application/json: - schema: *215 + schema: *227 examples: - default: *216 + default: *228 '400': *14 '422': *15 x-github: @@ -72960,12 +73326,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: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 - *16 responses: - '202': *144 + '202': *156 '400': *14 '422': *15 x-github: @@ -72985,9 +73351,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 responses: '204': description: Response @@ -73012,9 +73378,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 responses: '204': description: Response @@ -73072,14 +73438,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: &480 + schema: &487 title: Import description: A repository import from an external source. type: object @@ -73186,7 +73552,7 @@ paths: - html_url - authors_url examples: - default: &483 + default: &490 value: vcs: subversion use_lfs: true @@ -73202,7 +73568,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &481 + '503': &488 description: Unavailable due to service under maintenance. content: application/json: @@ -73231,8 +73597,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -73280,7 +73646,7 @@ paths: description: Response content: application/json: - schema: *480 + schema: *487 examples: default: value: @@ -73305,7 +73671,7 @@ paths: type: string '422': *15 '404': *6 - '503': *481 + '503': *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73333,8 +73699,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: false content: @@ -73386,7 +73752,7 @@ paths: description: Response content: application/json: - schema: *480 + schema: *487 examples: example-1: summary: Example 1 @@ -73434,7 +73800,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': *481 + '503': *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73457,12 +73823,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response - '503': *481 + '503': *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73488,9 +73854,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *312 - - *313 - - &665 + - *319 + - *320 + - &672 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -73504,7 +73870,7 @@ paths: application/json: schema: type: array - items: &482 + items: &489 title: Porter Author description: Porter Author type: object @@ -73558,7 +73924,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *481 + '503': *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73583,8 +73949,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *312 - - *313 + - *319 + - *320 - name: author_id in: path required: true @@ -73614,7 +73980,7 @@ paths: description: Response content: application/json: - schema: *482 + schema: *489 examples: default: value: @@ -73627,7 +73993,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *481 + '503': *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73651,8 +74017,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -73693,7 +74059,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *481 + '503': *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73721,8 +74087,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -73749,11 +74115,11 @@ paths: description: Response content: application/json: - schema: *480 + schema: *487 examples: - default: *483 + default: *490 '422': *15 - '503': *481 + '503': *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73776,8 +74142,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -73785,8 +74151,8 @@ paths: application/json: schema: *20 examples: - default: *484 - '301': *326 + default: *491 + '301': *333 '404': *6 x-github: githubCloudOnly: false @@ -73806,8 +74172,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -73815,12 +74181,12 @@ paths: application/json: schema: anyOf: - - *229 + - *241 - type: object properties: {} additionalProperties: false examples: - default: &486 + default: &493 value: limit: collaborators_only origin: repository @@ -73845,13 +74211,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: application/json: - schema: *485 + schema: *492 examples: default: summary: Example request body @@ -73863,9 +74229,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *241 examples: - default: *486 + default: *493 '409': description: Response x-github: @@ -73887,8 +74253,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -73911,8 +74277,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -73922,9 +74288,9 @@ paths: application/json: schema: type: array - items: *487 + items: *494 examples: - default: &658 + default: &665 value: - id: 1 repository: @@ -74055,9 +74421,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *312 - - *313 - - *233 + - *319 + - *320 + - *245 requestBody: required: false content: @@ -74086,7 +74452,7 @@ paths: description: Response content: application/json: - schema: *487 + schema: *494 examples: default: value: @@ -74217,9 +74583,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *312 - - *313 - - *233 + - *319 + - *320 + - *245 responses: '204': description: Response @@ -74250,8 +74616,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *312 - - *313 + - *319 + - *320 - 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 @@ -74291,7 +74657,7 @@ paths: required: false schema: type: string - - *235 + - *247 - name: sort description: What to sort results by. in: query @@ -74304,7 +74670,7 @@ paths: - comments default: created - *76 - - *106 + - *118 - *17 - *18 responses: @@ -74314,9 +74680,9 @@ paths: application/json: schema: type: array - items: *116 + items: *128 examples: - default: &496 + default: &503 value: - id: 1 node_id: MDU6SXNzdWUx @@ -74464,7 +74830,7 @@ paths: state_reason: completed headers: Link: *37 - '301': *326 + '301': *333 '422': *15 '404': *6 x-github: @@ -74493,8 +74859,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -74575,9 +74941,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *128 examples: - default: &491 + default: &498 value: id: 1 node_id: MDU6SXNzdWUx @@ -74731,9 +75097,9 @@ paths: '400': *14 '403': *27 '422': *15 - '503': *96 + '503': *108 '404': *6 - '410': *323 + '410': *330 x-github: triggersNotification: true githubCloudOnly: false @@ -74761,9 +75127,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *312 - - *313 - - *125 + - *319 + - *320 + - *137 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -74773,7 +75139,7 @@ paths: enum: - asc - desc - - *106 + - *118 - *17 - *18 responses: @@ -74783,9 +75149,9 @@ paths: application/json: schema: type: array - items: *488 + items: *495 examples: - default: &493 + default: &500 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -74843,17 +75209,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 responses: '200': description: Response content: application/json: - schema: *488 + schema: *495 examples: - default: &489 + default: &496 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -74907,9 +75273,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 requestBody: required: true content: @@ -74931,9 +75297,9 @@ paths: description: Response content: application/json: - schema: *488 + schema: *495 examples: - default: *489 + default: *496 '422': *15 x-github: githubCloudOnly: false @@ -74951,9 +75317,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 responses: '204': description: Response @@ -74973,9 +75339,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 - 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. @@ -75001,9 +75367,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *303 + default: *310 headers: Link: *37 '404': *6 @@ -75024,9 +75390,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 requestBody: required: true content: @@ -75058,16 +75424,16 @@ paths: description: Reaction exists content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '201': description: Reaction created content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '422': *15 x-github: githubCloudOnly: false @@ -75089,10 +75455,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *312 - - *313 - - *115 - - *304 + - *319 + - *320 + - *127 + - *311 responses: '204': description: Response @@ -75112,8 +75478,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -75123,7 +75489,7 @@ paths: application/json: schema: type: array - items: &490 + items: &497 title: Issue Event description: Issue Event type: object @@ -75170,7 +75536,7 @@ paths: issue: anyOf: - type: 'null' - - *116 + - *128 label: title: Issue Event Label description: Issue Event Label @@ -75203,7 +75569,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *234 + requested_team: *246 dismissed_review: title: Issue Event Dismissed Review type: object @@ -75270,7 +75636,7 @@ paths: required: - from - to - author_association: *103 + author_association: *115 lock_reason: type: - string @@ -75462,8 +75828,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *312 - - *313 + - *319 + - *320 - name: event_id in: path required: true @@ -75474,7 +75840,7 @@ paths: description: Response content: application/json: - schema: *490 + schema: *497 examples: default: value: @@ -75667,7 +76033,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *323 + '410': *330 '403': *27 x-github: githubCloudOnly: false @@ -75701,9 +76067,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *312 - - *313 - - &492 + - *319 + - *320 + - &499 name: issue_number description: The number that identifies the issue. in: path @@ -75715,12 +76081,12 @@ paths: description: Response content: application/json: - schema: *116 + schema: *128 examples: - default: *491 - '301': *326 + default: *498 + '301': *333 '404': *6 - '410': *323 + '410': *330 '304': *35 x-github: githubCloudOnly: false @@ -75745,9 +76111,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: false content: @@ -75855,15 +76221,15 @@ paths: description: Response content: application/json: - schema: *116 + schema: *128 examples: - default: *491 + default: *498 '422': *15 - '503': *96 + '503': *108 '403': *27 - '301': *326 + '301': *333 '404': *6 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75881,9 +76247,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: false content: @@ -75909,9 +76275,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *128 examples: - default: *491 + default: *498 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75927,9 +76293,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: content: application/json: @@ -75954,9 +76320,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *128 examples: - default: *491 + default: *498 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75978,9 +76344,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: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 - name: assignee in: path required: true @@ -76020,10 +76386,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *312 - - *313 - - *492 - - *106 + - *319 + - *320 + - *499 + - *118 - *17 - *18 responses: @@ -76033,13 +76399,13 @@ paths: application/json: schema: type: array - items: *488 + items: *495 examples: - default: *493 + default: *500 headers: Link: *37 '404': *6 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76068,9 +76434,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: true content: @@ -76092,16 +76458,16 @@ paths: description: Response content: application/json: - schema: *488 + schema: *495 examples: - default: *489 + default: *496 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *323 + '410': *330 '422': *15 '404': *6 x-github: @@ -76121,9 +76487,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 - *17 - *18 responses: @@ -76137,7 +76503,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &497 + - &504 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -76186,7 +76552,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &498 + - &505 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -76314,7 +76680,7 @@ paths: - performed_via_github_app - assignee - assigner - - &499 + - &506 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -76360,7 +76726,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &500 + - &507 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -76406,7 +76772,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &501 + - &508 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -76455,7 +76821,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &502 + - &509 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -76484,7 +76850,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *234 + requested_team: *246 requested_reviewer: *4 required: - review_requester @@ -76497,7 +76863,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &503 + - &510 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -76526,7 +76892,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *234 + requested_team: *246 requested_reviewer: *4 required: - review_requester @@ -76539,7 +76905,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &504 + - &511 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -76595,7 +76961,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &505 + - &512 title: Locked Issue Event description: Locked Issue Event type: object @@ -76640,7 +77006,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &506 + - &513 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -76701,7 +77067,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &507 + - &514 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -76762,7 +77128,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &508 + - &515 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -76823,7 +77189,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &509 + - &516 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -76916,7 +77282,7 @@ paths: color: red headers: Link: *37 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76933,9 +77299,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 - *17 - *18 responses: @@ -76945,7 +77311,7 @@ paths: application/json: schema: type: array - items: &494 + items: &501 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -77000,7 +77366,7 @@ paths: - color - default examples: - default: &495 + default: &502 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -77018,9 +77384,9 @@ paths: default: false headers: Link: *37 - '301': *326 + '301': *333 '404': *6 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77037,9 +77403,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: false content: @@ -77098,12 +77464,12 @@ paths: application/json: schema: type: array - items: *494 + items: *501 examples: - default: *495 - '301': *326 + default: *502 + '301': *333 '404': *6 - '410': *323 + '410': *330 '422': *15 x-github: githubCloudOnly: false @@ -77120,9 +77486,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: false content: @@ -77182,12 +77548,12 @@ paths: application/json: schema: type: array - items: *494 + items: *501 examples: - default: *495 - '301': *326 + default: *502 + '301': *333 '404': *6 - '410': *323 + '410': *330 '422': *15 x-github: githubCloudOnly: false @@ -77204,15 +77570,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 responses: '204': description: Response - '301': *326 + '301': *333 '404': *6 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77231,9 +77597,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 - name: name in: path required: true @@ -77246,7 +77612,7 @@ paths: application/json: schema: type: array - items: *494 + items: *501 examples: default: value: @@ -77257,9 +77623,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *326 + '301': *333 '404': *6 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77279,9 +77645,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: false content: @@ -77310,7 +77676,7 @@ paths: '204': description: Response '403': *27 - '410': *323 + '410': *330 '404': *6 '422': *15 x-github: @@ -77328,9 +77694,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 responses: '204': description: Response @@ -77352,9 +77718,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 - 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. @@ -77380,13 +77746,13 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *303 + default: *310 headers: Link: *37 '404': *6 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77404,9 +77770,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: true content: @@ -77438,16 +77804,16 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '201': description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '422': *15 x-github: githubCloudOnly: false @@ -77469,10 +77835,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *312 - - *313 - - *492 - - *304 + - *319 + - *320 + - *499 + - *311 responses: '204': description: Response @@ -77501,9 +77867,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: true content: @@ -77525,9 +77891,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *128 examples: - default: *491 + default: *498 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -77560,9 +77926,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 - *17 - *18 responses: @@ -77572,13 +77938,13 @@ paths: application/json: schema: type: array - items: *116 + items: *128 examples: - default: *496 + default: *503 headers: Link: *37 '404': *6 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77606,9 +77972,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: true content: @@ -77634,16 +78000,16 @@ paths: description: Response content: application/json: - schema: *116 + schema: *128 examples: - default: *491 + default: *498 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *323 + '410': *330 '422': *15 '404': *6 x-github: @@ -77663,9 +78029,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: true content: @@ -77696,13 +78062,13 @@ paths: description: Response content: application/json: - schema: *116 + schema: *128 examples: - default: *491 + default: *498 '403': *27 '404': *6 '422': *7 - '503': *96 + '503': *108 x-github: triggersNotification: true githubCloudOnly: false @@ -77720,9 +78086,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 - *17 - *18 responses: @@ -77737,19 +78103,19 @@ paths: description: Timeline Event type: object anyOf: - - *497 - - *498 - - *499 - - *500 - - *501 - - *502 - - *503 - *504 - *505 - *506 - *507 - *508 - *509 + - *510 + - *511 + - *512 + - *513 + - *514 + - *515 + - *516 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -77797,12 +78163,12 @@ paths: issue_url: type: string format: uri - author_association: *103 + author_association: *115 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *104 + reactions: *116 required: - event - actor @@ -77833,7 +78199,7 @@ paths: properties: type: type: string - issue: *116 + issue: *128 required: - event - created_at @@ -78049,7 +78415,7 @@ paths: type: string body_text: type: string - author_association: *103 + author_association: *115 required: - event - id @@ -78072,7 +78438,7 @@ paths: type: string comments: type: array - items: &529 + items: &536 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -78177,7 +78543,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *103 + author_association: *115 _links: type: object properties: @@ -78272,7 +78638,7 @@ paths: enum: - line - file - reactions: *104 + reactions: *116 body_html: type: string examples: @@ -78310,7 +78676,7 @@ paths: type: string comments: type: array - items: *424 + items: *431 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -78585,7 +78951,7 @@ paths: headers: Link: *37 '404': *6 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78602,8 +78968,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -78613,7 +78979,7 @@ paths: application/json: schema: type: array - items: &510 + items: &517 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -78680,8 +79046,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -78717,9 +79083,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *517 examples: - default: &511 + default: &518 value: id: 1 key: ssh-rsa AAA... @@ -78753,9 +79119,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *312 - - *313 - - &512 + - *319 + - *320 + - &519 name: key_id description: The unique identifier of the key. in: path @@ -78767,9 +79133,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *517 examples: - default: *511 + default: *518 '404': *6 x-github: githubCloudOnly: false @@ -78787,9 +79153,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *312 - - *313 - - *512 + - *319 + - *320 + - *519 responses: '204': description: Response @@ -78809,8 +79175,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -78820,9 +79186,9 @@ paths: application/json: schema: type: array - items: *494 + items: *501 examples: - default: *495 + default: *502 headers: Link: *37 '404': *6 @@ -78843,8 +79209,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -78880,9 +79246,9 @@ paths: description: Response content: application/json: - schema: *494 + schema: *501 examples: - default: &513 + default: &520 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -78914,8 +79280,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *312 - - *313 + - *319 + - *320 - name: name in: path required: true @@ -78926,9 +79292,9 @@ paths: description: Response content: application/json: - schema: *494 + schema: *501 examples: - default: *513 + default: *520 '404': *6 x-github: githubCloudOnly: false @@ -78945,8 +79311,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *312 - - *313 + - *319 + - *320 - name: name in: path required: true @@ -78985,7 +79351,7 @@ paths: description: Response content: application/json: - schema: *494 + schema: *501 examples: default: value: @@ -79011,8 +79377,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *312 - - *313 + - *319 + - *320 - name: name in: path required: true @@ -79038,8 +79404,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -79075,10 +79441,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 responses: - '202': *144 + '202': *156 '403': description: |- We will return a 403 with one of the following messages: @@ -79104,8 +79470,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -79131,9 +79497,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *312 - - *313 - - *401 + - *319 + - *320 + - *408 responses: '200': description: Response @@ -79199,7 +79565,7 @@ paths: license: anyOf: - type: 'null' - - *117 + - *129 required: - _links - git_url @@ -79280,8 +79646,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -79346,8 +79712,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -79381,9 +79747,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *425 + schema: *432 examples: - default: *514 + default: *521 '204': description: Response when already merged '404': @@ -79408,8 +79774,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *312 - - *313 + - *319 + - *320 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -79450,7 +79816,7 @@ paths: application/json: schema: type: array - items: *429 + items: *436 examples: default: value: @@ -79506,8 +79872,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -79547,9 +79913,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *436 examples: - default: &515 + default: &522 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -79608,9 +79974,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *312 - - *313 - - &516 + - *319 + - *320 + - &523 name: milestone_number description: The number that identifies the milestone. in: path @@ -79622,9 +79988,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *436 examples: - default: *515 + default: *522 '404': *6 x-github: githubCloudOnly: false @@ -79641,9 +80007,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *312 - - *313 - - *516 + - *319 + - *320 + - *523 requestBody: required: false content: @@ -79681,9 +80047,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *436 examples: - default: *515 + default: *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79699,9 +80065,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *312 - - *313 - - *516 + - *319 + - *320 + - *523 responses: '204': description: Response @@ -79722,9 +80088,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: - - *312 - - *313 - - *516 + - *319 + - *320 + - *523 - *17 - *18 responses: @@ -79734,9 +80100,9 @@ paths: application/json: schema: type: array - items: *494 + items: *501 examples: - default: *495 + default: *502 headers: Link: *37 x-github: @@ -79755,12 +80121,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: - - *312 - - *313 - - *517 - - *518 - - *106 - - *519 + - *319 + - *320 + - *524 + - *525 + - *118 + - *526 - *17 - *18 responses: @@ -79770,9 +80136,9 @@ paths: application/json: schema: type: array - items: *128 + items: *140 examples: - default: *520 + default: *527 headers: Link: *37 x-github: @@ -79796,8 +80162,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: false content: @@ -79855,14 +80221,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: &521 + schema: &528 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -80006,7 +80372,7 @@ paths: - custom_404 - public examples: - default: &522 + default: &529 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -80047,8 +80413,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -80103,11 +80469,11 @@ paths: description: Response content: application/json: - schema: *521 + schema: *528 examples: - default: *522 + default: *529 '422': *15 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80128,8 +80494,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -80216,7 +80582,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80237,14 +80603,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response '422': *15 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80264,8 +80630,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -80275,7 +80641,7 @@ paths: application/json: schema: type: array - items: &523 + items: &530 title: Page Build description: Page Build type: object @@ -80367,8 +80733,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *312 - - *313 + - *319 + - *320 responses: '201': description: Response @@ -80415,16 +80781,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: *523 + schema: *530 examples: - default: &524 + default: &531 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -80472,8 +80838,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *312 - - *313 + - *319 + - *320 - name: build_id in: path required: true @@ -80484,9 +80850,9 @@ paths: description: Response content: application/json: - schema: *523 + schema: *530 examples: - default: *524 + default: *531 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80506,8 +80872,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -80616,9 +80982,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: - - *312 - - *313 - - &525 + - *319 + - *320 + - &532 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -80676,11 +81042,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *312 - - *313 - - *525 + - *319 + - *320 + - *532 responses: - '204': *185 + '204': *197 '404': *6 x-github: githubCloudOnly: false @@ -80705,8 +81071,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -80974,7 +81340,7 @@ paths: description: Empty response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -81001,8 +81367,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Private vulnerability reporting status @@ -81039,10 +81405,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: - - *312 - - *313 + - *319 + - *320 responses: - '204': *185 + '204': *197 '422': *14 x-github: githubCloudOnly: false @@ -81061,10 +81427,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: - - *312 - - *313 + - *319 + - *320 responses: - '204': *185 + '204': *197 '422': *14 x-github: githubCloudOnly: false @@ -81085,8 +81451,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-repository-projects parameters: - - *312 - - *313 + - *319 + - *320 - name: state description: Indicates the state of the projects to return. in: query @@ -81107,7 +81473,7 @@ paths: application/json: schema: type: array - items: *262 + items: *274 examples: default: value: @@ -81147,7 +81513,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *323 + '410': *330 '422': *7 x-github: githubCloudOnly: false @@ -81167,8 +81533,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-a-repository-project parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -81194,13 +81560,13 @@ paths: description: Response content: application/json: - schema: *262 + schema: *274 examples: - default: *322 + default: *329 '401': *23 '403': *27 '404': *6 - '410': *323 + '410': *330 '422': *7 x-github: githubCloudOnly: false @@ -81220,8 +81586,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -81229,7 +81595,7 @@ paths: application/json: schema: type: array - items: *263 + items: *276 examples: default: value: @@ -81260,8 +81626,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -81273,7 +81639,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *263 + items: *276 required: - properties examples: @@ -81323,8 +81689,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *312 - - *313 + - *319 + - *320 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -81384,9 +81750,9 @@ paths: application/json: schema: type: array - items: *526 + items: *533 examples: - default: *527 + default: *534 headers: Link: *37 '304': *35 @@ -81418,8 +81784,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -81486,7 +81852,7 @@ paths: description: Response content: application/json: - schema: &531 + schema: &538 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -81615,7 +81981,7 @@ paths: milestone: anyOf: - type: 'null' - - *429 + - *436 active_lock_reason: type: - string @@ -81670,7 +82036,7 @@ paths: type: - array - 'null' - items: *247 + items: *259 head: type: object properties: @@ -81708,14 +82074,14 @@ paths: _links: type: object properties: - comments: *430 - commits: *430 - statuses: *430 - html: *430 - issue: *430 - review_comments: *430 - review_comment: *430 - self: *430 + comments: *437 + commits: *437 + statuses: *437 + html: *437 + issue: *437 + review_comments: *437 + review_comment: *437 + self: *437 required: - comments - commits @@ -81725,8 +82091,8 @@ paths: - review_comments - review_comment - self - author_association: *103 - auto_merge: *528 + author_association: *115 + auto_merge: *535 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -81828,7 +82194,7 @@ paths: - merged_by - review_comments examples: - default: &532 + default: &539 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -82355,8 +82721,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *312 - - *313 + - *319 + - *320 - name: sort in: query required: false @@ -82375,7 +82741,7 @@ paths: enum: - asc - desc - - *106 + - *118 - *17 - *18 responses: @@ -82385,9 +82751,9 @@ paths: application/json: schema: type: array - items: *529 + items: *536 examples: - default: &534 + default: &541 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -82464,17 +82830,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: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 responses: '200': description: Response content: application/json: - schema: *529 + schema: *536 examples: - default: &530 + default: &537 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -82549,9 +82915,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: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 requestBody: required: true content: @@ -82573,9 +82939,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *536 examples: - default: *530 + default: *537 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82591,9 +82957,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: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 responses: '204': description: Response @@ -82614,9 +82980,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: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 - 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. @@ -82642,9 +83008,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *303 + default: *310 headers: Link: *37 '404': *6 @@ -82665,9 +83031,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: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 requestBody: required: true content: @@ -82699,16 +83065,16 @@ paths: description: Reaction exists content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '201': description: Reaction created content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '422': *15 x-github: githubCloudOnly: false @@ -82730,10 +83096,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *312 - - *313 - - *115 - - *304 + - *319 + - *320 + - *127 + - *311 responses: '204': description: Response @@ -82776,9 +83142,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *312 - - *313 - - &533 + - *319 + - *320 + - &540 name: pull_number description: The number that identifies the pull request. in: path @@ -82791,9 +83157,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *531 + schema: *538 examples: - default: *532 + default: *539 '304': *35 '404': *6 '406': @@ -82802,7 +83168,7 @@ paths: application/json: schema: *3 '500': *80 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82828,9 +83194,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 requestBody: required: false content: @@ -82872,9 +83238,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *538 examples: - default: *532 + default: *539 '422': *15 '403': *27 x-github: @@ -82896,9 +83262,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: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 requestBody: required: true content: @@ -82959,21 +83325,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '401': *23 '403': *27 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -82999,10 +83365,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: - - *312 - - *313 - - *533 - - *125 + - *319 + - *320 + - *540 + - *137 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -83012,7 +83378,7 @@ paths: enum: - asc - desc - - *106 + - *118 - *17 - *18 responses: @@ -83022,9 +83388,9 @@ paths: application/json: schema: type: array - items: *529 + items: *536 examples: - default: *534 + default: *541 headers: Link: *37 x-github: @@ -83057,9 +83423,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: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 requestBody: required: true content: @@ -83165,7 +83531,7 @@ paths: description: Response content: application/json: - schema: *529 + schema: *536 examples: example-for-a-multi-line-comment: value: @@ -83253,10 +83619,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: - - *312 - - *313 - - *533 - - *115 + - *319 + - *320 + - *540 + - *127 requestBody: required: true content: @@ -83278,7 +83644,7 @@ paths: description: Response content: application/json: - schema: *529 + schema: *536 examples: default: value: @@ -83364,9 +83730,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 - *17 - *18 responses: @@ -83376,9 +83742,9 @@ paths: application/json: schema: type: array - items: *425 + items: *432 examples: - default: *535 + default: *542 headers: Link: *37 x-github: @@ -83408,9 +83774,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 - *17 - *18 responses: @@ -83420,7 +83786,7 @@ paths: application/json: schema: type: array - items: *437 + items: *444 examples: default: value: @@ -83439,7 +83805,7 @@ paths: Link: *37 '422': *15 '500': *80 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83458,9 +83824,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: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 responses: '204': description: Response if pull request has been merged @@ -83483,9 +83849,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 requestBody: required: false content: @@ -83597,9 +83963,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: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 responses: '200': description: Response @@ -83615,7 +83981,7 @@ paths: items: *4 teams: type: array - items: *234 + items: *246 required: - users - teams @@ -83674,9 +84040,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: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 requestBody: required: false content: @@ -83713,7 +84079,7 @@ paths: description: Response content: application/json: - schema: *526 + schema: *533 examples: default: value: @@ -84249,9 +84615,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: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 requestBody: required: true content: @@ -84285,7 +84651,7 @@ paths: description: Response content: application/json: - schema: *526 + schema: *533 examples: default: value: @@ -84790,9 +85156,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 - *17 - *18 responses: @@ -84802,7 +85168,7 @@ paths: application/json: schema: type: array - items: &536 + items: &543 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -84876,7 +85242,7 @@ paths: type: string body_text: type: string - author_association: *103 + author_association: *115 required: - id - node_id @@ -84958,9 +85324,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: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 requestBody: required: false content: @@ -85050,9 +85416,9 @@ paths: description: Response content: application/json: - schema: *536 + schema: *543 examples: - default: &538 + default: &545 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -85115,10 +85481,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: - - *312 - - *313 - - *533 - - &537 + - *319 + - *320 + - *540 + - &544 name: review_id description: The unique identifier of the review. in: path @@ -85130,9 +85496,9 @@ paths: description: Response content: application/json: - schema: *536 + schema: *543 examples: - default: &539 + default: &546 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -85191,10 +85557,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: - - *312 - - *313 - - *533 - - *537 + - *319 + - *320 + - *540 + - *544 requestBody: required: true content: @@ -85217,7 +85583,7 @@ paths: description: Response content: application/json: - schema: *536 + schema: *543 examples: default: value: @@ -85279,18 +85645,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: - - *312 - - *313 - - *533 - - *537 + - *319 + - *320 + - *540 + - *544 responses: '200': description: Response content: application/json: - schema: *536 + schema: *543 examples: - default: *538 + default: *545 '422': *7 '404': *6 x-github: @@ -85317,10 +85683,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: - - *312 - - *313 - - *533 - - *537 + - *319 + - *320 + - *540 + - *544 - *17 - *18 responses: @@ -85414,13 +85780,13 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *103 + author_association: *115 _links: type: object properties: - self: *430 - html: *430 - pull_request: *430 + self: *437 + html: *437 + pull_request: *437 required: - self - html @@ -85429,7 +85795,7 @@ paths: type: string body_html: type: string - reactions: *104 + reactions: *116 side: description: The side of the first line of the range for a multi-line comment. @@ -85571,10 +85937,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: - - *312 - - *313 - - *533 - - *537 + - *319 + - *320 + - *540 + - *544 requestBody: required: true content: @@ -85603,7 +85969,7 @@ paths: description: Response content: application/json: - schema: *536 + schema: *543 examples: default: value: @@ -85666,10 +86032,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: - - *312 - - *313 - - *533 - - *537 + - *319 + - *320 + - *540 + - *544 requestBody: required: true content: @@ -85704,9 +86070,9 @@ paths: description: Response content: application/json: - schema: *536 + schema: *543 examples: - default: *539 + default: *546 '404': *6 '422': *7 '403': *27 @@ -85728,9 +86094,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 requestBody: required: false content: @@ -85794,8 +86160,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *312 - - *313 + - *319 + - *320 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -85808,9 +86174,9 @@ paths: description: Response content: application/json: - schema: *540 + schema: *547 examples: - default: &541 + default: &548 value: type: file encoding: base64 @@ -85852,8 +86218,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: - - *312 - - *313 + - *319 + - *320 - name: dir description: The alternate path to look for a README file in: path @@ -85873,9 +86239,9 @@ paths: description: Response content: application/json: - schema: *540 + schema: *547 examples: - default: *541 + default: *548 '404': *6 '422': *15 x-github: @@ -85897,8 +86263,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -85908,7 +86274,7 @@ paths: application/json: schema: type: array - items: &542 + items: &549 title: Release description: A release. type: object @@ -85980,7 +86346,7 @@ paths: author: *4 assets: type: array - items: &543 + items: &550 title: Release Asset description: Data related to a release. type: object @@ -86050,7 +86416,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *104 + reactions: *116 required: - assets_url - upload_url @@ -86160,8 +86526,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -86237,9 +86603,9 @@ paths: description: Response content: application/json: - schema: *542 + schema: *549 examples: - default: &546 + default: &553 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -86342,9 +86708,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *312 - - *313 - - &544 + - *319 + - *320 + - &551 name: asset_id description: The unique identifier of the asset. in: path @@ -86356,9 +86722,9 @@ paths: description: Response content: application/json: - schema: *543 + schema: *550 examples: - default: &545 + default: &552 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 @@ -86392,7 +86758,7 @@ paths: type: User site_admin: false '404': *6 - '302': *439 + '302': *446 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86408,9 +86774,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *312 - - *313 - - *544 + - *319 + - *320 + - *551 requestBody: required: false content: @@ -86439,9 +86805,9 @@ paths: description: Response content: application/json: - schema: *543 + schema: *550 examples: - default: *545 + default: *552 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86457,9 +86823,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *312 - - *313 - - *544 + - *319 + - *320 + - *551 responses: '204': description: Response @@ -86483,8 +86849,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -86570,16 +86936,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: *542 + schema: *549 examples: - default: *546 + default: *553 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86596,8 +86962,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *312 - - *313 + - *319 + - *320 - name: tag description: tag parameter in: path @@ -86610,9 +86976,9 @@ paths: description: Response content: application/json: - schema: *542 + schema: *549 examples: - default: *546 + default: *553 '404': *6 x-github: githubCloudOnly: false @@ -86634,9 +87000,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *312 - - *313 - - &547 + - *319 + - *320 + - &554 name: release_id description: The unique identifier of the release. in: path @@ -86650,9 +87016,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: *542 + schema: *549 examples: - default: *546 + default: *553 '401': description: Unauthorized x-github: @@ -86670,9 +87036,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *312 - - *313 - - *547 + - *319 + - *320 + - *554 requestBody: required: false content: @@ -86736,9 +87102,9 @@ paths: description: Response content: application/json: - schema: *542 + schema: *549 examples: - default: *546 + default: *553 '404': description: Not Found if the discussion category name is invalid content: @@ -86759,9 +87125,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *312 - - *313 - - *547 + - *319 + - *320 + - *554 responses: '204': description: Response @@ -86781,9 +87147,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *312 - - *313 - - *547 + - *319 + - *320 + - *554 - *17 - *18 responses: @@ -86793,7 +87159,7 @@ paths: application/json: schema: type: array - items: *543 + items: *550 examples: default: value: @@ -86874,9 +87240,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: - - *312 - - *313 - - *547 + - *319 + - *320 + - *554 - name: name in: query required: true @@ -86902,7 +87268,7 @@ paths: description: Response for successful upload content: application/json: - schema: *543 + schema: *550 examples: response-for-successful-upload: value: @@ -86956,9 +87322,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *312 - - *313 - - *547 + - *319 + - *320 + - *554 - 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. @@ -86982,9 +87348,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *303 + default: *310 headers: Link: *37 '404': *6 @@ -87005,9 +87371,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *312 - - *313 - - *547 + - *319 + - *320 + - *554 requestBody: required: true content: @@ -87037,16 +87403,16 @@ paths: description: Reaction exists content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '201': description: Reaction created content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '422': *15 x-github: githubCloudOnly: false @@ -87068,10 +87434,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *312 - - *313 - - *547 - - *304 + - *319 + - *320 + - *554 + - *311 responses: '204': description: Response @@ -87095,9 +87461,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 - *17 - *18 responses: @@ -87113,8 +87479,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *548 - - &550 + - *555 + - &557 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -87133,54 +87499,54 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *549 - - *550 - - allOf: - - *551 - - *550 - - allOf: - - *552 - - *550 - - allOf: - - *553 - - *550 - - allOf: - - *554 - - *550 - - allOf: - - *555 - - *550 - allOf: - *556 - - *550 - - allOf: - *557 - - *550 - allOf: - *558 - - *550 + - *557 - allOf: - *559 - - *550 + - *557 - allOf: - *560 - - *550 + - *557 - allOf: - *561 - - *550 + - *557 - allOf: - *562 - - *550 + - *557 - allOf: - *563 - - *550 + - *557 - allOf: - *564 - - *550 + - *557 - allOf: - *565 - - *550 + - *557 + - allOf: + - *566 + - *557 + - allOf: + - *567 + - *557 + - allOf: + - *568 + - *557 + - allOf: + - *569 + - *557 + - allOf: + - *570 + - *557 + - allOf: + - *571 + - *557 + - allOf: + - *572 + - *557 examples: default: value: @@ -87219,8 +87585,8 @@ paths: category: repos subcategory: rules parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 - name: includes_parents @@ -87231,7 +87597,7 @@ paths: schema: type: boolean default: true - - *566 + - *573 responses: '200': description: Response @@ -87239,7 +87605,7 @@ paths: application/json: schema: type: array - items: *273 + items: *105 examples: default: value: @@ -87286,8 +87652,8 @@ paths: category: repos subcategory: rules parameters: - - *312 - - *313 + - *319 + - *320 requestBody: description: Request body required: true @@ -87307,16 +87673,16 @@ paths: - tag - push default: branch - enforcement: *269 + enforcement: *102 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *270 - conditions: *267 + items: *103 + conditions: *98 rules: type: array description: An array of rules within the ruleset. - items: *272 + items: *104 required: - name - enforcement @@ -87347,9 +87713,9 @@ paths: description: Response content: application/json: - schema: *273 + schema: *105 examples: - default: &576 + default: &583 value: id: 42 name: super cool ruleset @@ -87396,12 +87762,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *312 - - *313 - - *567 - - *568 - - *569 - - *570 + - *319 + - *320 + - *574 + - *575 + - *576 + - *577 - *17 - *18 responses: @@ -87409,9 +87775,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *578 examples: - default: *572 + default: *579 '404': *6 '500': *80 x-github: @@ -87432,17 +87798,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *312 - - *313 - - *573 + - *319 + - *320 + - *580 responses: '200': description: Response content: application/json: - schema: *574 + schema: *581 examples: - default: *575 + default: *582 '404': *6 '500': *80 x-github: @@ -87470,8 +87836,8 @@ paths: category: repos subcategory: rules parameters: - - *312 - - *313 + - *319 + - *320 - name: ruleset_id description: The ID of the ruleset. in: path @@ -87491,9 +87857,9 @@ paths: description: Response content: application/json: - schema: *273 + schema: *105 examples: - default: *576 + default: *583 '404': *6 '500': *80 put: @@ -87511,8 +87877,8 @@ paths: category: repos subcategory: rules parameters: - - *312 - - *313 + - *319 + - *320 - name: ruleset_id description: The ID of the ruleset. in: path @@ -87537,16 +87903,16 @@ paths: - branch - tag - push - enforcement: *269 + enforcement: *102 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *270 - conditions: *267 + items: *103 + conditions: *98 rules: description: An array of rules within the ruleset. type: array - items: *272 + items: *104 examples: default: value: @@ -87574,9 +87940,9 @@ paths: description: Response content: application/json: - schema: *273 + schema: *105 examples: - default: *576 + default: *583 '404': *6 '500': *80 delete: @@ -87594,8 +87960,8 @@ paths: category: repos subcategory: rules parameters: - - *312 - - *313 + - *319 + - *320 - name: ruleset_id description: The ID of the ruleset. in: path @@ -87623,20 +87989,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: - - *312 - - *313 - - *275 - - *276 - - *277 - - *278 + - *319 + - *320 + - *282 + - *283 + - *284 + - *285 - *76 - *18 - *17 - - *577 - - *578 - - *279 - - *280 - - *281 + - *584 + - *585 + - *286 + - *287 + - *288 responses: '200': description: Response @@ -87644,7 +88010,7 @@ paths: application/json: schema: type: array - items: &581 + items: &588 type: object properties: number: *81 @@ -87660,8 +88026,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *579 - resolution: *580 + state: *586 + resolution: *587 resolved_at: type: - string @@ -87710,6 +88076,12 @@ paths: anyOf: - type: 'null' - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. push_protection_bypass_request_comment: type: - string @@ -87813,6 +88185,7 @@ paths: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true + push_protection_bypass_request_reviewer_comment: Example response push_protection_bypass_request_comment: Example comment push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment @@ -87835,6 +88208,7 @@ paths: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -87844,7 +88218,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87866,15 +88240,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: - - *312 - - *313 - - *399 + - *319 + - *320 + - *406 responses: '200': description: Response content: application/json: - schema: *581 + schema: *588 examples: default: value: @@ -87894,6 +88268,7 @@ paths: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -87904,7 +88279,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87925,9 +88300,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: - - *312 - - *313 - - *399 + - *319 + - *320 + - *406 requestBody: required: true content: @@ -87935,8 +88310,8 @@ paths: schema: type: object properties: - state: *579 - resolution: *580 + state: *586 + resolution: *587 resolution_comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -87955,7 +88330,7 @@ paths: description: Response content: application/json: - schema: *581 + schema: *588 examples: default: value: @@ -87993,6 +88368,7 @@ paths: push_protection_bypassed_by: push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: Example comment @@ -88007,7 +88383,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *96 + '503': *108 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -88029,9 +88405,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: - - *312 - - *313 - - *399 + - *319 + - *320 + - *406 - *18 - *17 responses: @@ -88042,7 +88418,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &737 + items: &744 type: object properties: type: @@ -88399,7 +88775,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88421,8 +88797,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -88430,14 +88806,14 @@ paths: schema: type: object properties: - reason: &583 + reason: &590 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *582 + placeholder_id: *589 required: - reason - placeholder_id @@ -88454,7 +88830,7 @@ paths: schema: type: object properties: - reason: *583 + reason: *590 expire_at: type: - string @@ -88478,7 +88854,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *96 + '503': *108 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -88498,13 +88874,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *96 + '503': *108 '200': description: Response content: @@ -88514,7 +88890,7 @@ paths: properties: incremental_scans: type: array - items: &584 + items: &591 description: Information on a single scan performed by secret scanning on the repository type: object @@ -88542,15 +88918,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *584 + items: *591 backfill_scans: type: array - items: *584 + items: *591 custom_pattern_backfill_scans: type: array items: allOf: - - *584 + - *591 - type: object properties: pattern_name: @@ -88620,8 +88996,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *312 - - *313 + - *319 + - *320 - *76 - name: sort description: The property to sort the results by. @@ -88665,9 +89041,9 @@ paths: application/json: schema: type: array - items: *585 + items: *592 examples: - default: *586 + default: *593 '400': *14 '404': *6 x-github: @@ -88690,8 +89066,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -88771,7 +89147,7 @@ paths: login: type: string description: The username of the user credited. - type: *284 + type: *291 required: - login - type @@ -88861,9 +89237,9 @@ paths: description: Response content: application/json: - schema: *585 + schema: *592 examples: - default: &588 + default: &595 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -89096,8 +89472,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -89210,7 +89586,7 @@ paths: description: Response content: application/json: - schema: *585 + schema: *592 examples: default: value: @@ -89357,17 +89733,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: - - *312 - - *313 - - *587 + - *319 + - *320 + - *594 responses: '200': description: Response content: application/json: - schema: *585 + schema: *592 examples: - default: *588 + default: *595 '403': *27 '404': *6 x-github: @@ -89391,9 +89767,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: - - *312 - - *313 - - *587 + - *319 + - *320 + - *594 requestBody: required: true content: @@ -89473,7 +89849,7 @@ paths: login: type: string description: The username of the user credited. - type: *284 + type: *291 required: - login - type @@ -89564,17 +89940,17 @@ paths: description: Response content: application/json: - schema: *585 + schema: *592 examples: - default: *588 - add_credit: *588 + default: *595 + add_credit: *595 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *141 + schema: *153 examples: invalid_state_transition: value: @@ -89605,11 +89981,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: - - *312 - - *313 - - *587 + - *319 + - *320 + - *594 responses: - '202': *144 + '202': *156 '400': *14 '403': *27 '404': *6 @@ -89634,17 +90010,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: - - *312 - - *313 - - *587 + - *319 + - *320 + - *594 responses: '202': description: Response content: application/json: - schema: *325 + schema: *332 examples: - default: *327 + default: *334 '400': *14 '422': *15 '403': *27 @@ -89670,8 +90046,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -89767,8 +90143,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -89777,7 +90153,7 @@ paths: application/json: schema: type: array - items: &589 + items: &596 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -89789,8 +90165,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *144 - '204': *185 + '202': *156 + '204': *197 '422': description: Repository contains more than 10,000 commits x-github: @@ -89810,8 +90186,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -89861,8 +90237,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *144 - '204': *185 + '202': *156 + '204': *197 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89889,8 +90265,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -89961,8 +90337,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *144 - '204': *185 + '202': *156 + '204': *197 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89984,8 +90360,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -90139,8 +90515,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -90150,7 +90526,7 @@ paths: application/json: schema: type: array - items: *589 + items: *596 examples: default: value: @@ -90163,7 +90539,7 @@ paths: - - 0 - 2 - 21 - '204': *185 + '204': *197 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90183,8 +90559,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *312 - - *313 + - *319 + - *320 - name: sha in: path required: true @@ -90240,7 +90616,7 @@ paths: description: Response content: application/json: - schema: *590 + schema: *597 examples: default: value: @@ -90294,8 +90670,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -90307,7 +90683,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 x-github: @@ -90327,14 +90703,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &591 + schema: &598 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -90407,8 +90783,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: false content: @@ -90434,7 +90810,7 @@ paths: description: Response content: application/json: - schema: *591 + schema: *598 examples: default: value: @@ -90461,8 +90837,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -90482,8 +90858,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -90565,8 +90941,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -90574,7 +90950,7 @@ paths: application/json: schema: type: array - items: &592 + items: &599 title: Tag protection description: Tag protection type: object @@ -90631,8 +91007,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -90655,7 +91031,7 @@ paths: description: Response content: application/json: - schema: *592 + schema: *599 examples: default: value: @@ -90686,8 +91062,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: - - *312 - - *313 + - *319 + - *320 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -90724,8 +91100,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *312 - - *313 + - *319 + - *320 - name: ref in: path required: true @@ -90761,8 +91137,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -90772,9 +91148,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - default: *248 + default: *260 headers: Link: *37 '404': *6 @@ -90794,8 +91170,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *312 - - *313 + - *319 + - *320 - *18 - *17 responses: @@ -90803,7 +91179,7 @@ paths: description: Response content: application/json: - schema: &593 + schema: &600 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -90815,7 +91191,7 @@ paths: required: - names examples: - default: &594 + default: &601 value: names: - octocat @@ -90838,8 +91214,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -90870,9 +91246,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *600 examples: - default: *594 + default: *601 '404': *6 '422': *7 x-github: @@ -90893,9 +91269,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *312 - - *313 - - &595 + - *319 + - *320 + - &602 name: per description: The time frame to display results for. in: query @@ -90926,7 +91302,7 @@ paths: - 128 clones: type: array - items: &596 + items: &603 title: Traffic type: object properties: @@ -91013,8 +91389,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -91108,8 +91484,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -91172,9 +91548,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *312 - - *313 - - *595 + - *319 + - *320 + - *602 responses: '200': description: Response @@ -91195,7 +91571,7 @@ paths: - 3782 views: type: array - items: *596 + items: *603 required: - uniques - count @@ -91272,8 +91648,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -91309,7 +91685,7 @@ paths: description: Response content: application/json: - schema: *156 + schema: *168 examples: default: value: @@ -91547,8 +91923,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: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -91571,8 +91947,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -91594,8 +91970,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -91621,8 +91997,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *312 - - *313 + - *319 + - *320 - name: ref in: path required: true @@ -91714,9 +92090,9 @@ paths: description: Response content: application/json: - schema: *325 + schema: *332 examples: - default: *327 + default: *334 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -91757,7 +92133,7 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: default: value: @@ -91867,7 +92243,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &604 + - &611 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -91877,7 +92253,7 @@ paths: type: string examples: - members - - &609 + - &616 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -91889,7 +92265,7 @@ paths: format: int32 examples: - 1 - - &610 + - &617 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -91933,7 +92309,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &598 + items: &605 allOf: - type: object required: @@ -92015,7 +92391,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: &611 + meta: &618 type: object description: The metadata associated with the creation/updates to the user. @@ -92080,31 +92456,31 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &599 + '400': &606 description: Bad request content: application/json: - schema: *597 + schema: *604 application/scim+json: - schema: *597 - '401': &600 + schema: *604 + '401': &607 description: Authorization failure - '403': &601 + '403': &608 description: Permission denied - '429': &602 + '429': &609 description: Too many requests content: application/json: - schema: *597 + schema: *604 application/scim+json: - schema: *597 - '500': &603 + schema: *604 + '500': &610 description: Internal server error content: application/json: - schema: *597 + schema: *604 application/scim+json: - schema: *597 + schema: *604 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92128,7 +92504,7 @@ paths: required: true content: application/json: - schema: &607 + schema: &614 type: object required: - schemas @@ -92188,9 +92564,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *598 + schema: *605 examples: - group: &605 + group: &612 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -92209,13 +92585,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *599 - '401': *600 - '403': *601 - '409': &608 + '400': *606 + '401': *607 + '403': *608 + '409': &615 description: Duplicate record detected - '429': *602 - '500': *603 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92232,7 +92608,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: - - &606 + - &613 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -92241,22 +92617,22 @@ paths: type: string examples: - 7fce0092-d52e-4f76-b727-3955bd72c939 - - *604 + - *611 - *38 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *598 + schema: *605 examples: - default: *605 - '400': *599 - '401': *600 - '403': *601 + default: *612 + '400': *606 + '401': *607 + '403': *608 '404': *6 - '429': *602 - '500': *603 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92275,13 +92651,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: - - *606 + - *613 - *38 requestBody: required: true content: application/json: - schema: *607 + schema: *614 examples: group: summary: Group @@ -92307,17 +92683,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *598 + schema: *605 examples: - group: *605 - groupWithMembers: *605 - '400': *599 - '401': *600 - '403': *601 + group: *612 + groupWithMembers: *612 + '400': *606 + '401': *607 + '403': *608 '404': *6 - '409': *608 - '429': *602 - '500': *603 + '409': *615 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92341,13 +92717,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: - - *606 + - *613 - *38 requestBody: required: true content: application/json: - schema: &618 + schema: &625 type: object required: - Operations @@ -92407,17 +92783,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *598 + schema: *605 examples: - updateGroup: *605 - addMembers: *605 - '400': *599 - '401': *600 - '403': *601 + updateGroup: *612 + addMembers: *612 + '400': *606 + '401': *607 + '403': *608 '404': *6 - '409': *608 - '429': *602 - '500': *603 + '409': *615 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92433,17 +92809,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: - - *606 + - *613 - *38 responses: '204': description: Group was deleted, no content - '400': *599 - '401': *600 - '403': *601 + '400': *606 + '401': *607 + '403': *608 '404': *6 - '429': *602 - '500': *603 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92477,8 +92853,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *609 - - *610 + - *616 + - *617 - *38 responses: '200': @@ -92512,7 +92888,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &613 + items: &620 allOf: - type: object required: @@ -92604,7 +92980,7 @@ paths: address. examples: - true - roles: &612 + roles: &619 type: array description: The roles assigned to the user. items: @@ -92663,7 +93039,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *611 + meta: *618 startIndex: type: integer description: A starting index for the returned page @@ -92702,11 +93078,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *599 - '401': *600 - '403': *601 - '429': *602 - '500': *603 + '400': *606 + '401': *607 + '403': *608 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92730,7 +93106,7 @@ paths: required: true content: application/json: - schema: &616 + schema: &623 type: object required: - schemas @@ -92823,9 +93199,9 @@ paths: description: Whether this email address is the primary address. examples: - true - roles: *612 + roles: *619 examples: - user: &617 + user: &624 summary: User value: schemas: @@ -92872,9 +93248,9 @@ paths: description: User has been created content: application/scim+json: - schema: *613 + schema: *620 examples: - user: &614 + user: &621 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -92900,13 +93276,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: *614 - '400': *599 - '401': *600 - '403': *601 - '409': *608 - '429': *602 - '500': *603 + enterpriseOwner: *621 + '400': *606 + '401': *607 + '403': *608 + '409': *615 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92923,7 +93299,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: - - &615 + - &622 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -92936,15 +93312,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *613 + schema: *620 examples: - default: *614 - '400': *599 - '401': *600 - '403': *601 + default: *621 + '400': *606 + '401': *607 + '403': *608 '404': *6 - '429': *602 - '500': *603 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92966,30 +93342,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: - - *615 + - *622 - *38 requestBody: required: true content: application/json: - schema: *616 + schema: *623 examples: - user: *617 + user: *624 responses: '200': description: User was updated content: application/scim+json: - schema: *613 + schema: *620 examples: - user: *614 - '400': *599 - '401': *600 - '403': *601 + user: *621 + '400': *606 + '401': *607 + '403': *608 '404': *6 - '409': *608 - '429': *602 - '500': *603 + '409': *615 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -93024,13 +93400,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: - - *615 + - *622 - *38 requestBody: required: true content: application/json: - schema: *618 + schema: *625 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -93070,18 +93446,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *613 - examples: - userMultiValuedProperties: *614 - userSingleValuedProperties: *614 - disableUser: *614 - '400': *599 - '401': *600 - '403': *601 + schema: *620 + examples: + userMultiValuedProperties: *621 + userSingleValuedProperties: *621 + disableUser: *621 + '400': *606 + '401': *607 + '403': *608 '404': *6 - '409': *608 - '429': *602 - '500': *603 + '409': *615 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -93101,17 +93477,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: - - *615 + - *622 - *38 responses: '204': description: User was deleted, no content - '400': *599 - '401': *600 - '403': *601 + '400': *606 + '401': *607 + '403': *608 '404': *6 - '429': *602 - '500': *603 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -93144,7 +93520,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *138 + - *150 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -93202,7 +93578,7 @@ paths: - 1 Resources: type: array - items: &619 + items: &626 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -93449,22 +93825,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *35 - '404': &620 + '404': &627 description: Resource not found content: application/json: - schema: *597 + schema: *604 application/scim+json: - schema: *597 - '403': &621 + schema: *604 + '403': &628 description: Forbidden content: application/json: - schema: *597 + schema: *604 application/scim+json: - schema: *597 - '400': *599 - '429': *602 + schema: *604 + '400': *606 + '429': *609 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -93484,15 +93860,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *138 + - *150 responses: '201': description: Response content: application/scim+json: - schema: *619 + schema: *626 examples: - default: &622 + default: &629 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -93515,17 +93891,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *35 - '404': *620 - '403': *621 - '500': *603 + '404': *627 + '403': *628 + '500': *610 '409': description: Conflict content: application/json: - schema: *597 + schema: *604 application/scim+json: - schema: *597 - '400': *599 + schema: *604 + '400': *606 requestBody: required: true content: @@ -93619,18 +93995,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: - - *138 - - *615 + - *150 + - *622 responses: '200': description: Response content: application/scim+json: - schema: *619 + schema: *626 examples: - default: *622 - '404': *620 - '403': *621 + default: *629 + '404': *627 + '403': *628 '304': *35 x-github: githubCloudOnly: true @@ -93653,19 +94029,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *138 - - *615 + - *150 + - *622 responses: '200': description: Response content: application/scim+json: - schema: *619 + schema: *626 examples: - default: *622 + default: *629 '304': *35 - '404': *620 - '403': *621 + '404': *627 + '403': *628 requestBody: required: true content: @@ -93775,20 +94151,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: - - *138 - - *615 + - *150 + - *622 responses: '200': description: Response content: application/scim+json: - schema: *619 + schema: *626 examples: - default: *622 + default: *629 '304': *35 - '404': *620 - '403': *621 - '400': *599 + '404': *627 + '403': *628 + '400': *606 '429': description: Response content: @@ -93883,13 +94259,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: - - *138 - - *615 + - *150 + - *622 responses: '204': description: Response - '404': *620 - '403': *621 + '404': *627 + '403': *628 '304': *35 x-github: githubCloudOnly: true @@ -94004,7 +94380,7 @@ paths: html_url: type: string format: uri - repository: *156 + repository: *168 score: type: number file_size: @@ -94023,7 +94399,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &623 + text_matches: &630 title: Search Result Text Matches type: array items: @@ -94138,7 +94514,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *35 - '503': *96 + '503': *108 '422': *15 '403': *27 x-github: @@ -94187,7 +94563,7 @@ paths: enum: - author-date - committer-date - - &624 + - &631 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 @@ -94256,7 +94632,7 @@ paths: committer: anyOf: - type: 'null' - - *369 + - *376 comment_count: type: integer message: @@ -94275,7 +94651,7 @@ paths: url: type: string format: uri - verification: *474 + verification: *481 required: - author - committer @@ -94290,7 +94666,7 @@ paths: committer: anyOf: - type: 'null' - - *369 + - *376 parents: type: array items: @@ -94302,12 +94678,12 @@ paths: type: string sha: type: string - repository: *156 + repository: *168 score: type: number node_id: type: string - text_matches: *623 + text_matches: *630 required: - sha - node_id @@ -94500,7 +94876,7 @@ paths: - interactions - created - updated - - *624 + - *631 - *17 - *18 responses: @@ -94616,7 +94992,7 @@ paths: milestone: anyOf: - type: 'null' - - *429 + - *436 comments: type: integer created_at: @@ -94630,7 +95006,7 @@ paths: - string - 'null' format: date-time - text_matches: *623 + text_matches: *630 pull_request: type: object properties: @@ -94668,7 +95044,7 @@ paths: type: string score: type: number - author_association: *103 + author_association: *115 draft: type: boolean repository: *55 @@ -94683,7 +95059,7 @@ paths: anyOf: - type: 'null' - *5 - reactions: *104 + reactions: *116 required: - assignee - closed_at @@ -94799,7 +95175,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *96 + '503': *108 '422': *15 '304': *35 '403': *27 @@ -94852,7 +95228,7 @@ paths: enum: - created - updated - - *624 + - *631 - *17 - *18 responses: @@ -94897,7 +95273,7 @@ paths: - 'null' score: type: number - text_matches: *623 + text_matches: *630 required: - id - node_id @@ -94983,7 +95359,7 @@ paths: - forks - help-wanted-issues - updated - - *624 + - *631 - *17 - *18 responses: @@ -95202,7 +95578,7 @@ paths: license: anyOf: - type: 'null' - - *117 + - *129 permissions: type: object properties: @@ -95220,7 +95596,7 @@ paths: - admin - pull - push - text_matches: *623 + text_matches: *630 temp_clone_token: type: string allow_merge_commit: @@ -95423,7 +95799,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *96 + '503': *108 '422': *15 '304': *35 x-github: @@ -95529,7 +95905,7 @@ paths: - string - 'null' format: uri - text_matches: *623 + text_matches: *630 related: type: - array @@ -95724,7 +96100,7 @@ paths: - followers - repositories - joined - - *624 + - *631 - *17 - *18 responses: @@ -95834,7 +96210,7 @@ paths: type: - boolean - 'null' - text_matches: *623 + text_matches: *630 blog: type: - string @@ -95896,7 +96272,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *35 - '503': *96 + '503': *108 '422': *15 x-github: githubCloudOnly: false @@ -95916,7 +96292,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &625 + - &632 name: team_id description: The unique identifier of the team. in: path @@ -95928,9 +96304,9 @@ paths: description: Response content: application/json: - schema: *293 + schema: *300 examples: - default: *294 + default: *301 '404': *6 x-github: githubCloudOnly: false @@ -95957,7 +96333,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *625 + - *632 requestBody: required: true content: @@ -96021,16 +96397,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *293 + schema: *300 examples: - default: *294 + default: *301 '201': description: Response content: application/json: - schema: *293 + schema: *300 examples: - default: *294 + default: *301 '404': *6 '422': *15 '403': *27 @@ -96058,7 +96434,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *625 + - *632 responses: '204': description: Response @@ -96089,7 +96465,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *625 + - *632 - *76 - *17 - *18 @@ -96100,9 +96476,9 @@ paths: application/json: schema: type: array - items: *295 + items: *302 examples: - default: *626 + default: *633 headers: Link: *37 x-github: @@ -96131,7 +96507,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *625 + - *632 requestBody: required: true content: @@ -96165,9 +96541,9 @@ paths: description: Response content: application/json: - schema: *295 + schema: *302 examples: - default: *296 + default: *303 x-github: triggersNotification: true githubCloudOnly: false @@ -96194,16 +96570,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *625 - - *297 + - *632 + - *304 responses: '200': description: Response content: application/json: - schema: *295 + schema: *302 examples: - default: *296 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96228,8 +96604,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *625 - - *297 + - *632 + - *304 requestBody: required: false content: @@ -96252,9 +96628,9 @@ paths: description: Response content: application/json: - schema: *295 + schema: *302 examples: - default: *627 + default: *634 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96279,8 +96655,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *625 - - *297 + - *632 + - *304 responses: '204': description: Response @@ -96309,8 +96685,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *625 - - *297 + - *632 + - *304 - *76 - *17 - *18 @@ -96321,9 +96697,9 @@ paths: application/json: schema: type: array - items: *298 + items: *305 examples: - default: *628 + default: *635 headers: Link: *37 x-github: @@ -96352,8 +96728,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *625 - - *297 + - *632 + - *304 requestBody: required: true content: @@ -96375,9 +96751,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 x-github: triggersNotification: true githubCloudOnly: false @@ -96404,17 +96780,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *625 - - *297 - - *300 + - *632 + - *304 + - *307 responses: '200': description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96439,9 +96815,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *625 - - *297 - - *300 + - *632 + - *304 + - *307 requestBody: required: true content: @@ -96463,9 +96839,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *629 + default: *636 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96490,9 +96866,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *625 - - *297 - - *300 + - *632 + - *304 + - *307 responses: '204': description: Response @@ -96521,9 +96897,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: - - *625 - - *297 - - *300 + - *632 + - *304 + - *307 - 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. @@ -96549,9 +96925,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *303 + default: *310 headers: Link: *37 x-github: @@ -96580,9 +96956,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: - - *625 - - *297 - - *300 + - *632 + - *304 + - *307 requestBody: required: true content: @@ -96614,9 +96990,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96642,8 +97018,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: - - *625 - - *297 + - *632 + - *304 - 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. @@ -96669,9 +97045,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *303 + default: *310 headers: Link: *37 x-github: @@ -96700,8 +97076,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: - - *625 - - *297 + - *632 + - *304 requestBody: required: true content: @@ -96733,9 +97109,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96759,7 +97135,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *625 + - *632 - *17 - *18 responses: @@ -96769,9 +97145,9 @@ paths: application/json: schema: type: array - items: *231 + items: *243 examples: - default: *232 + default: *244 headers: Link: *37 x-github: @@ -96797,7 +97173,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *625 + - *632 - name: role description: Filters members returned by their role in the team. in: query @@ -96820,7 +97196,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 '404': *6 @@ -96848,8 +97224,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *625 - - *178 + - *632 + - *190 responses: '204': description: if user is a member @@ -96885,8 +97261,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *625 - - *178 + - *632 + - *190 responses: '204': description: Response @@ -96925,8 +97301,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *625 - - *178 + - *632 + - *190 responses: '204': description: Response @@ -96962,16 +97338,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: - - *625 - - *178 + - *632 + - *190 responses: '200': description: Response content: application/json: - schema: *309 + schema: *316 examples: - response-if-user-is-a-team-maintainer: *630 + response-if-user-is-a-team-maintainer: *637 '404': *6 x-github: githubCloudOnly: false @@ -97004,8 +97380,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: - - *625 - - *178 + - *632 + - *190 requestBody: required: false content: @@ -97030,9 +97406,9 @@ paths: description: Response content: application/json: - schema: *309 + schema: *316 examples: - response-if-users-membership-with-team-is-now-pending: *631 + response-if-users-membership-with-team-is-now-pending: *638 '403': description: Forbidden if team synchronization is set up '422': @@ -97066,8 +97442,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: - - *625 - - *178 + - *632 + - *190 responses: '204': description: Response @@ -97096,7 +97472,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *625 + - *632 - *17 - *18 responses: @@ -97106,9 +97482,9 @@ paths: application/json: schema: type: array - items: *310 + items: *317 examples: - default: *632 + default: *639 headers: Link: *37 '404': *6 @@ -97135,16 +97511,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: - - *625 - - *311 + - *632 + - *318 responses: '200': description: Response content: application/json: - schema: *310 + schema: *317 examples: - default: *633 + default: *640 '404': description: Not Found if project is not managed by this team x-github: @@ -97169,8 +97545,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: - - *625 - - *311 + - *632 + - *318 requestBody: required: false content: @@ -97238,8 +97614,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: - - *625 - - *311 + - *632 + - *318 responses: '204': description: Response @@ -97266,7 +97642,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *625 + - *632 - *17 - *18 responses: @@ -97276,9 +97652,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 '404': *6 @@ -97308,15 +97684,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: - - *625 - - *312 - - *313 + - *632 + - *319 + - *320 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *634 + schema: *641 examples: alternative-response-with-extra-repository-information: value: @@ -97467,9 +97843,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: - - *625 - - *312 - - *313 + - *632 + - *319 + - *320 requestBody: required: false content: @@ -97519,9 +97895,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: - - *625 - - *312 - - *313 + - *632 + - *319 + - *320 responses: '204': description: Response @@ -97550,15 +97926,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: - - *625 + - *632 responses: '200': description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '403': *27 '404': *6 x-github: @@ -97585,7 +97961,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: - - *625 + - *632 requestBody: required: true content: @@ -97646,7 +98022,7 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: default: value: @@ -97677,7 +98053,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *625 + - *632 - *17 - *18 responses: @@ -97687,9 +98063,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - response-if-child-teams-exist: *635 + response-if-child-teams-exist: *642 headers: Link: *37 '404': *6 @@ -97722,7 +98098,7 @@ paths: application/json: schema: oneOf: - - &637 + - &644 title: Private User description: Private User type: object @@ -97972,7 +98348,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *636 + - *643 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -98132,7 +98508,7 @@ paths: description: Response content: application/json: - schema: *637 + schema: *644 examples: default: value: @@ -98211,7 +98587,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 '304': *35 '404': *6 '403': *27 @@ -98234,7 +98610,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: - - *178 + - *190 responses: '204': description: If the user is blocked @@ -98262,7 +98638,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *178 + - *190 responses: '204': description: Response @@ -98286,7 +98662,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *178 + - *190 responses: '204': description: Response @@ -98335,9 +98711,9 @@ paths: type: integer codespaces: type: array - items: *238 + items: *250 examples: - default: *239 + default: *251 '304': *35 '500': *80 '401': *23 @@ -98476,21 +98852,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '401': *23 '403': *27 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98530,7 +98906,7 @@ paths: type: integer secrets: type: array - items: &638 + items: &645 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -98572,7 +98948,7 @@ paths: - visibility - selected_repositories_url examples: - default: *418 + default: *425 headers: Link: *37 x-github: @@ -98644,13 +99020,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: - - *166 + - *178 responses: '200': description: Response content: application/json: - schema: *638 + schema: *645 examples: default: value: @@ -98680,7 +99056,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: - - *166 + - *178 requestBody: required: true content: @@ -98725,7 +99101,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -98753,7 +99129,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: - - *166 + - *178 responses: '204': description: Response @@ -98778,7 +99154,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: - - *166 + - *178 responses: '200': description: Response @@ -98794,9 +99170,9 @@ paths: type: integer repositories: type: array - items: *156 + items: *168 examples: - default: *639 + default: *646 '401': *23 '403': *27 '404': *6 @@ -98821,7 +99197,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: - - *166 + - *178 requestBody: required: true content: @@ -98875,7 +99251,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: - - *166 + - *178 - name: repository_id in: path required: true @@ -98908,7 +99284,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: - - *166 + - *178 - name: repository_id in: path required: true @@ -98940,15 +99316,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: - - *240 + - *252 responses: '200': description: Response content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '304': *35 '500': *80 '401': *23 @@ -98974,7 +99350,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: - - *240 + - *252 requestBody: required: false content: @@ -99004,9 +99380,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '401': *23 '403': *27 '404': *6 @@ -99028,9 +99404,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: - - *240 + - *252 responses: - '202': *144 + '202': *156 '304': *35 '500': *80 '401': *23 @@ -99057,13 +99433,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: - - *240 + - *252 responses: '202': description: Response content: application/json: - schema: &640 + schema: &647 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -99116,7 +99492,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &641 + default: &648 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -99148,7 +99524,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *240 + - *252 - name: export_id in: path required: true @@ -99161,9 +99537,9 @@ paths: description: Response content: application/json: - schema: *640 + schema: *647 examples: - default: *641 + default: *648 '404': *6 x-github: githubCloudOnly: false @@ -99184,7 +99560,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *240 + - *252 responses: '200': description: Response @@ -99200,9 +99576,9 @@ paths: type: integer machines: type: array - items: *417 + items: *424 examples: - default: *642 + default: *649 '304': *35 '500': *80 '401': *23 @@ -99231,7 +99607,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: - - *240 + - *252 requestBody: required: true content: @@ -99287,11 +99663,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *325 + repository: *332 machine: anyOf: - type: 'null' - - *417 + - *424 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -100088,15 +100464,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: - - *240 + - *252 responses: '200': description: Response content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '304': *35 '500': *80 '400': *14 @@ -100108,7 +100484,7 @@ paths: schema: *3 '403': *27 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100128,15 +100504,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: - - *240 + - *252 responses: '200': description: Response content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '500': *80 '401': *23 '403': *27 @@ -100166,9 +100542,9 @@ paths: application/json: schema: type: array - items: *249 + items: *261 examples: - default: &655 + default: &662 value: - id: 197 name: hello_docker @@ -100269,7 +100645,7 @@ paths: application/json: schema: type: array - items: &643 + items: &650 title: Email description: Email type: object @@ -100339,9 +100715,9 @@ paths: application/json: schema: type: array - items: *643 + items: *650 examples: - default: &657 + default: &664 value: - email: octocat@github.com verified: true @@ -100418,7 +100794,7 @@ paths: application/json: schema: type: array - items: *643 + items: *650 examples: default: value: @@ -100530,7 +100906,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 '304': *35 @@ -100563,7 +100939,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 '304': *35 @@ -100585,7 +100961,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: - - *178 + - *190 responses: '204': description: if the person is followed by the authenticated user @@ -100615,7 +100991,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *178 + - *190 responses: '204': description: Response @@ -100640,7 +101016,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *178 + - *190 responses: '204': description: Response @@ -100676,7 +101052,7 @@ paths: application/json: schema: type: array - items: &644 + items: &651 title: GPG Key description: A unique encryption key type: object @@ -100821,7 +101197,7 @@ paths: - subkeys - revoked examples: - default: &668 + default: &675 value: - id: 3 name: Octocat's GPG Key @@ -100906,9 +101282,9 @@ paths: description: Response content: application/json: - schema: *644 + schema: *651 examples: - default: &645 + default: &652 value: id: 3 name: Octocat's GPG Key @@ -100965,7 +101341,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: - - &646 + - &653 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -100977,9 +101353,9 @@ paths: description: Response content: application/json: - schema: *644 + schema: *651 examples: - default: *645 + default: *652 '404': *6 '304': *35 '403': *27 @@ -101002,7 +101378,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: - - *646 + - *653 responses: '204': description: Response @@ -101193,7 +101569,7 @@ paths: type: array items: *55 examples: - default: *647 + default: *654 headers: Link: *37 '404': *6 @@ -101218,7 +101594,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *151 + - *163 responses: '204': description: Response @@ -101244,7 +101620,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *151 + - *163 responses: '204': description: Response @@ -101278,12 +101654,12 @@ paths: application/json: schema: anyOf: - - *229 + - *241 - type: object properties: {} additionalProperties: false examples: - default: *230 + default: *242 '204': description: Response when there are no restrictions x-github: @@ -101307,7 +101683,7 @@ paths: required: true content: application/json: - schema: *485 + schema: *492 examples: default: value: @@ -101318,7 +101694,7 @@ paths: description: Response content: application/json: - schema: *229 + schema: *241 examples: default: value: @@ -101399,7 +101775,7 @@ paths: - closed - all default: open - - *235 + - *247 - name: sort description: What to sort results by. in: query @@ -101412,7 +101788,7 @@ paths: - comments default: created - *76 - - *106 + - *118 - *17 - *18 responses: @@ -101422,9 +101798,9 @@ paths: application/json: schema: type: array - items: *116 + items: *128 examples: - default: *236 + default: *248 headers: Link: *37 '404': *6 @@ -101457,7 +101833,7 @@ paths: application/json: schema: type: array - items: &648 + items: &655 title: Key description: Key type: object @@ -101555,9 +101931,9 @@ paths: description: Response content: application/json: - schema: *648 + schema: *655 examples: - default: &649 + default: &656 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -101590,15 +101966,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: - - *512 + - *519 responses: '200': description: Response content: application/json: - schema: *648 + schema: *655 examples: - default: *649 + default: *656 '404': *6 '304': *35 '403': *27 @@ -101621,7 +101997,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: - - *512 + - *519 responses: '204': description: Response @@ -101654,7 +102030,7 @@ paths: application/json: schema: type: array - items: &650 + items: &657 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -101722,7 +102098,7 @@ paths: - id - type - login - plan: *119 + plan: *131 required: - billing_cycle - next_billing_date @@ -101733,7 +102109,7 @@ paths: - account - plan examples: - default: &651 + default: &658 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -101795,9 +102171,9 @@ paths: application/json: schema: type: array - items: *650 + items: *657 examples: - default: *651 + default: *658 headers: Link: *37 '304': *35 @@ -101837,7 +102213,7 @@ paths: application/json: schema: type: array - items: *241 + items: *253 examples: default: value: @@ -101939,13 +102315,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: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: *241 + schema: *253 examples: default: value: @@ -102003,7 +102379,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: - - *138 + - *150 requestBody: required: true content: @@ -102028,7 +102404,7 @@ paths: description: Response content: application/json: - schema: *241 + schema: *253 examples: default: value: @@ -102096,7 +102472,7 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: default: value: @@ -102358,7 +102734,7 @@ paths: description: Response content: application/json: - schema: *243 + schema: *255 examples: default: value: @@ -102538,7 +102914,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *244 + - *256 - name: exclude in: query required: false @@ -102551,7 +102927,7 @@ paths: description: Response content: application/json: - schema: *243 + schema: *255 examples: default: value: @@ -102745,7 +103121,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *244 + - *256 responses: '302': description: Response @@ -102771,7 +103147,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *244 + - *256 responses: '204': description: Response @@ -102800,8 +103176,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *244 - - *652 + - *256 + - *659 responses: '204': description: Response @@ -102825,7 +103201,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *244 + - *256 - *17 - *18 responses: @@ -102835,9 +103211,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 '404': *6 @@ -102874,7 +103250,7 @@ paths: type: array items: *50 examples: - default: *653 + default: *660 headers: Link: *37 '304': *35 @@ -102916,7 +103292,7 @@ paths: - docker - nuget - container - - *654 + - *661 - *18 - *17 responses: @@ -102926,10 +103302,10 @@ paths: application/json: schema: type: array - items: *249 + items: *261 examples: - default: *655 - '400': *656 + default: *662 + '400': *663 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -102949,16 +103325,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: - - *251 - - *252 + - *263 + - *264 responses: '200': description: Response content: application/json: - schema: *249 + schema: *261 examples: - default: &669 + default: &676 value: id: 40201 name: octo-name @@ -103071,8 +103447,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: - - *251 - - *252 + - *263 + - *264 responses: '204': description: Response @@ -103102,8 +103478,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: - - *251 - - *252 + - *263 + - *264 - name: token description: package token schema: @@ -103135,8 +103511,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: - - *251 - - *252 + - *263 + - *264 - *18 - *17 - name: state @@ -103156,7 +103532,7 @@ paths: application/json: schema: type: array - items: *253 + items: *265 examples: default: value: @@ -103205,15 +103581,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: - - *251 - - *252 - - *254 + - *263 + - *264 + - *266 responses: '200': description: Response content: application/json: - schema: *253 + schema: *265 examples: default: value: @@ -103249,9 +103625,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: - - *251 - - *252 - - *254 + - *263 + - *264 + - *266 responses: '204': description: Response @@ -103281,9 +103657,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: - - *251 - - *252 - - *254 + - *263 + - *264 + - *266 responses: '204': description: Response @@ -103341,7 +103717,7 @@ paths: description: Response content: application/json: - schema: *262 + schema: *274 examples: default: value: @@ -103410,9 +103786,9 @@ paths: application/json: schema: type: array - items: *643 + items: *650 examples: - default: *657 + default: *664 headers: Link: *37 '304': *35 @@ -103525,7 +103901,7 @@ paths: type: array items: *55 examples: - default: &664 + default: &671 summary: Default response value: - id: 1296269 @@ -103841,9 +104217,9 @@ paths: description: Response content: application/json: - schema: *325 + schema: *332 examples: - default: *327 + default: *334 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -103881,9 +104257,9 @@ paths: application/json: schema: type: array - items: *487 + items: *494 examples: - default: *658 + default: *665 headers: Link: *37 '304': *35 @@ -103906,12 +104282,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *233 + - *245 responses: '204': description: Response '403': *27 - '409': *143 + '409': *155 '404': *6 '304': *35 x-github: @@ -103929,11 +104305,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *233 + - *245 responses: '204': description: Response - '409': *143 + '409': *155 '304': *35 '404': *6 '403': *27 @@ -103962,7 +104338,7 @@ paths: application/json: schema: type: array - items: &659 + items: &666 title: Social account description: Social media account type: object @@ -103979,7 +104355,7 @@ paths: - provider - url examples: - default: &660 + default: &667 value: - provider: twitter url: https://twitter.com/github @@ -104042,9 +104418,9 @@ paths: application/json: schema: type: array - items: *659 + items: *666 examples: - default: *660 + default: *667 '422': *15 '304': *35 '404': *6 @@ -104132,7 +104508,7 @@ paths: application/json: schema: type: array - items: &661 + items: &668 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -104152,7 +104528,7 @@ paths: - title - created_at examples: - default: &670 + default: &677 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -104219,9 +104595,9 @@ paths: description: Response content: application/json: - schema: *661 + schema: *668 examples: - default: &662 + default: &669 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -104252,7 +104628,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: - - &663 + - &670 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -104264,9 +104640,9 @@ paths: description: Response content: application/json: - schema: *661 + schema: *668 examples: - default: *662 + default: *669 '404': *6 '304': *35 '403': *27 @@ -104289,7 +104665,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: - - *663 + - *670 responses: '204': description: Response @@ -104318,7 +104694,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: - - &671 + - &678 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 @@ -104343,11 +104719,11 @@ paths: type: array items: *55 examples: - default-response: *664 + default-response: *671 application/vnd.github.v3.star+json: schema: type: array - items: &672 + items: &679 title: Starred Repository description: Starred Repository type: object @@ -104503,8 +104879,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: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response if this repository is starred by you @@ -104532,8 +104908,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: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -104557,8 +104933,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: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -104591,9 +104967,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 '304': *35 @@ -104630,7 +105006,7 @@ paths: application/json: schema: type: array - items: *293 + items: *300 examples: default: value: @@ -104706,7 +105082,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *121 + - *133 responses: '200': description: Response @@ -104714,10 +105090,10 @@ paths: application/json: schema: oneOf: - - *637 - - *636 + - *644 + - *643 examples: - default-response: &666 + default-response: &673 summary: Default response value: login: octocat @@ -104752,7 +105128,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &667 + response-with-git-hub-plan-information: &674 summary: Response with GitHub plan information value: login: octocat @@ -104812,7 +105188,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *665 + - *672 - *17 responses: '200': @@ -104823,7 +105199,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: example: ; rel="next" @@ -104851,7 +105227,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *178 + - *190 responses: '200': description: Response @@ -104859,11 +105235,11 @@ paths: application/json: schema: oneOf: - - *637 - - *636 + - *644 + - *643 examples: - default-response: *666 - response-with-git-hub-plan-information: *667 + default-response: *673 + response-with-git-hub-plan-information: *674 '404': *6 x-github: githubCloudOnly: false @@ -104889,7 +105265,7 @@ paths: - *17 - *74 - *75 - - *178 + - *190 - name: subject_digest description: Subject Digest in: path @@ -104984,6 +105360,8 @@ paths: type: string repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -104991,7 +105369,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -105017,7 +105395,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: - - *178 + - *190 responses: '200': description: Response @@ -105025,9 +105403,9 @@ paths: application/json: schema: type: array - items: *249 + items: *261 examples: - default: *655 + default: *662 '403': *27 '401': *23 x-github: @@ -105050,7 +105428,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *178 + - *190 - *17 - *18 responses: @@ -105060,7 +105438,7 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: default: value: @@ -105131,8 +105509,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: - - *178 - - *138 + - *190 + - *150 - *17 - *18 responses: @@ -105142,7 +105520,7 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: default: value: @@ -105221,7 +105599,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *178 + - *190 - *17 - *18 responses: @@ -105231,7 +105609,7 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: default: value: @@ -105298,7 +105676,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *178 + - *190 - *17 - *18 responses: @@ -105310,7 +105688,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 x-github: @@ -105329,7 +105707,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *178 + - *190 - *17 - *18 responses: @@ -105341,7 +105719,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 x-github: @@ -105360,7 +105738,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: - - *178 + - *190 - name: target_user in: path required: true @@ -105387,8 +105765,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *178 - - *106 + - *190 + - *118 - *17 - *18 responses: @@ -105398,9 +105776,9 @@ paths: application/json: schema: type: array - items: *107 + items: *119 examples: - default: *108 + default: *120 headers: Link: *37 '422': *15 @@ -105421,7 +105799,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: - - *178 + - *190 - *17 - *18 responses: @@ -105431,9 +105809,9 @@ paths: application/json: schema: type: array - items: *644 + items: *651 examples: - default: *668 + default: *675 headers: Link: *37 x-github: @@ -105457,7 +105835,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *178 + - *190 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -105529,7 +105907,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: - - *178 + - *190 responses: '200': description: Response @@ -105537,7 +105915,7 @@ paths: application/json: schema: *20 examples: - default: *484 + default: *491 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105555,7 +105933,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *178 + - *190 - *17 - *18 responses: @@ -105603,7 +105981,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *178 + - *190 - *17 - *18 responses: @@ -105615,7 +105993,7 @@ paths: type: array items: *50 examples: - default: *653 + default: *660 headers: Link: *37 x-github: @@ -105654,8 +106032,8 @@ paths: - docker - nuget - container - - *654 - - *178 + - *661 + - *190 - *18 - *17 responses: @@ -105665,12 +106043,12 @@ paths: application/json: schema: type: array - items: *249 + items: *261 examples: - default: *655 + default: *662 '403': *27 '401': *23 - '400': *656 + '400': *663 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105690,17 +106068,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *251 - - *252 - - *178 + - *263 + - *264 + - *190 responses: '200': description: Response content: application/json: - schema: *249 + schema: *261 examples: - default: *669 + default: *676 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105721,9 +106099,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *251 - - *252 - - *178 + - *263 + - *264 + - *190 responses: '204': description: Response @@ -105755,9 +106133,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *251 - - *252 - - *178 + - *263 + - *264 + - *190 - name: token description: package token schema: @@ -105789,9 +106167,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: - - *251 - - *252 - - *178 + - *263 + - *264 + - *190 responses: '200': description: Response @@ -105799,7 +106177,7 @@ paths: application/json: schema: type: array - items: *253 + items: *265 examples: default: value: @@ -105857,16 +106235,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: - - *251 - - *252 - - *254 - - *178 + - *263 + - *264 + - *266 + - *190 responses: '200': description: Response content: application/json: - schema: *253 + schema: *265 examples: default: value: @@ -105901,10 +106279,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *251 - - *252 - - *178 - - *254 + - *263 + - *264 + - *190 + - *266 responses: '204': description: Response @@ -105936,10 +106314,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *251 - - *252 - - *178 - - *254 + - *263 + - *264 + - *190 + - *266 responses: '204': description: Response @@ -105962,7 +106340,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-user-projects parameters: - - *178 + - *190 - name: state description: Indicates the state of the projects to return. in: query @@ -105983,7 +106361,7 @@ paths: application/json: schema: type: array - items: *262 + items: *274 examples: default: value: @@ -106042,7 +106420,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: - - *178 + - *190 - *17 - *18 responses: @@ -106052,7 +106430,7 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: default: value: @@ -106131,7 +106509,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: - - *178 + - *190 - *17 - *18 responses: @@ -106141,7 +106519,7 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: default: value: @@ -106218,7 +106596,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *178 + - *190 - name: type description: Limit results to repositories of the specified type. in: query @@ -106261,9 +106639,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 x-github: @@ -106287,15 +106665,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: - - *178 + - *190 responses: '200': description: Response content: application/json: - schema: *285 + schema: *292 examples: - default: *286 + default: *293 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106317,15 +106695,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: - - *178 + - *190 responses: '200': description: Response content: application/json: - schema: *289 + schema: *296 examples: - default: *290 + default: *297 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106347,15 +106725,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: - - *178 + - *190 responses: '200': description: Response content: application/json: - schema: *291 + schema: *298 examples: - default: *292 + default: *299 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106373,7 +106751,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: - - *178 + - *190 - *17 - *18 responses: @@ -106383,9 +106761,9 @@ paths: application/json: schema: type: array - items: *659 + items: *666 examples: - default: *660 + default: *667 headers: Link: *37 x-github: @@ -106405,7 +106783,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: - - *178 + - *190 - *17 - *18 responses: @@ -106415,9 +106793,9 @@ paths: application/json: schema: type: array - items: *661 + items: *668 examples: - default: *670 + default: *677 headers: Link: *37 x-github: @@ -106441,8 +106819,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *178 - - *671 + - *190 + - *678 - *76 - *17 - *18 @@ -106454,11 +106832,11 @@ paths: schema: anyOf: - type: array - items: *672 + items: *679 - type: array items: *55 examples: - default-response: *664 + default-response: *671 headers: Link: *37 x-github: @@ -106477,7 +106855,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *178 + - *190 - *17 - *18 responses: @@ -106487,9 +106865,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 x-github: @@ -106618,7 +106996,7 @@ webhooks: type: string enum: - disabled - enterprise: &673 + enterprise: &680 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -106687,7 +107065,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &674 + installation: &681 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -106708,7 +107086,7 @@ webhooks: required: - id - node_id - organization: &675 + organization: &682 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -106781,7 +107159,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &676 + repository: &683 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -106810,7 +107188,7 @@ webhooks: license: anyOf: - type: 'null' - - *117 + - *129 organization: anyOf: - type: 'null' @@ -107694,10 +108072,10 @@ webhooks: type: string enum: - enabled - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -107773,11 +108151,11 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - rule: &677 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + rule: &684 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) @@ -108000,11 +108378,11 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - rule: *677 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + rule: *684 sender: *4 required: - action @@ -108192,11 +108570,11 @@ webhooks: - everyone required: - from - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - rule: *677 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + rule: *684 sender: *4 required: - action @@ -108269,7 +108647,7 @@ webhooks: required: true content: application/json: - schema: &680 + schema: &687 title: Exemption request cancellation event type: object properties: @@ -108277,11 +108655,11 @@ webhooks: type: string enum: - cancelled - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - exemption_request: &678 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + exemption_request: &685 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -108435,7 +108813,7 @@ webhooks: - array - 'null' description: The responses to the exemption request. - items: &679 + items: &686 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -108459,6 +108837,12 @@ webhooks: - approved - rejected - dismissed + reviewer_comment: + type: + - string + - 'null' + description: The comment the reviewer provided when responding + to the exemption request. created_at: type: string format: date-time @@ -108541,7 +108925,7 @@ webhooks: required: true content: application/json: - schema: &681 + schema: &688 title: Exemption request completed event type: object properties: @@ -108549,11 +108933,11 @@ webhooks: type: string enum: - completed - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - exemption_request: *678 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + exemption_request: *685 sender: *4 required: - action @@ -108625,7 +109009,7 @@ webhooks: required: true content: application/json: - schema: &682 + schema: &689 title: Exemption request created event type: object properties: @@ -108633,11 +109017,11 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - exemption_request: *678 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + exemption_request: *685 sender: *4 required: - action @@ -108709,7 +109093,7 @@ webhooks: required: true content: application/json: - schema: &683 + schema: &690 title: Exemption response dismissed event type: object properties: @@ -108717,12 +109101,12 @@ webhooks: type: string enum: - response_dismissed - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - exemption_request: *678 - exemption_response: *679 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + exemption_request: *685 + exemption_response: *686 sender: *4 required: - action @@ -108796,7 +109180,7 @@ webhooks: required: true content: application/json: - schema: &684 + schema: &691 title: Exemption response submitted event type: object properties: @@ -108804,12 +109188,12 @@ webhooks: type: string enum: - response_submitted - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - exemption_request: *678 - exemption_response: *679 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + exemption_request: *685 + exemption_response: *686 sender: *4 required: - action @@ -108882,7 +109266,7 @@ webhooks: required: true content: application/json: - schema: *680 + schema: *687 responses: '200': description: Return a 200 status to indicate that the data was received @@ -108949,7 +109333,7 @@ webhooks: required: true content: application/json: - schema: *681 + schema: *688 responses: '200': description: Return a 200 status to indicate that the data was received @@ -109016,7 +109400,7 @@ webhooks: required: true content: application/json: - schema: *682 + schema: *689 responses: '200': description: Return a 200 status to indicate that the data was received @@ -109083,7 +109467,7 @@ webhooks: required: true content: application/json: - schema: *683 + schema: *690 responses: '200': description: Return a 200 status to indicate that the data was received @@ -109151,7 +109535,7 @@ webhooks: required: true content: application/json: - schema: *684 + schema: *691 responses: '200': description: Return a 200 status to indicate that the data was received @@ -109229,7 +109613,7 @@ webhooks: type: string enum: - completed - check_run: &686 + check_run: &693 title: CheckRun description: A check performed on the code of a given code change type: object @@ -109297,8 +109681,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *382 - repository: *156 + items: *389 + repository: *168 status: type: string enum: @@ -109342,7 +109726,7 @@ webhooks: - examples: - neutral - deployment: *685 + deployment: *692 details_url: type: string examples: @@ -109402,7 +109786,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *382 + items: *389 started_at: type: string format: date-time @@ -109440,9 +109824,9 @@ webhooks: - output - app - pull_requests - installation: *674 - organization: *675 - repository: *676 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - check_run @@ -109835,10 +110219,10 @@ webhooks: type: string enum: - created - check_run: *686 - installation: *674 - organization: *675 - repository: *676 + check_run: *693 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - check_run @@ -110234,10 +110618,10 @@ webhooks: type: string enum: - requested_action - check_run: *686 - installation: *674 - organization: *675 - repository: *676 + check_run: *693 + installation: *681 + organization: *682 + repository: *683 requested_action: description: The action requested by the user. type: object @@ -110642,10 +111026,10 @@ webhooks: type: string enum: - rerequested - check_run: *686 - installation: *674 - organization: *675 - repository: *676 + check_run: *693 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - check_run @@ -111637,10 +112021,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -112325,10 +112709,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -113007,10 +113391,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -113317,20 +113701,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &687 + commit_oid: &694 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: *673 - installation: *674 - organization: *675 - ref: &688 + enterprise: *680 + installation: *681 + organization: *682 + ref: &695 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: *676 + repository: *683 sender: *4 required: - action @@ -113658,12 +114042,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *687 - enterprise: *673 - installation: *674 - organization: *675 - ref: *688 - repository: *676 + commit_oid: *694 + enterprise: *680 + installation: *681 + organization: *682 + ref: *695 + repository: *683 sender: *4 required: - action @@ -113761,7 +114145,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *394 + dismissed_comment: *401 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113936,12 +114320,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *687 - enterprise: *673 - installation: *674 - organization: *675 - ref: *688 - repository: *676 + commit_oid: *694 + enterprise: *680 + installation: *681 + organization: *682 + ref: *695 + repository: *683 sender: *4 required: - action @@ -114273,12 +114657,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *687 - enterprise: *673 - installation: *674 - organization: *675 - ref: *688 - repository: *676 + commit_oid: *694 + enterprise: *680 + installation: *681 + organization: *682 + ref: *695 + repository: *683 sender: *4 required: - action @@ -114547,9 +114931,9 @@ webhooks: type: - string - 'null' - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -114557,7 +114941,7 @@ webhooks: type: - string - 'null' - repository: *676 + repository: *683 sender: *4 required: - action @@ -114789,12 +115173,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *687 - enterprise: *673 - installation: *674 - organization: *675 - ref: *688 - repository: *676 + commit_oid: *694 + enterprise: *680 + installation: *681 + organization: *682 + ref: *695 + repository: *683 sender: *4 required: - action @@ -115056,10 +115440,10 @@ webhooks: - updated_at - author_association - body - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -115140,18 +115524,18 @@ webhooks: type: - string - 'null' - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *675 - pusher_type: &689 + organization: *682 + pusher_type: &696 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &690 + ref: &697 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -115161,7 +115545,7 @@ webhooks: enum: - tag - branch - repository: *676 + repository: *683 sender: *4 required: - ref @@ -115244,9 +115628,9 @@ webhooks: enum: - created definition: *92 - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 sender: *4 required: - action @@ -115331,9 +115715,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 sender: *4 required: - action @@ -115411,9 +115795,9 @@ webhooks: enum: - updated definition: *92 - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 sender: *4 required: - action @@ -115490,19 +115874,19 @@ webhooks: type: string enum: - updated - enterprise: *673 - installation: *674 - repository: *676 - organization: *675 + enterprise: *680 + installation: *681 + repository: *683 + organization: *682 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *263 + items: *276 old_property_values: type: array description: The old custom property values for the repository. - items: *263 + items: *276 required: - action - repository @@ -115578,18 +115962,18 @@ webhooks: title: delete event type: object properties: - enterprise: *673 - installation: *674 - organization: *675 - pusher_type: *689 - ref: *690 + enterprise: *680 + installation: *681 + organization: *682 + pusher_type: *696 + ref: *697 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *676 + repository: *683 sender: *4 required: - ref @@ -115673,11 +116057,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *443 - installation: *674 - organization: *675 - enterprise: *673 - repository: *676 + alert: *450 + installation: *681 + organization: *682 + enterprise: *680 + repository: *683 sender: *4 required: - action @@ -115761,11 +116145,11 @@ webhooks: type: string enum: - auto_reopened - alert: *443 - installation: *674 - organization: *675 - enterprise: *673 - repository: *676 + alert: *450 + installation: *681 + organization: *682 + enterprise: *680 + repository: *683 sender: *4 required: - action @@ -115849,11 +116233,11 @@ webhooks: type: string enum: - created - alert: *443 - installation: *674 - organization: *675 - enterprise: *673 - repository: *676 + alert: *450 + installation: *681 + organization: *682 + enterprise: *680 + repository: *683 sender: *4 required: - action @@ -115935,11 +116319,11 @@ webhooks: type: string enum: - dismissed - alert: *443 - installation: *674 - organization: *675 - enterprise: *673 - repository: *676 + alert: *450 + installation: *681 + organization: *682 + enterprise: *680 + repository: *683 sender: *4 required: - action @@ -116021,11 +116405,11 @@ webhooks: type: string enum: - fixed - alert: *443 - installation: *674 - organization: *675 - enterprise: *673 - repository: *676 + alert: *450 + installation: *681 + organization: *682 + enterprise: *680 + repository: *683 sender: *4 required: - action @@ -116108,11 +116492,11 @@ webhooks: type: string enum: - reintroduced - alert: *443 - installation: *674 - organization: *675 - enterprise: *673 - repository: *676 + alert: *450 + installation: *681 + organization: *682 + enterprise: *680 + repository: *683 sender: *4 required: - action @@ -116194,11 +116578,11 @@ webhooks: type: string enum: - reopened - alert: *443 - installation: *674 - organization: *675 - enterprise: *673 - repository: *676 + alert: *450 + installation: *681 + organization: *682 + enterprise: *680 + repository: *683 sender: *4 required: - action @@ -116275,9 +116659,9 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - key: &691 + enterprise: *680 + installation: *681 + key: &698 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -116315,8 +116699,8 @@ webhooks: - verified - created_at - read_only - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -116393,11 +116777,11 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - key: *691 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + key: *698 + organization: *682 + repository: *683 sender: *4 required: - action @@ -116969,12 +117353,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - workflow: &695 + workflow: &702 title: Workflow type: - object @@ -117712,13 +118096,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *449 + deployment: *456 pull_requests: type: array - items: *531 - repository: *676 - organization: *675 - installation: *674 + items: *538 + repository: *683 + organization: *682 + installation: *681 sender: *4 responses: '200': @@ -117789,7 +118173,7 @@ webhooks: type: string enum: - approved - approver: &692 + approver: &699 type: object properties: avatar_url: @@ -117832,11 +118216,11 @@ webhooks: type: string comment: type: string - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - reviewers: &693 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + reviewers: &700 type: array items: type: object @@ -117917,7 +118301,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &694 + workflow_job_run: &701 type: object properties: conclusion: @@ -118663,18 +119047,18 @@ webhooks: type: string enum: - rejected - approver: *692 + approver: *699 comment: type: string - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - reviewers: *693 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + reviewers: *700 sender: *4 since: type: string - workflow_job_run: *694 + workflow_job_run: *701 workflow_job_runs: type: array items: @@ -119391,13 +119775,13 @@ webhooks: type: string enum: - requested - enterprise: *673 + enterprise: *680 environment: type: string - installation: *674 - organization: *675 - repository: *676 - requestor: &700 + installation: *681 + organization: *682 + repository: *683 + requestor: &707 title: User type: - object @@ -121340,12 +121724,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - workflow: *695 + workflow: *702 workflow_run: title: Deployment Workflow Run type: @@ -122036,7 +122420,7 @@ webhooks: type: string enum: - answered - answer: &698 + answer: &705 type: object properties: author_association: @@ -122196,7 +122580,7 @@ webhooks: - created_at - updated_at - body - discussion: &696 + discussion: &703 title: Discussion description: A Discussion in a repository. type: object @@ -122492,7 +122876,7 @@ webhooks: - id labels: type: array - items: *494 + items: *501 required: - repository_url - category @@ -122514,10 +122898,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -122644,11 +123028,11 @@ webhooks: - from required: - category - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -122731,11 +123115,11 @@ webhooks: type: string enum: - closed - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -122817,7 +123201,7 @@ webhooks: type: string enum: - created - comment: &697 + comment: &704 type: object properties: author_association: @@ -122977,11 +123361,11 @@ webhooks: - updated_at - body - reactions - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123064,12 +123448,12 @@ webhooks: type: string enum: - deleted - comment: *697 - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + comment: *704 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123164,12 +123548,12 @@ webhooks: - from required: - body - comment: *697 - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + comment: *704 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123253,11 +123637,11 @@ webhooks: type: string enum: - created - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123339,11 +123723,11 @@ webhooks: type: string enum: - deleted - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123443,11 +123827,11 @@ webhooks: type: string required: - from - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123529,10 +123913,10 @@ webhooks: type: string enum: - labeled - discussion: *696 - enterprise: *673 - installation: *674 - label: &699 + discussion: *703 + enterprise: *680 + installation: *681 + label: &706 title: Label type: object properties: @@ -123565,8 +123949,8 @@ webhooks: - color - default - description - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123649,11 +124033,11 @@ webhooks: type: string enum: - locked - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123735,11 +124119,11 @@ webhooks: type: string enum: - pinned - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123821,11 +124205,11 @@ webhooks: type: string enum: - reopened - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123910,16 +124294,16 @@ webhooks: changes: type: object properties: - new_discussion: *696 - new_repository: *676 + new_discussion: *703 + new_repository: *683 required: - new_discussion - new_repository - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -124002,10 +124386,10 @@ webhooks: type: string enum: - unanswered - discussion: *696 - old_answer: *698 - organization: *675 - repository: *676 + discussion: *703 + old_answer: *705 + organization: *682 + repository: *683 sender: *4 required: - action @@ -124087,12 +124471,12 @@ webhooks: type: string enum: - unlabeled - discussion: *696 - enterprise: *673 - installation: *674 - label: *699 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + label: *706 + organization: *682 + repository: *683 sender: *4 required: - action @@ -124175,11 +124559,11 @@ webhooks: type: string enum: - unlocked - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -124261,11 +124645,11 @@ webhooks: type: string enum: - unpinned - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -124338,7 +124722,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *673 + enterprise: *680 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -125016,9 +125400,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *674 - organization: *675 - repository: *676 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - forkee @@ -125164,9 +125548,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 pages: description: The pages that were updated. type: array @@ -125204,7 +125588,7 @@ webhooks: - action - sha - html_url - repository: *676 + repository: *683 sender: *4 required: - pages @@ -125280,10 +125664,10 @@ webhooks: type: string enum: - created - enterprise: *673 + enterprise: *680 installation: *20 - organization: *675 - repositories: &701 + organization: *682 + repositories: &708 description: An array of repository objects that the installation can access. type: array @@ -125309,8 +125693,8 @@ webhooks: - name - full_name - private - repository: *676 - requester: *700 + repository: *683 + requester: *707 sender: *4 required: - action @@ -125385,11 +125769,11 @@ webhooks: type: string enum: - deleted - enterprise: *673 + enterprise: *680 installation: *20 - organization: *675 - repositories: *701 - repository: *676 + organization: *682 + repositories: *708 + repository: *683 requester: type: - 'null' @@ -125466,11 +125850,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *673 + enterprise: *680 installation: *20 - organization: *675 - repositories: *701 - repository: *676 + organization: *682 + repositories: *708 + repository: *683 requester: type: - 'null' @@ -125547,10 +125931,10 @@ webhooks: type: string enum: - added - enterprise: *673 + enterprise: *680 installation: *20 - organization: *675 - repositories_added: &702 + organization: *682 + repositories_added: &709 description: An array of repository objects, which were added to the installation. type: array @@ -125596,15 +125980,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *676 - repository_selection: &703 + repository: *683 + repository_selection: &710 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *700 + requester: *707 sender: *4 required: - action @@ -125683,10 +126067,10 @@ webhooks: type: string enum: - removed - enterprise: *673 + enterprise: *680 installation: *20 - organization: *675 - repositories_added: *702 + organization: *682 + repositories_added: *709 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -125713,9 +126097,9 @@ webhooks: - name - full_name - private - repository: *676 - repository_selection: *703 - requester: *700 + repository: *683 + repository_selection: *710 + requester: *707 sender: *4 required: - action @@ -125794,11 +126178,11 @@ webhooks: type: string enum: - suspend - enterprise: *673 + enterprise: *680 installation: *20 - organization: *675 - repositories: *701 - repository: *676 + organization: *682 + repositories: *708 + repository: *683 requester: type: - 'null' @@ -125981,10 +126365,10 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 target_type: type: string @@ -126063,11 +126447,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *673 + enterprise: *680 installation: *20 - organization: *675 - repositories: *701 - repository: *676 + organization: *682 + repositories: *708 + repository: *683 requester: type: - 'null' @@ -126315,8 +126699,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -127506,8 +127890,8 @@ webhooks: - state - locked - assignee - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -127587,7 +127971,7 @@ webhooks: type: string enum: - deleted - comment: &704 + comment: &711 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -127754,8 +128138,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -128943,8 +129327,8 @@ webhooks: - state - locked - assignee - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -129024,7 +129408,7 @@ webhooks: type: string enum: - edited - changes: &729 + changes: &736 description: The changes to the comment. type: object properties: @@ -129036,9 +129420,9 @@ webhooks: type: string required: - from - comment: *704 - enterprise: *673 - installation: *674 + comment: *711 + enterprise: *680 + installation: *681 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -130227,8 +130611,8 @@ webhooks: - state - locked - assignee - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -130310,10 +130694,10 @@ webhooks: type: string enum: - assigned - assignee: *700 - enterprise: *673 - installation: *674 - issue: &707 + assignee: *707 + enterprise: *680 + installation: *681 + issue: &714 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -131257,8 +131641,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -131338,8 +131722,8 @@ webhooks: type: string enum: - closed - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -132431,8 +132815,8 @@ webhooks: required: - state - closed_at - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -132511,8 +132895,8 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -133449,8 +133833,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -133529,8 +133913,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -134471,7 +134855,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &705 + milestone: &712 title: Milestone description: A collection of related issues and pull requests. type: object @@ -134614,8 +134998,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -134714,8 +135098,8 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -135659,9 +136043,9 @@ webhooks: - active_lock_reason - body - reactions - label: *699 - organization: *675 - repository: *676 + label: *706 + organization: *682 + repository: *683 sender: *4 required: - action @@ -135741,8 +136125,8 @@ webhooks: type: string enum: - labeled - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -136685,9 +137069,9 @@ webhooks: - active_lock_reason - body - reactions - label: *699 - organization: *675 - repository: *676 + label: *706 + organization: *682 + repository: *683 sender: *4 required: - action @@ -136767,8 +137151,8 @@ webhooks: type: string enum: - locked - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -137713,8 +138097,8 @@ webhooks: format: uri user_view_type: type: string - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -137793,8 +138177,8 @@ webhooks: type: string enum: - milestoned - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -138733,9 +139117,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *705 - organization: *675 - repository: *676 + milestone: *712 + organization: *682 + repository: *683 sender: *4 required: - action @@ -140235,8 +140619,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -141179,8 +141563,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -141260,9 +141644,9 @@ webhooks: type: string enum: - pinned - enterprise: *673 - installation: *674 - issue: &706 + enterprise: *680 + installation: *681 + issue: &713 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -142199,8 +142583,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -142279,8 +142663,8 @@ webhooks: type: string enum: - reopened - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -143224,8 +143608,8 @@ webhooks: format: uri user_view_type: type: string - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -144725,11 +145109,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *673 - installation: *674 - issue: *706 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + issue: *713 + organization: *682 + repository: *683 sender: *4 required: - action @@ -144810,7 +145194,7 @@ webhooks: type: string enum: - unassigned - assignee: &732 + assignee: &739 title: User type: - object @@ -144882,11 +145266,11 @@ webhooks: required: - login - id - enterprise: *673 - installation: *674 - issue: *707 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + issue: *714 + organization: *682 + repository: *683 sender: *4 required: - action @@ -144965,12 +145349,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *673 - installation: *674 - issue: *707 - label: *699 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + issue: *714 + label: *706 + organization: *682 + repository: *683 sender: *4 required: - action @@ -145050,8 +145434,8 @@ webhooks: type: string enum: - unlocked - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -145994,8 +146378,8 @@ webhooks: format: uri user_view_type: type: string - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -146075,11 +146459,11 @@ webhooks: type: string enum: - unpinned - enterprise: *673 - installation: *674 - issue: *706 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + issue: *713 + organization: *682 + repository: *683 sender: *4 required: - action @@ -146158,11 +146542,11 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - label: *699 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + label: *706 + organization: *682 + repository: *683 sender: *4 required: - action @@ -146240,11 +146624,11 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - label: *699 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + label: *706 + organization: *682 + repository: *683 sender: *4 required: - action @@ -146354,11 +146738,11 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 - label: *699 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + label: *706 + organization: *682 + repository: *683 sender: *4 required: - action @@ -146440,9 +146824,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *673 - installation: *674 - marketplace_purchase: &708 + enterprise: *680 + installation: *681 + marketplace_purchase: &715 title: Marketplace Purchase type: object required: @@ -146530,8 +146914,8 @@ webhooks: type: integer unit_count: type: integer - organization: *675 - previous_marketplace_purchase: &709 + organization: *682 + previous_marketplace_purchase: &716 title: Marketplace Purchase type: object properties: @@ -146615,7 +146999,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *676 + repository: *683 sender: *4 required: - action @@ -146695,10 +147079,10 @@ webhooks: - changed effective_date: type: string - enterprise: *673 - installation: *674 - marketplace_purchase: *708 - organization: *675 + enterprise: *680 + installation: *681 + marketplace_purchase: *715 + organization: *682 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -146786,7 +147170,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *676 + repository: *683 sender: *4 required: - action @@ -146868,10 +147252,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *673 - installation: *674 - marketplace_purchase: *708 - organization: *675 + enterprise: *680 + installation: *681 + marketplace_purchase: *715 + organization: *682 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -146957,7 +147341,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *676 + repository: *683 sender: *4 required: - action @@ -147038,8 +147422,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 marketplace_purchase: title: Marketplace Purchase type: object @@ -147125,9 +147509,9 @@ webhooks: type: integer unit_count: type: integer - organization: *675 - previous_marketplace_purchase: *709 - repository: *676 + organization: *682 + previous_marketplace_purchase: *716 + repository: *683 sender: *4 required: - action @@ -147207,12 +147591,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *673 - installation: *674 - marketplace_purchase: *708 - organization: *675 - previous_marketplace_purchase: *709 - repository: *676 + enterprise: *680 + installation: *681 + marketplace_purchase: *715 + organization: *682 + previous_marketplace_purchase: *716 + repository: *683 sender: *4 required: - action @@ -147314,11 +147698,11 @@ webhooks: type: string required: - to - enterprise: *673 - installation: *674 - member: *700 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + member: *707 + organization: *682 + repository: *683 sender: *4 required: - action @@ -147420,11 +147804,11 @@ webhooks: type: - string - 'null' - enterprise: *673 - installation: *674 - member: *700 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + member: *707 + organization: *682 + repository: *683 sender: *4 required: - action @@ -147503,11 +147887,11 @@ webhooks: type: string enum: - removed - enterprise: *673 - installation: *674 - member: *700 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + member: *707 + organization: *682 + repository: *683 sender: *4 required: - action @@ -147585,11 +147969,11 @@ webhooks: type: string enum: - added - enterprise: *673 - installation: *674 - member: *700 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + member: *707 + organization: *682 + repository: *683 scope: description: The scope of the membership. Currently, can only be `team`. @@ -147667,7 +148051,7 @@ webhooks: required: - login - id - team: &710 + team: &717 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -147860,11 +148244,11 @@ webhooks: type: string enum: - removed - enterprise: *673 - installation: *674 - member: *700 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + member: *707 + organization: *682 + repository: *683 scope: description: The scope of the membership. Currently, can only be `team`. @@ -147943,7 +148327,7 @@ webhooks: required: - login - id - team: *710 + team: *717 required: - action - scope @@ -148025,8 +148409,8 @@ webhooks: type: string enum: - checks_requested - installation: *674 - merge_group: &711 + installation: *681 + merge_group: &718 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -148045,15 +148429,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *386 + head_commit: *393 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -148139,10 +148523,10 @@ webhooks: - merged - invalidated - dequeued - installation: *674 - merge_group: *711 - organization: *675 - repository: *676 + installation: *681 + merge_group: *718 + organization: *682 + repository: *683 sender: *4 required: - action @@ -148215,7 +148599,7 @@ webhooks: type: string enum: - deleted - enterprise: *673 + enterprise: *680 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -148323,12 +148707,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *674 - organization: *675 + installation: *681 + organization: *682 repository: anyOf: - type: 'null' - - *676 + - *683 sender: *4 required: - action @@ -148408,11 +148792,11 @@ webhooks: type: string enum: - closed - enterprise: *673 - installation: *674 - milestone: *705 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + milestone: *712 + organization: *682 + repository: *683 sender: *4 required: - action @@ -148491,9 +148875,9 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - milestone: &712 + enterprise: *680 + installation: *681 + milestone: &719 title: Milestone description: A collection of related issues and pull requests. type: object @@ -148635,8 +149019,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -148715,11 +149099,11 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - milestone: *705 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + milestone: *712 + organization: *682 + repository: *683 sender: *4 required: - action @@ -148829,11 +149213,11 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 - milestone: *705 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + milestone: *712 + organization: *682 + repository: *683 sender: *4 required: - action @@ -148913,11 +149297,11 @@ webhooks: type: string enum: - opened - enterprise: *673 - installation: *674 - milestone: *712 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + milestone: *719 + organization: *682 + repository: *683 sender: *4 required: - action @@ -148996,11 +149380,11 @@ webhooks: type: string enum: - blocked - blocked_user: *700 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + blocked_user: *707 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -149079,11 +149463,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *700 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + blocked_user: *707 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -149162,9 +149546,9 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - membership: &713 + enterprise: *680 + installation: *681 + membership: &720 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -149258,8 +149642,8 @@ webhooks: - role - organization_url - user - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -149337,11 +149721,11 @@ webhooks: type: string enum: - member_added - enterprise: *673 - installation: *674 - membership: *713 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + membership: *720 + organization: *682 + repository: *683 sender: *4 required: - action @@ -149420,8 +149804,8 @@ webhooks: type: string enum: - member_invited - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -149543,10 +149927,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 - user: *700 + user: *707 required: - action - invitation @@ -149624,11 +150008,11 @@ webhooks: type: string enum: - member_removed - enterprise: *673 - installation: *674 - membership: *713 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + membership: *720 + organization: *682 + repository: *683 sender: *4 required: - action @@ -149715,11 +150099,11 @@ webhooks: properties: from: type: string - enterprise: *673 - installation: *674 - membership: *713 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + membership: *720 + organization: *682 + repository: *683 sender: *4 required: - action @@ -149795,9 +150179,9 @@ webhooks: type: string enum: - published - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 package: description: Information about the package. type: object @@ -150320,7 +150704,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &714 + items: &721 title: Ruby Gems metadata type: object properties: @@ -150417,7 +150801,7 @@ webhooks: - owner - package_version - registry - repository: *676 + repository: *683 sender: *4 required: - action @@ -150493,9 +150877,9 @@ webhooks: type: string enum: - updated - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 package: description: Information about the package. type: object @@ -150857,7 +151241,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *714 + items: *721 source_url: type: string format: uri @@ -150928,7 +151312,7 @@ webhooks: - owner - package_version - registry - repository: *676 + repository: *683 sender: *4 required: - action @@ -151109,12 +151493,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *673 + enterprise: *680 id: type: integer - installation: *674 - organization: *675 - repository: *676 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - id @@ -151194,7 +151578,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &715 + personal_access_token_request: &722 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -151344,10 +151728,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *673 - organization: *675 + enterprise: *680 + organization: *682 sender: *4 - installation: *674 + installation: *681 required: - action - personal_access_token_request @@ -151426,11 +151810,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *715 - enterprise: *673 - organization: *675 + personal_access_token_request: *722 + enterprise: *680 + organization: *682 sender: *4 - installation: *674 + installation: *681 required: - action - personal_access_token_request @@ -151508,11 +151892,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *715 - enterprise: *673 - organization: *675 + personal_access_token_request: *722 + enterprise: *680 + organization: *682 sender: *4 - installation: *674 + installation: *681 required: - action - personal_access_token_request @@ -151589,11 +151973,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *715 - organization: *675 - enterprise: *673 + personal_access_token_request: *722 + organization: *682 + enterprise: *680 sender: *4 - installation: *674 + installation: *681 required: - action - personal_access_token_request @@ -151697,7 +152081,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *716 + last_response: *723 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -151729,8 +152113,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 zen: description: Random string of GitHub zen. @@ -151975,10 +152359,10 @@ webhooks: - from required: - note - enterprise: *673 - installation: *674 - organization: *675 - project_card: &717 + enterprise: *680 + installation: *681 + organization: *682 + project_card: &724 title: Project Card type: object properties: @@ -152101,7 +152485,7 @@ webhooks: - creator - created_at - updated_at - repository: *676 + repository: *683 sender: *4 required: - action @@ -152182,11 +152566,11 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - project_card: *717 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + project_card: *724 + repository: *683 sender: *4 required: - action @@ -152266,9 +152650,9 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 project_card: title: Project Card type: object @@ -152398,7 +152782,7 @@ webhooks: repository: anyOf: - type: 'null' - - *676 + - *683 sender: *4 required: - action @@ -152492,11 +152876,11 @@ webhooks: - from required: - note - enterprise: *673 - installation: *674 - organization: *675 - project_card: *717 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + project_card: *724 + repository: *683 sender: *4 required: - action @@ -152590,9 +152974,9 @@ webhooks: - from required: - column_id - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 project_card: allOf: - title: Project Card @@ -152789,7 +153173,7 @@ webhooks: type: string required: - after_id - repository: *676 + repository: *683 sender: *4 required: - action @@ -152869,10 +153253,10 @@ webhooks: type: string enum: - closed - enterprise: *673 - installation: *674 - organization: *675 - project: &719 + enterprise: *680 + installation: *681 + organization: *682 + project: &726 title: Project type: object properties: @@ -152999,7 +153383,7 @@ webhooks: - creator - created_at - updated_at - repository: *676 + repository: *683 sender: *4 required: - action @@ -153079,10 +153463,10 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - project_column: &718 + enterprise: *680 + installation: *681 + organization: *682 + project_column: &725 title: Project Column type: object properties: @@ -153122,7 +153506,7 @@ webhooks: - name - created_at - updated_at - repository: *676 + repository: *683 sender: *4 required: - action @@ -153201,14 +153585,14 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 - project_column: *718 + enterprise: *680 + installation: *681 + organization: *682 + project_column: *725 repository: anyOf: - type: 'null' - - *676 + - *683 sender: *4 required: - action @@ -153297,11 +153681,11 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 - organization: *675 - project_column: *718 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + project_column: *725 + repository: *683 sender: *4 required: - action @@ -153381,11 +153765,11 @@ webhooks: type: string enum: - moved - enterprise: *673 - installation: *674 - organization: *675 - project_column: *718 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + project_column: *725 + repository: *683 sender: *4 required: - action @@ -153465,11 +153849,11 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - project: *719 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + project: *726 + repository: *683 sender: *4 required: - action @@ -153549,14 +153933,14 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 - project: *719 + enterprise: *680 + installation: *681 + organization: *682 + project: *726 repository: anyOf: - type: 'null' - - *676 + - *683 sender: *4 required: - action @@ -153657,11 +154041,11 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 - organization: *675 - project: *719 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + project: *726 + repository: *683 sender: *4 required: - action @@ -153740,11 +154124,11 @@ webhooks: type: string enum: - reopened - enterprise: *673 - installation: *674 - organization: *675 - project: *719 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + project: *726 + repository: *683 sender: *4 required: - action @@ -153825,9 +154209,9 @@ webhooks: type: string enum: - closed - installation: *674 - organization: *675 - projects_v2: &720 + installation: *681 + organization: *682 + projects_v2: &727 title: Projects v2 Project description: A projects v2 project type: object @@ -153975,9 +154359,9 @@ webhooks: type: string enum: - created - installation: *674 - organization: *675 - projects_v2: *720 + installation: *681 + organization: *682 + projects_v2: *727 sender: *4 required: - action @@ -154058,9 +154442,9 @@ webhooks: type: string enum: - deleted - installation: *674 - organization: *675 - projects_v2: *720 + installation: *681 + organization: *682 + projects_v2: *727 sender: *4 required: - action @@ -154181,9 +154565,9 @@ webhooks: type: string to: type: string - installation: *674 - organization: *675 - projects_v2: *720 + installation: *681 + organization: *682 + projects_v2: *727 sender: *4 required: - action @@ -154266,7 +154650,7 @@ webhooks: type: string enum: - archived - changes: &724 + changes: &731 type: object properties: archived_at: @@ -154282,9 +154666,9 @@ webhooks: - string - 'null' format: date-time - installation: *674 - organization: *675 - projects_v2_item: &721 + installation: *681 + organization: *682 + projects_v2_item: &728 title: Projects v2 Item description: An item belonging to a project type: object @@ -154423,9 +154807,9 @@ webhooks: - 'null' to: type: string - installation: *674 - organization: *675 - projects_v2_item: *721 + installation: *681 + organization: *682 + projects_v2_item: *728 sender: *4 required: - action @@ -154507,9 +154891,9 @@ webhooks: type: string enum: - created - installation: *674 - organization: *675 - projects_v2_item: *721 + installation: *681 + organization: *682 + projects_v2_item: *728 sender: *4 required: - action @@ -154590,9 +154974,9 @@ webhooks: type: string enum: - deleted - installation: *674 - organization: *675 - projects_v2_item: *721 + installation: *681 + organization: *682 + projects_v2_item: *728 sender: *4 required: - action @@ -154697,7 +155081,7 @@ webhooks: oneOf: - type: string - type: integer - - &722 + - &729 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -154717,7 +155101,7 @@ webhooks: required: - id - name - - &723 + - &730 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -154746,8 +155130,8 @@ webhooks: oneOf: - type: string - type: integer - - *722 - - *723 + - *729 + - *730 type: - 'null' - string @@ -154770,9 +155154,9 @@ webhooks: - 'null' required: - body - installation: *674 - organization: *675 - projects_v2_item: *721 + installation: *681 + organization: *682 + projects_v2_item: *728 sender: *4 required: - action @@ -154869,9 +155253,9 @@ webhooks: type: - string - 'null' - installation: *674 - organization: *675 - projects_v2_item: *721 + installation: *681 + organization: *682 + projects_v2_item: *728 sender: *4 required: - action @@ -154954,10 +155338,10 @@ webhooks: type: string enum: - restored - changes: *724 - installation: *674 - organization: *675 - projects_v2_item: *721 + changes: *731 + installation: *681 + organization: *682 + projects_v2_item: *728 sender: *4 required: - action @@ -155039,9 +155423,9 @@ webhooks: type: string enum: - reopened - installation: *674 - organization: *675 - projects_v2: *720 + installation: *681 + organization: *682 + projects_v2: *727 sender: *4 required: - action @@ -155122,9 +155506,9 @@ webhooks: type: string enum: - created - installation: *674 - organization: *675 - projects_v2_status_update: &725 + installation: *681 + organization: *682 + projects_v2_status_update: &732 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -155259,9 +155643,9 @@ webhooks: type: string enum: - deleted - installation: *674 - organization: *675 - projects_v2_status_update: *725 + installation: *681 + organization: *682 + projects_v2_status_update: *732 sender: *4 required: - action @@ -155407,9 +155791,9 @@ webhooks: - string - 'null' format: date - installation: *674 - organization: *675 - projects_v2_status_update: *725 + installation: *681 + organization: *682 + projects_v2_status_update: *732 sender: *4 required: - action @@ -155480,10 +155864,10 @@ webhooks: title: public event type: object properties: - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - repository @@ -155560,13 +155944,13 @@ webhooks: type: string enum: - assigned - assignee: *700 - enterprise: *673 - installation: *674 - number: &726 + assignee: *707 + enterprise: *680 + installation: *681 + number: &733 description: The pull request number. type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -157915,7 +158299,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -157997,11 +158381,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 number: type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -160343,7 +160727,7 @@ webhooks: - draft reason: type: string - repository: *676 + repository: *683 sender: *4 required: - action @@ -160425,11 +160809,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 number: type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -162771,7 +163155,7 @@ webhooks: - draft reason: type: string - repository: *676 + repository: *683 sender: *4 required: - action @@ -162853,13 +163237,13 @@ webhooks: type: string enum: - closed - enterprise: *673 - installation: *674 - number: *726 - organization: *675 - pull_request: &727 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 + pull_request: &734 allOf: - - *531 + - *538 - type: object properties: allow_auto_merge: @@ -162921,7 +163305,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *676 + repository: *683 sender: *4 required: - action @@ -163002,12 +163386,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *673 - installation: *674 - number: *726 - organization: *675 - pull_request: *727 - repository: *676 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 + pull_request: *734 + repository: *683 sender: *4 required: - action @@ -163087,11 +163471,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *673 - milestone: *429 - number: *726 - organization: *675 - pull_request: &728 + enterprise: *680 + milestone: *436 + number: *733 + organization: *682 + pull_request: &735 title: Pull Request type: object properties: @@ -165418,7 +165802,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -165497,11 +165881,11 @@ webhooks: type: string enum: - dequeued - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 number: type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -167847,7 +168231,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *676 + repository: *683 sender: *4 required: - action @@ -167971,12 +168355,12 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 - number: *726 - organization: *675 - pull_request: *727 - repository: *676 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 + pull_request: *734 + repository: *683 sender: *4 required: - action @@ -168056,11 +168440,11 @@ webhooks: type: string enum: - enqueued - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 number: type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -170391,7 +170775,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -170471,11 +170855,11 @@ webhooks: type: string enum: - labeled - enterprise: *673 - installation: *674 - label: *699 - number: *726 - organization: *675 + enterprise: *680 + installation: *681 + label: *706 + number: *733 + organization: *682 pull_request: title: Pull Request type: object @@ -172823,7 +173207,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -172904,10 +173288,10 @@ webhooks: type: string enum: - locked - enterprise: *673 - installation: *674 - number: *726 - organization: *675 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 pull_request: title: Pull Request type: object @@ -175253,7 +175637,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -175333,12 +175717,12 @@ webhooks: type: string enum: - milestoned - enterprise: *673 - milestone: *429 - number: *726 - organization: *675 - pull_request: *728 - repository: *676 + enterprise: *680 + milestone: *436 + number: *733 + organization: *682 + pull_request: *735 + repository: *683 sender: *4 required: - action @@ -175417,12 +175801,12 @@ webhooks: type: string enum: - opened - enterprise: *673 - installation: *674 - number: *726 - organization: *675 - pull_request: *727 - repository: *676 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 + pull_request: *734 + repository: *683 sender: *4 required: - action @@ -175503,12 +175887,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *673 - installation: *674 - number: *726 - organization: *675 - pull_request: *727 - repository: *676 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 + pull_request: *734 + repository: *683 sender: *4 required: - action @@ -175588,12 +175972,12 @@ webhooks: type: string enum: - reopened - enterprise: *673 - installation: *674 - number: *726 - organization: *675 - pull_request: *727 - repository: *676 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 + pull_request: *734 + repository: *683 sender: *4 required: - action @@ -175968,9 +176352,9 @@ webhooks: - start_side - side - reactions - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 pull_request: type: object properties: @@ -178200,7 +178584,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *676 + repository: *683 sender: *4 required: - action @@ -178280,7 +178664,7 @@ webhooks: type: string enum: - deleted - comment: &730 + comment: &737 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. @@ -178573,9 +178957,9 @@ webhooks: - start_side - side - reactions - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 pull_request: type: object properties: @@ -180793,7 +181177,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *676 + repository: *683 sender: *4 required: - action @@ -180873,11 +181257,11 @@ webhooks: type: string enum: - edited - changes: *729 - comment: *730 - enterprise: *673 - installation: *674 - organization: *675 + changes: *736 + comment: *737 + enterprise: *680 + installation: *681 + organization: *682 pull_request: type: object properties: @@ -183098,7 +183482,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *676 + repository: *683 sender: *4 required: - action @@ -183179,9 +183563,9 @@ webhooks: type: string enum: - dismissed - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 pull_request: title: Simple Pull Request type: object @@ -185414,7 +185798,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *676 + repository: *683 review: description: The review that was affected. type: object @@ -185660,9 +186044,9 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 pull_request: title: Simple Pull Request type: object @@ -187776,8 +188160,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *676 - review: &731 + repository: *683 + review: &738 description: The review that was affected. type: object properties: @@ -188010,12 +188394,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 number: description: The pull request number. type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -190362,7 +190746,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 requested_reviewer: title: User type: @@ -190448,12 +190832,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 number: description: The pull request number. type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -192807,7 +193191,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 requested_team: title: Team description: Groups of organization members that gives permissions @@ -193002,12 +193386,12 @@ webhooks: type: string enum: - review_requested - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 number: description: The pull request number. type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -195356,7 +195740,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 requested_reviewer: title: User type: @@ -195443,12 +195827,12 @@ webhooks: type: string enum: - review_requested - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 number: description: The pull request number. type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -197788,7 +198172,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 requested_team: title: Team description: Groups of organization members that gives permissions @@ -197972,9 +198356,9 @@ webhooks: type: string enum: - submitted - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 pull_request: title: Simple Pull Request type: object @@ -200210,8 +200594,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *676 - review: *731 + repository: *683 + review: *738 sender: *4 required: - action @@ -200291,9 +200675,9 @@ webhooks: type: string enum: - resolved - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 pull_request: title: Simple Pull Request type: object @@ -202424,7 +202808,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *676 + repository: *683 sender: *4 thread: type: object @@ -202816,9 +203200,9 @@ webhooks: type: string enum: - unresolved - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 pull_request: title: Simple Pull Request type: object @@ -204932,7 +205316,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *676 + repository: *683 sender: *4 thread: type: object @@ -205326,10 +205710,10 @@ webhooks: type: string before: type: string - enterprise: *673 - installation: *674 - number: *726 - organization: *675 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 pull_request: title: Pull Request type: object @@ -207664,7 +208048,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -207746,11 +208130,11 @@ webhooks: type: string enum: - unassigned - assignee: *732 - enterprise: *673 - installation: *674 - number: *726 - organization: *675 + assignee: *739 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 pull_request: title: Pull Request type: object @@ -210100,7 +210484,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -210179,11 +210563,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *673 - installation: *674 - label: *699 - number: *726 - organization: *675 + enterprise: *680 + installation: *681 + label: *706 + number: *733 + organization: *682 pull_request: title: Pull Request type: object @@ -212522,7 +212906,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -212603,10 +212987,10 @@ webhooks: type: string enum: - unlocked - enterprise: *673 - installation: *674 - number: *726 - organization: *675 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 pull_request: title: Pull Request type: object @@ -214935,7 +215319,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -215138,7 +215522,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *673 + enterprise: *680 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -215233,8 +215617,8 @@ webhooks: - url - author - committer - installation: *674 - organization: *675 + installation: *681 + organization: *682 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -215822,9 +216206,9 @@ webhooks: type: string enum: - published - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 registry_package: type: object properties: @@ -216301,7 +216685,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *714 + items: *721 summary: type: string tag_name: @@ -216357,7 +216741,7 @@ webhooks: - owner - package_version - registry - repository: *676 + repository: *683 sender: *4 required: - action @@ -216435,9 +216819,9 @@ webhooks: type: string enum: - updated - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 registry_package: type: object properties: @@ -216749,7 +217133,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *714 + items: *721 summary: type: string tag_name: @@ -216799,7 +217183,7 @@ webhooks: - owner - package_version - registry - repository: *676 + repository: *683 sender: *4 required: - action @@ -216876,10 +217260,10 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - release: &733 + enterprise: *680 + installation: *681 + organization: *682 + release: &740 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -217195,7 +217579,7 @@ webhooks: - tarball_url - zipball_url - body - repository: *676 + repository: *683 sender: *4 required: - action @@ -217272,11 +217656,11 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 - release: *733 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + release: *740 + repository: *683 sender: *4 required: - action @@ -217384,11 +217768,11 @@ webhooks: type: boolean required: - to - enterprise: *673 - installation: *674 - organization: *675 - release: *733 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + release: *740 + repository: *683 sender: *4 required: - action @@ -217466,9 +217850,9 @@ webhooks: type: string enum: - prereleased - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -217789,7 +218173,7 @@ webhooks: - string - 'null' format: uri - repository: *676 + repository: *683 sender: *4 required: - action @@ -217865,10 +218249,10 @@ webhooks: type: string enum: - published - enterprise: *673 - installation: *674 - organization: *675 - release: &734 + enterprise: *680 + installation: *681 + organization: *682 + release: &741 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -218186,7 +218570,7 @@ webhooks: - string - 'null' format: uri - repository: *676 + repository: *683 sender: *4 required: - action @@ -218262,11 +218646,11 @@ webhooks: type: string enum: - released - enterprise: *673 - installation: *674 - organization: *675 - release: *733 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + release: *740 + repository: *683 sender: *4 required: - action @@ -218342,11 +218726,11 @@ webhooks: type: string enum: - unpublished - enterprise: *673 - installation: *674 - organization: *675 - release: *734 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + release: *741 + repository: *683 sender: *4 required: - action @@ -218422,11 +218806,11 @@ webhooks: type: string enum: - published - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - repository_advisory: *585 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + repository_advisory: *592 sender: *4 required: - action @@ -218502,11 +218886,11 @@ webhooks: type: string enum: - reported - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - repository_advisory: *585 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + repository_advisory: *592 sender: *4 required: - action @@ -218582,10 +218966,10 @@ webhooks: type: string enum: - archived - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -218662,10 +219046,10 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -218743,10 +219127,10 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -218831,10 +219215,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -218949,10 +219333,10 @@ webhooks: - 'null' items: type: string - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -219024,10 +219408,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 status: type: string @@ -219108,10 +219492,10 @@ webhooks: type: string enum: - privatized - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -219188,10 +219572,10 @@ webhooks: type: string enum: - publicized - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -219285,10 +219669,10 @@ webhooks: - name required: - repository - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -219368,11 +219752,11 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - repository_ruleset: *273 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + repository_ruleset: *105 sender: *4 required: - action @@ -219450,11 +219834,11 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - repository_ruleset: *273 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + repository_ruleset: *105 sender: *4 required: - action @@ -219532,11 +219916,11 @@ webhooks: type: string enum: - edited - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - repository_ruleset: *273 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + repository_ruleset: *105 changes: type: object properties: @@ -219555,16 +219939,16 @@ webhooks: properties: added: type: array - items: *267 + items: *98 deleted: type: array - items: *267 + items: *98 updated: type: array items: type: object properties: - condition: *267 + condition: *98 changes: type: object properties: @@ -219597,16 +219981,16 @@ webhooks: properties: added: type: array - items: *272 + items: *104 deleted: type: array - items: *272 + items: *104 updated: type: array items: type: object properties: - rule: *272 + rule: *104 changes: type: object properties: @@ -219843,10 +220227,10 @@ webhooks: - from required: - owner - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -219924,10 +220308,10 @@ webhooks: type: string enum: - unarchived - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -220005,7 +220389,7 @@ webhooks: type: string enum: - create - alert: &735 + alert: &742 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -220129,10 +220513,10 @@ webhooks: type: string enum: - open - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -220342,10 +220726,10 @@ webhooks: type: string enum: - dismissed - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -220423,11 +220807,11 @@ webhooks: type: string enum: - reopen - alert: *735 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + alert: *742 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -220629,10 +221013,10 @@ webhooks: enum: - fixed - open - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -220710,7 +221094,7 @@ webhooks: type: string enum: - created - alert: &736 + alert: &743 type: object properties: number: *81 @@ -220791,6 +221175,12 @@ webhooks: anyOf: - type: 'null' - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. push_protection_bypass_request_comment: type: - string @@ -220814,10 +221204,10 @@ webhooks: - 'null' description: Whether the detected secret was found in multiple repositories in the same organization or business. - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -220898,11 +221288,11 @@ webhooks: type: string enum: - created - alert: *736 - installation: *674 - location: *737 - organization: *675 - repository: *676 + alert: *743 + installation: *681 + location: *744 + organization: *682 + repository: *683 sender: *4 required: - location @@ -221140,11 +221530,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *736 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + alert: *743 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -221222,11 +221612,11 @@ webhooks: type: string enum: - reopened - alert: *736 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + alert: *743 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -221304,11 +221694,11 @@ webhooks: type: string enum: - resolved - alert: *736 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + alert: *743 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -221386,11 +221776,11 @@ webhooks: type: string enum: - validated - alert: *736 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + alert: *743 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -221466,11 +221856,11 @@ webhooks: type: string enum: - published - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - security_advisory: &738 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + security_advisory: &745 description: The details of the security advisory, including summary, description, and severity. type: object @@ -221656,11 +222046,11 @@ webhooks: type: string enum: - updated - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - security_advisory: *738 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + security_advisory: *745 sender: *4 required: - action @@ -221733,10 +222123,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -221922,11 +222312,11 @@ webhooks: from: type: object properties: - security_and_analysis: *264 - enterprise: *673 - installation: *674 - organization: *675 - repository: *325 + security_and_analysis: *277 + enterprise: *680 + installation: *681 + organization: *682 + repository: *332 sender: *4 required: - changes @@ -222004,12 +222394,12 @@ webhooks: type: string enum: - cancelled - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - sponsorship: &739 + sponsorship: &746 type: object properties: created_at: @@ -222314,12 +222704,12 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - sponsorship: *739 + sponsorship: *746 required: - action - sponsorship @@ -222407,12 +222797,12 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - sponsorship: *739 + sponsorship: *746 required: - action - changes @@ -222489,17 +222879,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &740 + effective_date: &747 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - sponsorship: *739 + sponsorship: *746 required: - action - sponsorship @@ -222573,7 +222963,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &741 + changes: &748 type: object properties: tier: @@ -222617,13 +223007,13 @@ webhooks: - from required: - tier - effective_date: *740 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + effective_date: *747 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - sponsorship: *739 + sponsorship: *746 required: - action - changes @@ -222700,13 +223090,13 @@ webhooks: type: string enum: - tier_changed - changes: *741 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + changes: *748 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - sponsorship: *739 + sponsorship: *746 required: - action - changes @@ -222780,10 +223170,10 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -222867,10 +223257,10 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -223303,15 +223693,15 @@ webhooks: type: - string - 'null' - enterprise: *673 + enterprise: *680 id: description: The unique identifier of the status. type: integer - installation: *674 + installation: *681 name: type: string - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 sha: description: The Commit SHA. @@ -223421,15 +223811,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *116 + parent_issue: *128 parent_issue_repo: *55 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *116 - installation: *674 - organization: *675 - repository: *676 + sub_issue: *128 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -223513,15 +223903,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *116 + parent_issue: *128 parent_issue_repo: *55 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *116 - installation: *674 - organization: *675 - repository: *676 + sub_issue: *128 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -223605,15 +223995,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *116 + sub_issue: *128 sub_issue_repo: *55 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *116 - installation: *674 - organization: *675 - repository: *676 + parent_issue: *128 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -223697,15 +224087,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *116 + sub_issue: *128 sub_issue_repo: *55 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *116 - installation: *674 - organization: *675 - repository: *676 + parent_issue: *128 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -223782,12 +224172,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - team: &742 + team: &749 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -223980,9 +224370,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 repository: title: Repository description: A git repository @@ -224452,7 +224842,7 @@ webhooks: - topics - visibility sender: *4 - team: *742 + team: *749 required: - action - team @@ -224528,9 +224918,9 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 repository: title: Repository description: A git repository @@ -225000,7 +225390,7 @@ webhooks: - topics - visibility sender: *4 - team: *742 + team: *749 required: - action - team @@ -225077,9 +225467,9 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 repository: title: Repository description: A git repository @@ -225549,7 +225939,7 @@ webhooks: - topics - visibility sender: *4 - team: *742 + team: *749 required: - action - team @@ -225693,9 +226083,9 @@ webhooks: - from required: - permissions - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 repository: title: Repository description: A git repository @@ -226165,7 +226555,7 @@ webhooks: - topics - visibility sender: *4 - team: *742 + team: *749 required: - action - changes @@ -226243,9 +226633,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 repository: title: Repository description: A git repository @@ -226715,7 +227105,7 @@ webhooks: - topics - visibility sender: *4 - team: *742 + team: *749 required: - action - team @@ -226791,10 +227181,10 @@ webhooks: type: string enum: - started - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -226867,17 +227257,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *673 + enterprise: *680 inputs: type: - object - 'null' additionalProperties: true - installation: *674 - organization: *675 + installation: *681 + organization: *682 ref: type: string - repository: *676 + repository: *683 sender: *4 workflow: type: string @@ -226959,10 +227349,10 @@ webhooks: type: string enum: - completed - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 workflow_job: allOf: @@ -227218,7 +227608,7 @@ webhooks: type: string required: - conclusion - deployment: *449 + deployment: *456 required: - action - repository @@ -227297,10 +227687,10 @@ webhooks: type: string enum: - in_progress - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 workflow_job: allOf: @@ -227582,7 +227972,7 @@ webhooks: required: - status - steps - deployment: *449 + deployment: *456 required: - action - repository @@ -227661,10 +228051,10 @@ webhooks: type: string enum: - queued - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 workflow_job: type: object @@ -227810,7 +228200,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *449 + deployment: *456 required: - action - repository @@ -227889,10 +228279,10 @@ webhooks: type: string enum: - waiting - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 workflow_job: type: object @@ -228039,7 +228429,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *449 + deployment: *456 required: - action - repository @@ -228119,12 +228509,12 @@ webhooks: type: string enum: - completed - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - workflow: *695 + workflow: *702 workflow_run: title: Workflow Run type: object @@ -229143,12 +229533,12 @@ webhooks: type: string enum: - in_progress - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - workflow: *695 + workflow: *702 workflow_run: title: Workflow Run type: object @@ -230152,12 +230542,12 @@ webhooks: type: string enum: - requested - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - workflow: *695 + workflow: *702 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index a9c03dcf4..0dd30c4c7 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -29069,7 +29069,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-user-management" @@ -29725,7 +29725,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-metrics" @@ -30085,7 +30085,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-usage" @@ -32449,664 +32449,7780 @@ "string", "null" ], - "description": "Short description of the property" + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "minItems": 1, + "maxItems": 100 + } + }, + "required": [ + "properties" + ] + }, + "examples": { + "default": { + "value": { + "properties": [ + { + "property_name": "environment", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "value_type": "string" + }, + { + "property_name": "team", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ], + "values_editable_by": "org_actors" + }, + { + "property_name": "service", + "url": "https://api.github.com/orgs/github/properties/schema/service", + "source_type": "organization", + "value_type": "string" + }, + { + "property_name": "team", + "url": "https://api.github.com/orgs/github/properties/schema/team", + "source_type": "organization", + "value_type": "string", + "description": "Team owning the repository" + } + ] + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + } + }, + "/enterprises/{enterprise}/properties/schema/{custom_property_name}": { + "get": { + "summary": "Get a custom property for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/get-enterprise-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-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": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + }, + "put": { + "summary": "Create or update a custom property for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new or updates an existing custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/create-or-update-enterprise-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-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": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", + "type": "object", + "properties": { + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + }, + "required": [ + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Organization Custom Property", + "description": "Custom property defined on an organization", + "type": "object", + "properties": { + "property_name": { + "type": "string", + "description": "The name of the property" + }, + "url": { + "type": "string", + "format": "uri", + "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + }, + "source_type": { + "type": "string", + "description": "The source type of the property", + "enum": [ + "organization", + "enterprise" + ], + "examples": [ + "organization" + ] + }, + "value_type": { + "type": "string", + "enum": [ + "string", + "single_select", + "multi_select", + "true_false" + ], + "description": "The type of the value for the property", + "examples": [ + "single_select" + ] + }, + "required": { + "type": "boolean", + "description": "Whether the property is required." + }, + "default_value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "array", + "items": { + "type": "string" + } + } + ], + "description": "Default value of the property", + "type": [ + "null", + "string", + "array" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "description": "Short description of the property" + }, + "allowed_values": { + "type": [ + "array", + "null" + ], + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + }, + "values_editable_by": { + "type": [ + "string", + "null" + ], + "enum": [ + "org_actors", + "org_and_repo_actors", + null + ], + "description": "Who can edit the values of the property", + "examples": [ + "org_actors" + ] + } + }, + "required": [ + "property_name", + "value_type" + ] + }, + "examples": { + "default": { + "value": { + "property_name": "environment", + "url": "https://api.github.com/orgs/github/properties/schema/environment", + "source_type": "organization", + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + }, + "delete": { + "summary": "Remove a custom property for an enterprise", + "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemove a custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "tags": [ + "enterprise-admin" + ], + "operationId": "enterprise-admin/remove-enterprise-custom-property", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-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": "custom_property_name", + "description": "The custom property name", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "A header with no content is returned." + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "custom-properties" + } + } + }, + "/enterprises/{enterprise}/rulesets": { + "post": { + "summary": "Create an enterprise repository ruleset", + "description": "Create a repository ruleset for an enterprise.", + "tags": [ + "repos" + ], + "operationId": "repos/create-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset" + }, + "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" + } + } + ], + "requestBody": { + "description": "Request body", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ], + "default": "branch" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "EnterpriseOwner" + ], + "description": "The type of actor that can bypass a ruleset" + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "conditions": { + "title": "Enterprise ruleset conditions", + "type": "object", + "description": "Conditions for an enterprise ruleset. The conditions object should contain either the `organization_id` or `organization_name` property and the `repository_name` or `repository_property` property. For branch and tag rulesets, the conditions object should also contain the `ref_name` property.", + "oneOf": [ + { + "type": "object", + "title": "organization_name_and_repository_name", + "description": "Conditions to target organizations by name and all repositories", + "allOf": [ + { + "title": "Repository ruleset conditions for organization names", + "type": "object", + "description": "Parameters for an organization name condition", + "properties": { + "organization_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "organization_name" + ] + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_name_and_repository_property", + "description": "Conditions to target organizations by name and repositories by property", + "allOf": [ + { + "title": "Repository ruleset conditions for organization names", + "type": "object", + "description": "Parameters for an organization name condition", + "properties": { + "organization_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "organization_name" + ] + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_name", + "description": "Conditions to target organizations by id and all repositories", + "allOf": [ + { + "title": "Repository ruleset conditions for organization IDs", + "type": "object", + "description": "Parameters for an organization ID condition", + "properties": { + "organization_id": { + "type": "object", + "properties": { + "organization_ids": { + "type": "array", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "organization_id" + ] + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_property", + "description": "Conditions to target organization by id and repositories by property", + "allOf": [ + { + "title": "Repository ruleset conditions for organization IDs", + "type": "object", + "description": "Parameters for an organization ID condition", + "properties": { + "organization_id": { + "type": "object", + "properties": { + "organization_ids": { + "type": "array", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "organization_id" + ] + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + } + ] + }, + "rules": { + "type": "array", + "description": "An array of rules within the ruleset.", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths", + "minimum": 1, + "maximum": 256 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + } + ] + } + } + }, + "required": [ + "name", + "enforcement" + ] + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "repository", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "org_name": { + "include": [ + "important_org" + ], + "exclude": [ + "unimportant_org" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] + }, + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "EnterpriseOwner" + ], + "description": "The type of actor that can bypass a ruleset" + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": [ + "object", + "null" + ], + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + } + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + } + ] + } + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "rules": { + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths", + "minimum": 1, + "maximum": 256 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + } + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "examples": { + "default": { + "value": { + "id": 21, + "name": "super cool ruleset", + "target": "repository", + "source_type": "Enterprise", + "source": "my-enterprise", + "enforcement": "active", + "conditions": { + "organization_name": { + "include": [ + "important_organization" + ] + }, + "repository_name": { + "include": [ + "~ALL" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/enterprises/my-enterprise/rulesets/21" + }, + "html": { + "href": "https://github.com/enterprise/my-enterprise/settings/policies/repositories/21" + } + }, + "created_at": "2024-08-15T08:43:03Z", + "updated_at": "2024-09-23T16:29:47Z" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "rules" + } + } + }, + "/enterprises/{enterprise}/rulesets/{ruleset_id}": { + "get": { + "summary": "Get an enterprise repository ruleset", + "description": "Get a repository ruleset for an enterprise.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", + "tags": [ + "repos" + ], + "operationId": "repos/get-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset" + }, + "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": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] + }, + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "EnterpriseOwner" + ], + "description": "The type of actor that can bypass a ruleset" + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": [ + "object", + "null" + ], + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "anyOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + } + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + } + ] + } + ] + } + ], + "type": [ + "null", + "object" + ] + }, + "rules": { + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths", + "minimum": 1, + "maximum": 256 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + } + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "examples": { + "default": { + "value": { + "id": 21, + "name": "super cool ruleset", + "target": "repository", + "source_type": "Enterprise", + "source": "my-enterprise", + "enforcement": "active", + "conditions": { + "organization_name": { + "include": [ + "important_organization" + ] + }, + "repository_name": { + "include": [ + "~ALL" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/enterprises/my-enterprise/rulesets/21" + }, + "html": { + "href": "https://github.com/enterprise/my-enterprise/settings/policies/repositories/21" + } + }, + "created_at": "2024-08-15T08:43:03Z", + "updated_at": "2024-09-23T16:29:47Z" + } + } + } + } + } + }, + "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" + } + } + } + } + } + }, + "500": { + "description": "Internal Error", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "rules" + } + }, + "put": { + "summary": "Update an enterprise repository ruleset", + "description": "Update a ruleset for an enterprise.", + "tags": [ + "repos" + ], + "operationId": "repos/update-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset" + }, + "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": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "description": "Request body", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "EnterpriseOwner" + ], + "description": "The type of actor that can bypass a ruleset" + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "conditions": { + "title": "Enterprise ruleset conditions", + "type": "object", + "description": "Conditions for an enterprise ruleset. The conditions object should contain either the `organization_id` or `organization_name` property and the `repository_name` or `repository_property` property. For branch and tag rulesets, the conditions object should also contain the `ref_name` property.", + "oneOf": [ + { + "type": "object", + "title": "organization_name_and_repository_name", + "description": "Conditions to target organizations by name and all repositories", + "allOf": [ + { + "title": "Repository ruleset conditions for organization names", + "type": "object", + "description": "Parameters for an organization name condition", + "properties": { + "organization_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "organization_name" + ] + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_name_and_repository_property", + "description": "Conditions to target organizations by name and repositories by property", + "allOf": [ + { + "title": "Repository ruleset conditions for organization names", + "type": "object", + "description": "Parameters for an organization name condition", + "properties": { + "organization_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "organization_name" + ] + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_name", + "description": "Conditions to target organizations by id and all repositories", + "allOf": [ + { + "title": "Repository ruleset conditions for organization IDs", + "type": "object", + "description": "Parameters for an organization ID condition", + "properties": { + "organization_id": { + "type": "object", + "properties": { + "organization_ids": { + "type": "array", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "organization_id" + ] + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_property", + "description": "Conditions to target organization by id and repositories by property", + "allOf": [ + { + "title": "Repository ruleset conditions for organization IDs", + "type": "object", + "description": "Parameters for an organization ID condition", + "properties": { + "organization_id": { + "type": "object", + "properties": { + "organization_ids": { + "type": "array", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "organization_id" + ] + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + }, + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + } + ] + } + ] + }, + "rules": { + "description": "An array of rules within the ruleset.", + "type": "array", + "items": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths", + "minimum": 1, + "maximum": 256 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } }, - "allowed_values": { - "type": [ - "array", - "null" + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } - }, - "required": [ - "property_name", - "value_type" ] - }, - "minItems": 1, - "maxItems": 100 + } } - }, - "required": [ - "properties" - ] + } }, "examples": { "default": { "value": { - "properties": [ - { - "property_name": "environment", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ], - "values_editable_by": "org_actors" - }, - { - "property_name": "service", - "value_type": "string" - }, + "name": "super cool ruleset", + "target": "repository", + "enforcement": "active", + "bypass_actors": [ { - "property_name": "team", - "value_type": "string", - "description": "Team owning the repository" + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" } - ] - } - } - } - } - } - }, - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "url": { - "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." - }, - "source_type": { - "type": "string", - "description": "The source type of the property", - "enum": [ - "organization", - "enterprise" - ], - "examples": [ - "organization" - ] - }, - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null + ], + "conditions": { + "org_name": { + "include": [ + "important_org" ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" + "exclude": [ + "unimportant_org" ] } }, - "required": [ - "property_name", - "value_type" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ], - "values_editable_by": "org_actors" - }, - { - "property_name": "service", - "url": "https://api.github.com/orgs/github/properties/schema/service", - "source_type": "organization", - "value_type": "string" - }, + "rules": [ { - "property_name": "team", - "url": "https://api.github.com/orgs/github/properties/schema/team", - "source_type": "organization", - "value_type": "string", - "description": "Team owning the repository" + "type": "repository_delete" } ] } } } } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } } }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "enterprise-admin", - "subcategory": "custom-properties" - } - } - }, - "/enterprises/{enterprise}/properties/schema/{custom_property_name}": { - "get": { - "summary": "Get a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nGets a custom property that is defined for an enterprise.\nEnterprise members can read these properties.", - "tags": [ - "enterprise-admin" - ], - "operationId": "enterprise-admin/get-enterprise-custom-property", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#get-a-custom-property-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": "custom_property_name", - "description": "The custom property name", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", + "title": "Repository ruleset", "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" + "id": { + "type": "integer", + "description": "The ID of the ruleset" }, - "url": { + "name": { "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + "description": "The name of the ruleset" }, - "source_type": { + "target": { "type": "string", - "description": "The source type of the property", + "description": "The target of the ruleset", "enum": [ - "organization", - "enterprise" - ], - "examples": [ - "organization" + "branch", + "tag", + "push", + "repository" ] }, - "value_type": { + "source_type": { "type": "string", + "description": "The type of the source of the ruleset", "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] - } - }, - "required": [ - "property_name", - "value_type" - ] - }, - "examples": { - "default": { - "value": { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" + "Repository", + "Organization", + "Enterprise" ] - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource not found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "status": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": true, - "enabledForGitHubApps": true, - "category": "enterprise-admin", - "subcategory": "custom-properties" - } - }, - "put": { - "summary": "Create or update a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nCreates a new or updates an existing custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", - "tags": [ - "enterprise-admin" - ], - "operationId": "enterprise-admin/create-or-update-enterprise-custom-property", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#create-or-update-a-custom-property-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": "custom_property_name", - "description": "The custom property name", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "title": "Organization Custom Property", - "description": "Custom property defined on an organization", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" }, - "url": { + "source": { "type": "string", - "format": "uri", - "description": "The URL that can be used to fetch, update, or delete info about this property via the API." + "description": "The name of the source" }, - "source_type": { + "enforcement": { "type": "string", - "description": "The source type of the property", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ - "organization", - "enterprise" - ], - "examples": [ - "organization" + "disabled", + "active", + "evaluate" ] }, - "value_type": { + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { + "type": [ + "integer", + "null" + ], + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." + }, + "actor_type": { + "type": "string", + "enum": [ + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "EnterpriseOwner" + ], + "description": "The type of actor that can bypass a ruleset" + }, + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" + ], + "default": "always" + } + } + } + }, + "current_user_can_bypass": { "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" + "always", + "pull_requests_only", + "never" ] }, - "required": { - "type": "boolean", - "description": "Whether the property is required." + "node_id": { + "type": "string" }, - "default_value": { - "oneOf": [ - { - "type": "string" + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } }, + "html": { + "type": [ + "object", + "null" + ], + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "anyOf": [ { - "type": "array", - "items": { - "type": "string" + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } } + }, + { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository names", + "type": "object", + "description": "Parameters for a repository name condition", + "properties": { + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } + } + }, + "required": [ + "repository_name" + ] + } + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + { + "title": "Repository ruleset conditions for repository properties", + "type": "object", + "description": "Parameters for a repository property condition", + "properties": { + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "title": "Repository ruleset property targeting definition", + "type": "object", + "description": "Parameters for a targeting a repository property", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository property to target" + }, + "property_values": { + "type": "array", + "description": "The values to match for the repository property", + "items": { + "type": "string" + } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] + } + }, + "required": [ + "name", + "property_values" + ] + } + } + } + } + }, + "required": [ + "repository_property" + ] + } + ] + } + ] } ], - "description": "Default value of the property", "type": [ "null", - "string", - "array" + "object" ] }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], + "rules": { + "type": "array", "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "creation" + ] + } + } + }, + { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "update" + ] + }, + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] + } + } + }, + { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "deletion" + ] + } + } + }, + { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_linear_history" + ] + } + } + }, + { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "merge_queue" + ] + }, + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" + ] + } + } + }, + { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_deployments" + ] + }, + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } + } + }, + "required": [ + "required_deployment_environments" + ] + } + } + }, + { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" + ] + } + } + }, + { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths", + "minimum": 1, + "maximum": 256 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + } + ] + } }, - "values_editable_by": { - "type": [ - "string", - "null" - ], - "enum": [ - "org_actors", - "org_and_repo_actors", - null - ], - "description": "Who can edit the values of the property", - "examples": [ - "org_actors" - ] + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" } - }, - "required": [ - "property_name", - "value_type" - ] + } }, "examples": { "default": { "value": { - "property_name": "environment", - "url": "https://api.github.com/orgs/github/properties/schema/environment", - "source_type": "organization", - "value_type": "single_select", - "required": true, - "default_value": "production", - "description": "Prod or dev environment", - "allowed_values": [ - "production", - "development" - ] + "id": 21, + "name": "super cool ruleset", + "target": "repository", + "source_type": "Enterprise", + "source": "my-enterprise", + "enforcement": "active", + "conditions": { + "organization_name": { + "include": [ + "important_organization" + ] + }, + "repository_name": { + "include": [ + "~ALL" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/enterprises/my-enterprise/rulesets/21" + }, + "html": { + "href": "https://github.com/enterprise/my-enterprise/settings/policies/repositories/21" + } + }, + "created_at": "2024-08-15T08:43:03Z", + "updated_at": "2024-09-23T16:29:47Z" } } } } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -33131,8 +40247,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -33162,19 +40278,19 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "custom-properties" + "subcategory": "rules" } }, "delete": { - "summary": "Remove a custom property for an enterprise", - "description": "> [!NOTE]\n> This endpoint is in public preview and is subject to change.\n\nRemove a custom property that is defined for an enterprise.\n\nTo use this endpoint, the authenticated user must be an administrator for the enterprise.", + "summary": "Delete an enterprise repository ruleset", + "description": "Delete a ruleset for an enterprise.", "tags": [ - "enterprise-admin" + "repos" ], - "operationId": "enterprise-admin/remove-enterprise-custom-property", + "operationId": "repos/delete-enterprise-ruleset", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/custom-properties#remove-a-custom-property-for-an-enterprise" + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset" }, "parameters": [ { @@ -33187,21 +40303,21 @@ } }, { - "name": "custom_property_name", - "description": "The custom property name", + "name": "ruleset_id", + "description": "The ID of the ruleset.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { "204": { - "description": "A header with no content is returned." + "description": "Response" }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource not found", "content": { "application/json": { "schema": { @@ -33226,8 +40342,8 @@ } } }, - "404": { - "description": "Resource not found", + "500": { + "description": "Internal Error", "content": { "application/json": { "schema": { @@ -33257,7 +40373,7 @@ "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "enterprise-admin", - "subcategory": "custom-properties" + "subcategory": "rules" } } }, @@ -34583,6 +41699,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -34775,6 +41898,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -34866,6 +41990,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -37126,7 +44251,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-metrics" @@ -37495,7 +44620,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-usage" @@ -83506,6 +90631,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -147377,6 +154505,8 @@ "content": { "application/json": { "schema": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", "type": "object", "properties": { "value_type": { @@ -154784,7 +161914,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -154792,7 +161923,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -154801,7 +161933,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -154919,7 +162051,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -155390,6 +162522,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -156134,13 +163273,14 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ], "default": "branch" }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -156192,7 +163332,7 @@ "conditions": { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -156658,6 +163798,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -157331,7 +164478,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -157339,7 +164487,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -157348,7 +164497,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -157466,7 +164615,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -157937,6 +165086,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -159268,7 +166424,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -159276,7 +166433,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -159285,7 +166443,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -159403,7 +166561,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -159874,6 +167032,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -160644,12 +167809,13 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -160701,7 +167867,7 @@ "conditions": { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -161167,6 +168333,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -161836,7 +169009,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -161844,7 +169018,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -161853,7 +169028,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -161971,7 +169146,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -162442,6 +169617,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -164584,6 +171766,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -164776,6 +171965,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -164867,6 +172057,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -190619,6 +197810,30 @@ "reset", "used" ] + }, + "code_scanning_autofix": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] } }, "required": [ @@ -190719,6 +197934,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -226355,6 +233576,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -482908,6 +490132,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -483780,7 +491011,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -483788,7 +491020,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -483797,7 +491030,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -483915,7 +491148,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -484386,6 +491619,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -485145,7 +492385,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -485445,6 +492685,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -486108,7 +493355,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -486116,7 +493364,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -486125,7 +493374,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -486243,7 +493492,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -486714,6 +493963,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -488064,7 +495320,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -488072,7 +495329,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -488081,7 +495339,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -488199,7 +495457,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -488670,6 +495928,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -489444,7 +496709,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -489744,6 +497009,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -490403,7 +497675,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -490411,7 +497684,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -490420,7 +497694,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -490538,7 +497812,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -491009,6 +498283,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -492615,6 +499896,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -492733,6 +500021,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -492757,6 +500046,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -493484,6 +500774,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -493543,6 +500840,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -494322,6 +501620,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -494400,6 +501705,7 @@ "push_protection_bypassed_by": null, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": "Example comment", @@ -622504,6 +629810,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -666626,6 +673935,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -668841,6 +676157,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -671056,6 +678379,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -673271,6 +680601,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -673315,6 +680652,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -675520,6 +682864,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -675564,6 +682915,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -677769,6 +685127,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -679984,6 +687349,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -682199,6 +689571,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -684414,6 +691793,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -684458,6 +691844,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -686663,6 +694056,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -686707,6 +694107,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -1263943,7 +1271350,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1263951,7 +1271359,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1263960,7 +1271369,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -1264078,7 +1271487,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -1264549,6 +1271958,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1267150,7 +1274566,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1267158,7 +1274575,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1267167,7 +1274585,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -1267285,7 +1274703,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -1267756,6 +1275174,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1270357,7 +1277782,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "source_type": { @@ -1270365,7 +1277791,8 @@ "description": "The type of the source of the ruleset", "enum": [ "Repository", - "Organization" + "Organization", + "Enterprise" ] }, "source": { @@ -1270374,7 +1277801,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -1270492,7 +1277919,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -1270963,6 +1278390,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1271947,6 +1279381,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1272759,6 +1280200,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1273574,6 +1281022,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1287868,6 +1295323,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1290509,6 +1297971,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1293584,6 +1301053,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1296225,6 +1303701,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1298866,6 +1306349,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -1301507,6 +1308997,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index aa209a7e2..4acf176e1 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -896,7 +896,7 @@ paths: - subscriptions_url - type - url - type: &284 + type: &291 type: string description: The type of credit the user is receiving. enum: @@ -1029,7 +1029,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &142 + schema: &154 title: Validation Error Simple description: Validation Error Simple type: object @@ -1062,7 +1062,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/global-advisories#get-a-global-security-advisory parameters: - - &587 + - &594 name: ghsa_id description: The GHSA (GitHub Security Advisory) identifier of the advisory. in: path @@ -1593,7 +1593,7 @@ paths: schema: type: integer default: 30 - - &212 + - &224 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 @@ -1609,7 +1609,7 @@ paths: application/json: schema: type: array - items: &213 + items: &225 title: Simple webhook delivery description: Delivery made by a webhook, without request and response information. @@ -1702,7 +1702,7 @@ paths: - installation_id - repository_id examples: - default: &214 + default: &226 value: - id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -1734,7 +1734,7 @@ paths: application/json: schema: *3 application/scim+json: - schema: &597 + schema: &604 title: Scim Error description: Scim Error type: object @@ -1765,7 +1765,7 @@ paths: description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: &141 + schema: &153 title: Validation Error description: Validation Error type: object @@ -1837,7 +1837,7 @@ paths: description: Response content: application/json: - schema: &215 + schema: &227 title: Webhook delivery description: Delivery made by a webhook. type: object @@ -1972,7 +1972,7 @@ paths: - request - response examples: - default: &216 + default: &228 value: id: 12345678 guid: 0b989ba4-242f-11e5-81e1-c7b6966d2516 @@ -2032,7 +2032,7 @@ paths: parameters: - *16 responses: - '202': &144 + '202': &156 description: Accepted content: application/json: @@ -2241,7 +2241,7 @@ paths: parameters: - *17 - *18 - - &106 + - &118 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) @@ -3003,7 +3003,7 @@ paths: license: anyOf: - type: 'null' - - &117 + - &129 title: License Simple description: License Simple type: object @@ -7598,7 +7598,7 @@ paths: description: Response content: application/json: - schema: &145 + schema: &157 type: object properties: total_active_caches_count: @@ -7613,7 +7613,7 @@ paths: - total_active_caches_count - total_active_caches_size_in_bytes examples: - default: &146 + default: &158 value: total_active_caches_size_in_bytes: 3344284 total_active_caches_count: 5 @@ -7708,7 +7708,7 @@ paths: - all - local_only - selected - selected_actions_url: &149 + selected_actions_url: &161 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` @@ -8089,7 +8089,7 @@ paths: description: Success response content: application/json: - schema: &152 + schema: &164 type: object properties: default_workflow_permissions: &44 @@ -8137,7 +8137,7 @@ paths: required: true content: application/json: - schema: &153 + schema: &165 type: object properties: default_workflow_permissions: *44 @@ -8966,7 +8966,7 @@ paths: application/json: schema: type: array - items: &157 + items: &169 title: Runner Application description: Runner Application type: object @@ -8991,7 +8991,7 @@ paths: - download_url - filename examples: - default: &158 + default: &170 value: - os: osx architecture: x64 @@ -9075,7 +9075,7 @@ paths: - no-gpu work_folder: _work responses: - '201': &159 + '201': &171 description: Response content: application/json: @@ -9189,7 +9189,7 @@ paths: - token - expires_at examples: - default: &160 + default: &172 value: token: LLBF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-22T12:13:35.123-08:00' @@ -9229,7 +9229,7 @@ paths: application/json: schema: *56 examples: - default: &161 + default: &173 value: token: AABF3JGZDX3P5PMEXLND6TS6FCWO6 expires_at: '2020-01-29T12:13:35.123-08:00' @@ -9261,7 +9261,7 @@ paths: application/json: schema: *53 examples: - default: &162 + default: &174 value: id: 23 name: MBP @@ -9475,7 +9475,7 @@ paths: - *38 - *52 responses: - '200': &163 + '200': &175 description: Response content: application/json: @@ -9531,7 +9531,7 @@ paths: parameters: - *38 - *52 - - &164 + - &176 name: name description: The name of a self-hosted runner's custom label. in: path @@ -9628,7 +9628,7 @@ paths: required: true content: application/json: - schema: &171 + schema: &183 title: Enterprise Announcement description: Enterprise global announcement type: object @@ -9699,7 +9699,7 @@ paths: required: false schema: type: string - - &172 + - &184 name: include description: |- The event types to include: @@ -9717,7 +9717,7 @@ paths: - web - git - all - - &173 + - &185 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. @@ -9725,7 +9725,7 @@ paths: required: false schema: type: string - - &174 + - &186 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. @@ -9733,7 +9733,7 @@ paths: required: false schema: type: string - - &175 + - &187 name: order description: |- The order of audit log events. To list newest events first, specify `desc`. To list oldest events first, specify `asc`. @@ -9755,7 +9755,7 @@ paths: application/json: schema: type: array - items: &176 + items: &188 type: object properties: "@timestamp": @@ -9877,7 +9877,7 @@ paths: description: The repository visibility, for example `public` or `private`. examples: - default: &177 + default: &189 value: - "@timestamp": 1606929874512 action: team.add_member @@ -10441,7 +10441,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-enterprise parameters: - *38 - - &179 + - &191 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`, @@ -10451,7 +10451,7 @@ paths: schema: &77 type: string description: The name of the tool used to generate the code scanning analysis. - - &180 + - &192 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 @@ -10475,7 +10475,7 @@ paths: be returned. in: query required: false - schema: &181 + schema: &193 type: string description: State of a code scanning alert. enum: @@ -10500,7 +10500,7 @@ paths: application/json: schema: type: array - items: &182 + items: &194 type: object properties: number: &81 @@ -10529,7 +10529,7 @@ paths: description: The GitHub URL of the alert resource. format: uri readOnly: true - instances_url: &392 + instances_url: &399 type: string description: The REST API URL for fetching the list of instances for an alert. @@ -10565,7 +10565,7 @@ paths: format: `YYYY-MM-DDTHH:MM:SSZ`.' format: date-time readOnly: true - dismissed_reason: &393 + dismissed_reason: &400 type: - string - 'null' @@ -10576,14 +10576,14 @@ paths: - won't fix - used in tests - - dismissed_comment: &394 + dismissed_comment: &401 type: - string - 'null' description: The dismissal comment associated with the dismissal of the alert. maxLength: 280 - rule: &395 + rule: &402 type: object properties: id: @@ -10644,7 +10644,7 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: &396 + tool: &403 type: object properties: name: *77 @@ -10655,15 +10655,15 @@ paths: description: The version of the tool used to generate the code scanning analysis. guid: *78 - most_recent_instance: &397 + most_recent_instance: &404 type: object properties: - ref: &390 + ref: &397 type: string description: |- The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`, `refs/heads/` or simply ``. - analysis_key: &403 + analysis_key: &410 type: string description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions @@ -10674,7 +10674,7 @@ paths: the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. - category: &404 + category: &411 type: string description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple @@ -11058,7 +11058,7 @@ paths: - most_recent_instance - repository examples: - default: &183 + default: &195 value: - number: 4 created_at: '2020-02-13T12:29:18Z' @@ -11289,7 +11289,7 @@ paths: headers: Link: *37 '404': *6 - '503': &96 + '503': &108 description: Service unavailable content: application/json: @@ -11716,7 +11716,7 @@ paths: or enterprise teams are only counted once. seats: type: array - items: &190 + items: &202 title: Copilot Business Seat Detail description: Information about a Copilot Business seat assignment for a user, team, or organization. @@ -11731,7 +11731,7 @@ paths: description: The team through which the assignee is granted access to GitHub Copilot, if applicable. oneOf: - - &234 + - &246 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -11790,7 +11790,7 @@ paths: parent: anyOf: - type: 'null' - - &247 + - &259 title: Team Simple description: Groups of organization members that gives permissions on specified repositories. @@ -11988,7 +11988,7 @@ paths: - created_at additionalProperties: false examples: - default: &191 + default: &203 value: total_seats: 2 seats: @@ -12066,7 +12066,7 @@ paths: '403': *27 '404': *6 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-user-management @@ -12123,7 +12123,7 @@ paths: application/json: schema: type: array - items: &98 + items: &110 title: Copilot Usage Metrics description: Copilot usage metrics for a given day. type: object @@ -12439,7 +12439,7 @@ paths: - date additionalProperties: true examples: - default: &99 + default: &111 value: - date: '2024-06-24' total_active_users: 24 @@ -12541,14 +12541,14 @@ paths: '500': *80 '403': *27 '404': *6 - '422': &100 + '422': &112 description: Copilot Usage Merics API setting is disabled at the organization or enterprise level. content: application/json: schema: *3 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-metrics @@ -12611,7 +12611,7 @@ paths: application/json: schema: type: array - items: &101 + items: &113 title: Copilot Usage Metrics description: Summary of Copilot usage. type: object @@ -12768,7 +12768,7 @@ paths: '403': *27 '404': *6 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage @@ -12791,7 +12791,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-enterprise parameters: - *38 - - &198 + - &210 name: state in: query description: |- @@ -12800,7 +12800,7 @@ paths: Can be: `auto_dismissed`, `dismissed`, `fixed`, `open` schema: type: string - - &199 + - &211 name: severity in: query description: |- @@ -12809,7 +12809,7 @@ paths: Can be: `low`, `medium`, `high`, `critical` schema: type: string - - &200 + - &212 name: ecosystem in: query description: |- @@ -12818,14 +12818,14 @@ paths: Can be: `composer`, `go`, `maven`, `npm`, `nuget`, `pip`, `pub`, `rubygems`, `rust` schema: type: string - - &201 + - &213 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 - - &202 + - &214 name: scope in: query description: The scope of the vulnerable dependency. If specified, only alerts @@ -12835,7 +12835,7 @@ paths: enum: - development - runtime - - &203 + - &215 name: sort in: query description: |- @@ -12851,7 +12851,7 @@ paths: - *76 - *74 - *75 - - &204 + - &216 name: first description: |- **Deprecated**. The number of results per page (max 100), starting from the first matching result. @@ -12864,7 +12864,7 @@ paths: minimum: 1 maximum: 100 default: 30 - - &205 + - &217 name: last description: |- **Deprecated**. The number of results per page (max 100), starting from the last matching result. @@ -12884,7 +12884,7 @@ paths: application/json: schema: type: array - items: &206 + items: &218 type: object description: A Dependabot alert. properties: @@ -12936,7 +12936,7 @@ paths: - development - runtime - - security_advisory: &441 + security_advisory: &448 type: object description: Details for the GitHub Security Advisory. readOnly: true @@ -13171,7 +13171,7 @@ paths: dismissal. maxLength: 280 fixed_at: *90 - auto_dismissed_at: &442 + auto_dismissed_at: &449 type: - string - 'null' @@ -13198,7 +13198,7 @@ paths: - repository additionalProperties: false examples: - default: &207 + default: &219 value: - number: 2 state: dismissed @@ -13854,6 +13854,67 @@ paths: parameters: - *38 - *94 + requestBody: + required: true + content: + application/json: + schema: &275 + title: Custom Property Set Payload + description: Custom property set payload + type: object + properties: + value_type: + type: string + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + required: + - value_type + examples: + default: + value: + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development responses: '200': description: Response @@ -13888,7 +13949,7 @@ paths: - *38 - *94 responses: - '204': &185 + '204': &197 description: A header with no content is returned. '403': *27 '404': *6 @@ -13897,6 +13958,1263 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: custom-properties + "/enterprises/{enterprise}/rulesets": + post: + summary: Create an enterprise repository ruleset + description: Create a repository ruleset for an enterprise. + tags: + - repos + operationId: repos/create-enterprise-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset + parameters: + - *38 + requestBody: + description: Request body + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the ruleset. + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + default: branch + enforcement: &102 + type: string + description: The enforcement level of the ruleset. `evaluate` allows + admins to test rules before enforcing them. Admins can view insights + on the Rule Insights page. `evaluate` is not available for the + `repository` target. + enum: + - disabled + - active + - evaluate + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: &103 + title: Repository Ruleset Bypass Actor + type: object + description: An actor that can bypass rules in a ruleset + required: + - actor_type + properties: + actor_id: + type: + - integer + - 'null' + description: The ID of the actor that can bypass a ruleset. + If `actor_type` is `OrganizationAdmin`, this should be `1`. + If `actor_type` is `DeployKey`, this should be null. If + `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. + `OrganizationAdmin` and `EnterpriseOwner` are not applicable + for personal repositories. + actor_type: + type: string + enum: + - Integration + - OrganizationAdmin + - RepositoryRole + - Team + - DeployKey + - EnterpriseOwner + description: The type of actor that can bypass a ruleset + bypass_mode: + type: string + description: When the specified actor can bypass the ruleset. + `pull_request` means that an actor can only bypass rules + on pull requests. `pull_request` is not applicable for the + `DeployKey` actor type. Also, `pull_request` is only applicable + to branch rulesets. + enum: + - always + - pull_request + default: always + conditions: &107 + title: Enterprise ruleset conditions + type: object + description: Conditions for an enterprise ruleset. The conditions + object should contain either the `organization_id` or `organization_name` + property and the `repository_name` or `repository_property` property. + For branch and tag rulesets, the conditions object should also + contain the `ref_name` property. + oneOf: + - type: object + title: organization_name_and_repository_name + description: Conditions to target organizations by name and all + repositories + allOf: + - &96 + title: Repository ruleset conditions for organization names + type: object + description: Parameters for an organization name condition + properties: + organization_name: + type: object + properties: + include: + type: array + description: Array of organization names or patterns + to include. One of these patterns must match for the + condition to pass. Also accepts `~ALL` to include + all organizations and ~EMUS to target all enterprise + managed user accounts. + items: + type: string + exclude: + type: array + description: Array of organization names or patterns + to exclude. The condition will not pass if any of + these patterns match. + items: + type: string + required: + - organization_name + - &99 + title: Repository ruleset conditions for repository names + type: object + description: Parameters for a repository name condition + properties: + repository_name: + type: object + properties: + include: + type: array + description: Array of repository names or patterns to + include. One of these patterns must match for the + condition to pass. Also accepts `~ALL` to include + all repositories. + items: + type: string + exclude: + type: array + description: Array of repository names or patterns to + exclude. The condition will not pass if any of these + patterns match. + items: + type: string + protected: + type: boolean + description: Whether renaming of target repositories + is prevented. + required: + - repository_name + - &98 + title: Repository ruleset conditions for ref names + type: object + description: Parameters for a repository ruleset ref name condition + properties: + ref_name: + type: object + properties: + include: + type: array + description: Array of ref names or patterns to include. + One of these patterns must match for the condition + to pass. Also accepts `~DEFAULT_BRANCH` to include + the default branch or `~ALL` to include all branches. + items: + type: string + exclude: + type: array + description: Array of ref names or patterns to exclude. + The condition will not pass if any of these patterns + match. + items: + type: string + - type: object + title: organization_name_and_repository_property + description: Conditions to target organizations by name and repositories + by property + allOf: + - *96 + - &101 + title: Repository ruleset conditions for repository properties + type: object + description: Parameters for a repository property condition + properties: + repository_property: + type: object + properties: + include: + type: array + description: The repository properties and values to + include. All of these properties must match for the + condition to pass. + items: &97 + title: Repository ruleset property targeting definition + type: object + description: Parameters for a targeting a repository + property + properties: + name: + type: string + description: The name of the repository property + to target + property_values: + type: array + description: The values to match for the repository + property + items: + type: string + source: + type: string + description: The source of the repository property. + Defaults to 'custom' if not specified. + enum: + - custom + - system + required: + - name + - property_values + exclude: + type: array + description: The repository properties and values to + exclude. The condition will not pass if any of these + properties match. + items: *97 + required: + - repository_property + - *98 + - type: object + title: organization_id_and_repository_name + description: Conditions to target organizations by id and all + repositories + allOf: + - &100 + title: Repository ruleset conditions for organization IDs + type: object + description: Parameters for an organization ID condition + properties: + organization_id: + type: object + properties: + organization_ids: + type: array + description: The organization IDs that the ruleset applies + to. One of these IDs must match for the condition + to pass. + items: + type: integer + required: + - organization_id + - *99 + - *98 + - type: object + title: organization_id_and_repository_property + description: Conditions to target organization by id and repositories + by property + allOf: + - *100 + - *101 + - *98 + rules: + type: array + description: An array of rules within the ruleset. + items: &104 + title: Repository Rule + type: object + description: A repository rule. + oneOf: + - &555 + title: creation + description: Only allow users with bypass permission to create + matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - creation + - &556 + title: update + description: Only allow users with bypass permission to update + matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - update + parameters: + type: object + properties: + update_allows_fetch_and_merge: + type: boolean + description: Branch can pull changes from its upstream + repository + required: + - update_allows_fetch_and_merge + - &558 + title: deletion + description: Only allow users with bypass permissions to delete + matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - deletion + - &559 + title: required_linear_history + description: Prevent merge commits from being pushed to matching + refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_linear_history + - &560 + title: merge_queue + description: Merges must be performed via a merge queue. + type: object + required: + - type + properties: + type: + type: string + enum: + - merge_queue + parameters: + type: object + properties: + check_response_timeout_minutes: + type: integer + description: Maximum time for a required status check + to report a conclusion. After this much time has elapsed, + checks that have not reported a conclusion will be + assumed to have failed + minimum: 1 + maximum: 360 + grouping_strategy: + type: string + description: When set to ALLGREEN, the merge commit + created by merge queue for each PR in the group must + pass all required checks to merge. When set to HEADGREEN, + only the commit at the head of the merge group, i.e. + the commit containing changes from all of the PRs + in the group, must pass its required checks to merge. + enum: + - ALLGREEN + - HEADGREEN + max_entries_to_build: + type: integer + description: Limit the number of queued pull requests + requesting checks and workflow runs at the same time. + minimum: 0 + maximum: 100 + max_entries_to_merge: + type: integer + description: The maximum number of PRs that will be + merged together in a group. + minimum: 0 + maximum: 100 + merge_method: + type: string + description: Method to use when merging changes from + queued pull requests. + enum: + - MERGE + - SQUASH + - REBASE + min_entries_to_merge: + type: integer + description: The minimum number of PRs that will be + merged together in a group. + minimum: 0 + maximum: 100 + min_entries_to_merge_wait_minutes: + type: integer + description: The time merge queue should wait after + the first PR is added to the queue for the minimum + group size to be met. After this time has elapsed, + the minimum group size will be ignored and a smaller + group will be merged. + minimum: 0 + maximum: 360 + required: + - check_response_timeout_minutes + - grouping_strategy + - max_entries_to_build + - max_entries_to_merge + - merge_method + - min_entries_to_merge + - min_entries_to_merge_wait_minutes + - &561 + title: required_deployments + description: Choose which environments must be successfully + deployed to before refs can be pushed into a ref that matches + this rule. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_deployments + parameters: + type: object + properties: + required_deployment_environments: + type: array + description: The environments that must be successfully + deployed to before branches can be merged. + items: + type: string + required: + - required_deployment_environments + - &562 + title: required_signatures + description: Commits pushed to matching refs must have verified + signatures. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_signatures + - &563 + title: pull_request + description: Require all commits be made to a non-target branch + and submitted via a pull request before they can be merged. + type: object + required: + - type + properties: + type: + type: string + enum: + - pull_request + parameters: + type: object + properties: + allowed_merge_methods: + type: array + description: When merging pull requests, you can allow + any combination of merge commits, squashing, or rebasing. + At least one option must be enabled. + items: + type: string + dismiss_stale_reviews_on_push: + type: boolean + description: New, reviewable commits pushed will dismiss + previous pull request review approvals. + require_code_owner_review: + type: boolean + description: Require an approving review in pull requests + that modify files that have a designated code owner. + require_last_push_approval: + type: boolean + description: Whether the most recent reviewable push + must be approved by someone other than the person + who pushed it. + required_approving_review_count: + type: integer + description: The number of approving reviews that are + required before a pull request can be merged. + minimum: 0 + maximum: 10 + required_review_thread_resolution: + type: boolean + description: All conversations on code must be resolved + before a pull request can be merged. + required: + - dismiss_stale_reviews_on_push + - require_code_owner_review + - require_last_push_approval + - required_approving_review_count + - required_review_thread_resolution + - &564 + title: required_status_checks + description: Choose which status checks must pass before the + ref is updated. When enabled, commits must first be pushed + to another ref where the checks pass. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_status_checks + parameters: + type: object + properties: + do_not_enforce_on_create: + type: boolean + description: Allow repositories and branches to be created + if a check would otherwise prohibit it. + required_status_checks: + type: array + description: Status checks that are required. + items: + title: StatusCheckConfiguration + description: Required status check + type: object + properties: + context: + type: string + description: The status check context name that + must be present on the commit. + integration_id: + type: integer + description: The optional integration ID that + this status check must originate from. + required: + - context + strict_required_status_checks_policy: + type: boolean + description: Whether pull requests targeting a matching + branch must be tested with the latest code. This setting + will not take effect unless at least one status check + is enabled. + required: + - required_status_checks + - strict_required_status_checks_policy + - &565 + title: non_fast_forward + description: Prevent users with push access from force pushing + to refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - non_fast_forward + - &566 + title: commit_message_pattern + description: Parameters to be used for the commit_message_pattern + rule + type: object + required: + - type + properties: + type: + type: string + enum: + - commit_message_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern + matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + - &567 + title: commit_author_email_pattern + description: Parameters to be used for the commit_author_email_pattern + rule + type: object + required: + - type + properties: + type: + type: string + enum: + - commit_author_email_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern + matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + - &568 + title: committer_email_pattern + description: Parameters to be used for the committer_email_pattern + rule + type: object + required: + - type + properties: + type: + type: string + enum: + - committer_email_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern + matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + - &569 + title: branch_name_pattern + description: Parameters to be used for the branch_name_pattern + rule + type: object + required: + - type + properties: + type: + type: string + enum: + - branch_name_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern + matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + - &570 + title: tag_name_pattern + description: Parameters to be used for the tag_name_pattern + rule + type: object + required: + - type + properties: + type: + type: string + enum: + - tag_name_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern + matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + - title: file_path_restriction + description: Prevent commits that include changes in specified + file paths from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_path_restriction + parameters: + type: object + properties: + restricted_file_paths: + type: array + description: The file paths that are restricted from + being pushed to the commit graph. + items: + type: string + required: + - restricted_file_paths + - title: max_file_path_length + description: Prevent commits that include file paths that exceed + a specified character limit from being pushed to the commit + graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_path_length + parameters: + type: object + properties: + max_file_path_length: + type: integer + description: The maximum amount of characters allowed + in file paths + minimum: 1 + maximum: 256 + required: + - max_file_path_length + - title: file_extension_restriction + description: Prevent commits that include files with specified + file extensions from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_extension_restriction + parameters: + type: object + properties: + restricted_file_extensions: + type: array + description: The file extensions that are restricted + from being pushed to the commit graph. + items: + type: string + required: + - restricted_file_extensions + - title: max_file_size + description: Prevent commits that exceed a specified file size + limit from being pushed to the commit. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_size + parameters: + type: object + properties: + max_file_size: + type: integer + description: The maximum file size allowed in megabytes. + This limit does not apply to Git Large File Storage + (Git LFS). + minimum: 1 + maximum: 100 + required: + - max_file_size + - &571 + title: workflows + description: Require all changes made to a targeted branch to + pass the specified workflows before they can be merged. + type: object + required: + - type + properties: + type: + type: string + enum: + - workflows + parameters: + type: object + properties: + do_not_enforce_on_create: + type: boolean + description: Allow repositories and branches to be created + if a check would otherwise prohibit it. + workflows: + type: array + description: Workflows that must pass for this rule + to pass. + items: + title: WorkflowFileReference + description: A workflow that must run for this rule + to pass + type: object + properties: + path: + type: string + description: The path to the workflow file + ref: + type: string + description: The ref (branch or tag) of the workflow + file to use + repository_id: + type: integer + description: The ID of the repository where the + workflow is defined + sha: + type: string + description: The commit SHA of the workflow file + to use + required: + - path + - repository_id + required: + - workflows + - &572 + title: code_scanning + description: Choose which tools must provide code scanning results + before the reference is updated. When configured, code scanning + must be enabled and have results for both the commit and the + reference being updated. + type: object + required: + - type + properties: + type: + type: string + enum: + - code_scanning + parameters: + type: object + properties: + code_scanning_tools: + type: array + description: Tools that must provide code scanning results + for this rule to pass. + items: + title: CodeScanningTool + description: A tool that must provide code scanning + results for this rule to pass. + type: object + properties: + alerts_threshold: + type: string + description: The severity level at which code + scanning results that raise alerts block a reference + update. For more information on alert severity + levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + enum: + - none + - errors + - errors_and_warnings + - all + security_alerts_threshold: + type: string + description: The severity level at which code + scanning results that raise security alerts + block a reference update. For more information + on security severity levels, see "[About code + scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + enum: + - none + - critical + - high_or_higher + - medium_or_higher + - all + tool: + type: string + description: The name of a code scanning tool + required: + - alerts_threshold + - security_alerts_threshold + - tool + required: + - code_scanning_tools + required: + - name + - enforcement + examples: + default: + value: + name: super cool ruleset + target: repository + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + org_name: + include: + - important_org + exclude: + - unimportant_org + rules: + - type: repository_delete + responses: + '201': + description: Response + content: + application/json: + schema: &105 + title: Repository ruleset + type: object + description: A set of rules to apply when specified conditions are + met. + required: + - id + - name + - source + - enforcement + properties: + id: + type: integer + description: The ID of the ruleset + name: + type: string + description: The name of the ruleset + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + source_type: + type: string + description: The type of the source of the ruleset + enum: + - Repository + - Organization + - Enterprise + source: + type: string + description: The name of the source + enforcement: *102 + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: *103 + current_user_can_bypass: + type: string + description: |- + The bypass type of the user making the API request for this ruleset. This field is only returned when + querying the repository-level endpoint. + enum: + - always + - pull_requests_only + - never + node_id: + type: string + _links: + type: object + properties: + self: + type: object + properties: + href: + type: string + description: The URL of the ruleset + html: + type: + - object + - 'null' + properties: + href: + type: string + description: The html URL of the ruleset + conditions: + anyOf: + - *98 + - &280 + title: Organization ruleset conditions + type: object + description: |- + Conditions for an organization ruleset. + The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + The push rulesets conditions object does not require the `ref_name` property. + For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. + oneOf: + - type: object + title: repository_name_and_ref_name + description: Conditions to target repositories by name and + refs by name + allOf: + - *98 + - *99 + - type: object + title: repository_id_and_ref_name + description: Conditions to target repositories by id and refs + by name + allOf: + - *98 + - title: Repository ruleset conditions for repository IDs + type: object + description: Parameters for a repository ID condition + properties: + repository_id: + type: object + properties: + repository_ids: + type: array + description: The repository IDs that the ruleset + applies to. One of these IDs must match for the + condition to pass. + items: + type: integer + required: + - repository_id + - type: object + title: repository_property_and_ref_name + description: Conditions to target repositories by property + and refs by name + allOf: + - *98 + - *101 + type: + - 'null' + - object + rules: + type: array + items: *104 + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time + examples: + default: &106 + value: + id: 21 + name: super cool ruleset + target: repository + source_type: Enterprise + source: my-enterprise + enforcement: active + conditions: + organization_name: + include: + - important_organization + repository_name: + include: + - "~ALL" + rules: + - type: repository_delete + node_id: RRS_lACkVXNlcgQB + _links: + self: + href: https://api.github.com/enterprises/my-enterprise/rulesets/21 + html: + href: https://github.com/enterprise/my-enterprise/settings/policies/repositories/21 + created_at: '2024-08-15T08:43:03Z' + updated_at: '2024-09-23T16:29:47Z' + '404': *6 + '500': *80 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: rules + "/enterprises/{enterprise}/rulesets/{ruleset_id}": + get: + summary: Get an enterprise repository ruleset + description: |- + Get a repository ruleset for an enterprise. + + **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + making the API request has write access to the ruleset. + tags: + - repos + operationId: repos/get-enterprise-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset + parameters: + - *38 + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: *105 + examples: + default: *106 + '404': *6 + '500': *80 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: rules + put: + summary: Update an enterprise repository ruleset + description: Update a ruleset for an enterprise. + tags: + - repos + operationId: repos/update-enterprise-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset + parameters: + - *38 + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + requestBody: + description: Request body + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the ruleset. + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + enforcement: *102 + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: *103 + conditions: *107 + rules: + description: An array of rules within the ruleset. + type: array + items: *104 + examples: + default: + value: + name: super cool ruleset + target: repository + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + org_name: + include: + - important_org + exclude: + - unimportant_org + rules: + - type: repository_delete + responses: + '200': + description: Response + content: + application/json: + schema: *105 + examples: + default: *106 + '404': *6 + '500': *80 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: rules + delete: + summary: Delete an enterprise repository ruleset + description: Delete a ruleset for an enterprise. + tags: + - repos + operationId: repos/delete-enterprise-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset + parameters: + - *38 + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '404': *6 + '500': *80 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: rules "/enterprises/{enterprise}/secret-scanning/alerts": get: summary: List secret scanning alerts for an enterprise @@ -13911,7 +15229,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#list-secret-scanning-alerts-for-an-enterprise parameters: - *38 - - &275 + - &282 name: state in: query description: Set to `open` or `resolved` to only list secret scanning alerts @@ -13922,7 +15240,7 @@ paths: enum: - open - resolved - - &276 + - &283 name: secret_type in: query description: |- @@ -13932,7 +15250,7 @@ paths: required: false schema: type: string - - &277 + - &284 name: resolution in: query description: A comma-separated list of resolutions. Only secret scanning alerts @@ -13941,7 +15259,7 @@ paths: required: false schema: type: string - - &278 + - &285 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. @@ -13957,7 +15275,7 @@ paths: - *17 - *74 - *75 - - &279 + - &286 name: validity in: query description: A comma-separated list of validities that, when present, will @@ -13966,7 +15284,7 @@ paths: required: false schema: type: string - - &280 + - &287 name: is_publicly_leaked in: query description: A boolean value representing whether or not to filter alerts @@ -13975,7 +15293,7 @@ paths: schema: type: boolean default: false - - &281 + - &288 name: is_multi_repo in: query description: A boolean value representing whether or not to filter alerts @@ -13991,7 +15309,7 @@ paths: application/json: schema: type: array - items: &282 + items: &289 type: object properties: number: *81 @@ -14007,14 +15325,14 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: &579 + state: &586 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: &580 + resolution: &587 type: - string - 'null' @@ -14070,6 +15388,12 @@ paths: anyOf: - type: 'null' - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. push_protection_bypass_request_comment: type: - string @@ -14107,7 +15431,7 @@ paths: description: Whether the detected secret was found in multiple repositories in the same organization or enterprise. examples: - default: &283 + default: &290 value: - number: 2 created_at: '2020-11-06T18:48:51Z' @@ -14244,6 +15568,7 @@ paths: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true + push_protection_bypass_request_reviewer_comment: Example response push_protection_bypass_request_comment: Example comment push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment @@ -14331,6 +15656,7 @@ paths: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -14340,7 +15666,7 @@ paths: headers: Link: *37 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -14368,7 +15694,7 @@ paths: description: Response content: application/json: - schema: &285 + schema: &292 type: object properties: total_minutes_used: @@ -14438,7 +15764,7 @@ paths: - included_minutes - minutes_used_breakdown examples: - default: &286 + default: &293 value: total_minutes_used: 305 total_paid_minutes_used: 0 @@ -14476,7 +15802,7 @@ paths: description: Success content: application/json: - schema: &287 + schema: &294 type: object properties: total_advanced_security_committers: @@ -14539,7 +15865,7 @@ paths: required: - repositories examples: - default: &288 + default: &295 value: total_advanced_security_committers: 2 total_count: 2 @@ -14627,7 +15953,7 @@ paths: '400': *14 '403': *27 '500': *80 - '503': *96 + '503': *108 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14648,7 +15974,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#add-users-to-a-cost-center parameters: - *38 - - &97 + - &109 name: cost_center_id description: The ID corresponding to the cost center. in: path @@ -14690,13 +16016,13 @@ paths: message: Resources successfully added to the cost center. '400': *14 '403': *27 - '409': &143 + '409': &155 description: Conflict content: application/json: schema: *3 '500': *80 - '503': *96 + '503': *108 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14716,7 +16042,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#remove-users-from-a-cost-center parameters: - *38 - - *97 + - *109 requestBody: required: true content: @@ -14754,7 +16080,7 @@ paths: '400': *14 '403': *27 '500': *80 - '503': *96 + '503': *108 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -14782,7 +16108,7 @@ paths: description: Response content: application/json: - schema: &289 + schema: &296 type: object properties: total_gigabytes_bandwidth_used: @@ -14800,7 +16126,7 @@ paths: - total_paid_gigabytes_bandwidth_used - included_gigabytes_bandwidth examples: - default: &290 + default: &297 value: total_gigabytes_bandwidth_used: 50 total_paid_gigabytes_bandwidth_used: 40 @@ -14832,7 +16158,7 @@ paths: description: Response content: application/json: - schema: &291 + schema: &298 type: object properties: days_left_in_billing_cycle: @@ -14850,7 +16176,7 @@ paths: - estimated_paid_storage_for_month - estimated_storage_for_month examples: - default: &292 + default: &299 value: days_left_in_billing_cycle: 20 estimated_paid_storage_for_month: 15 @@ -14875,7 +16201,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/billing#get-billing-usage-report-for-an-enterprise parameters: - *38 - - &132 + - &144 name: year description: If specified, only return results for a single year. The value of `year` is an integer with four digits representing a year. For example, @@ -14884,7 +16210,7 @@ paths: required: false schema: type: integer - - &133 + - &145 name: month description: If specified, only return results for a single month. The value of `month` is an integer between `1` and `12`. @@ -14892,7 +16218,7 @@ paths: required: false schema: type: integer - - &134 + - &146 name: day description: If specified, only return results for a single day. The value of `day` is an integer between `1` and `31`. @@ -14900,7 +16226,7 @@ paths: required: false schema: type: integer - - &135 + - &147 name: hour description: If specified, only return results for a single hour. The value of `hour` is an integer between `0` and `23`. @@ -14920,7 +16246,7 @@ paths: description: Response when getting a billing usage report content: application/json: - schema: &136 + schema: &148 type: object properties: usageItems: @@ -14973,7 +16299,7 @@ paths: - netAmount - organizationName examples: - default: &137 + default: &149 value: usageItems: - date: '2023-08-01' @@ -14990,7 +16316,7 @@ paths: '400': *14 '403': *27 '500': *80 - '503': *96 + '503': *108 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -15061,15 +16387,15 @@ paths: application/json: schema: type: array - items: *98 + items: *110 examples: - default: *99 + default: *111 '500': *80 '403': *27 '404': *6 - '422': *100 + '422': *112 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-metrics @@ -15102,7 +16428,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-an-enterprise-team parameters: - *38 - - &246 + - &258 name: team_slug description: The slug of the team name. in: path @@ -15140,9 +16466,9 @@ paths: application/json: schema: type: array - items: *101 + items: *113 examples: - default: &192 + default: &204 value: - day: '2023-10-15' total_suggestions_count: 1000 @@ -15211,7 +16537,7 @@ paths: '403': *27 '404': *6 x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage @@ -15298,7 +16624,7 @@ paths: application/json: schema: type: array - items: &127 + items: &139 title: Event description: Event type: object @@ -15309,7 +16635,7 @@ paths: type: - string - 'null' - actor: &102 + actor: &114 title: Actor description: Actor type: object @@ -15350,13 +16676,13 @@ paths: - id - name - url - org: *102 + org: *114 payload: type: object properties: action: type: string - issue: &116 + issue: &128 title: Issue description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects. @@ -15476,7 +16802,7 @@ paths: milestone: anyOf: - type: 'null' - - &429 + - &436 title: Milestone description: A collection of related issues and pull requests. @@ -15653,7 +16979,7 @@ paths: anyOf: - type: 'null' - *5 - author_association: &103 + author_association: &115 title: author_association type: string description: How the author is associated with the repository. @@ -15668,7 +16994,7 @@ paths: - OWNER examples: - OWNER - reactions: &104 + reactions: &116 title: Reaction Rollup type: object properties: @@ -15740,7 +17066,7 @@ paths: - author_association - created_at - updated_at - comment: &488 + comment: &495 title: Issue Comment description: Comments provide a way for people to collaborate on an issue. @@ -15790,12 +17116,12 @@ paths: issue_url: type: string format: uri - author_association: *103 + author_association: *115 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *104 + reactions: *116 required: - id - node_id @@ -15892,7 +17218,7 @@ paths: created_at: '2022-06-07T07:50:26Z' '304': *35 '403': *27 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -15982,7 +17308,7 @@ paths: _links: type: object properties: - timeline: &105 + timeline: &117 title: Link With Type description: Hypermedia Link with Type type: object @@ -15994,17 +17320,17 @@ paths: required: - href - type - user: *105 - security_advisories: *105 - current_user: *105 - current_user_public: *105 - current_user_actor: *105 - current_user_organization: *105 + user: *117 + security_advisories: *117 + current_user: *117 + current_user_public: *117 + current_user_actor: *117 + current_user_organization: *117 current_user_organizations: type: array - items: *105 - repository_discussions: *105 - repository_discussions_category: *105 + items: *117 + repository_discussions: *117 + repository_discussions_category: *117 required: - timeline - user @@ -16066,7 +17392,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-the-authenticated-user parameters: - - *106 + - *118 - *17 - *18 responses: @@ -16076,7 +17402,7 @@ paths: application/json: schema: type: array - items: &107 + items: &119 title: Base Gist description: Base Gist type: object @@ -16171,7 +17497,7 @@ paths: - created_at - updated_at examples: - default: &108 + default: &120 value: - url: https://api.github.com/gists/aa5a315d61ae9438b18d forks_url: https://api.github.com/gists/aa5a315d61ae9438b18d/forks @@ -16295,7 +17621,7 @@ paths: description: Response content: application/json: - schema: &109 + schema: &121 title: Gist Simple description: Gist Simple type: object @@ -16313,7 +17639,7 @@ paths: url: type: string format: uri - user: &636 + user: &643 title: Public User description: Public User type: object @@ -16683,7 +18009,7 @@ paths: truncated: type: boolean examples: - default: &110 + default: &122 value: url: https://api.github.com/gists/2decf6c462d9b4418f2 forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks @@ -16786,7 +18112,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-public-gists parameters: - - *106 + - *118 - *17 - *18 responses: @@ -16796,9 +18122,9 @@ paths: application/json: schema: type: array - items: *107 + items: *119 examples: - default: *108 + default: *120 headers: Link: *37 '422': *15 @@ -16820,7 +18146,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-starred-gists parameters: - - *106 + - *118 - *17 - *18 responses: @@ -16830,9 +18156,9 @@ paths: application/json: schema: type: array - items: *107 + items: *119 examples: - default: *108 + default: *120 headers: Link: *37 '401': *23 @@ -16860,7 +18186,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist parameters: - - &111 + - &123 name: gist_id description: The unique identifier of the gist. in: path @@ -16872,10 +18198,10 @@ paths: description: Response content: application/json: - schema: *109 + schema: *121 examples: - default: *110 - '403': &114 + default: *122 + '403': &126 description: Forbidden Gist content: application/json: @@ -16924,7 +18250,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#update-a-gist parameters: - - *111 + - *123 requestBody: required: true content: @@ -16988,9 +18314,9 @@ paths: description: Response content: application/json: - schema: *109 + schema: *121 examples: - updateGist: *110 + updateGist: *122 deleteFile: value: url: https://api.github.com/gists/2decf6c462d9b4418f2 @@ -17148,7 +18474,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#delete-a-gist parameters: - - *111 + - *123 responses: '204': description: Response @@ -17177,7 +18503,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#list-gist-comments parameters: - - *111 + - *123 - *17 - *18 responses: @@ -17187,7 +18513,7 @@ paths: application/json: schema: type: array - items: &112 + items: &124 title: Gist Comment description: A comment made to a gist. type: object @@ -17225,7 +18551,7 @@ paths: format: date-time examples: - '2011-04-18T23:23:56Z' - author_association: *103 + author_association: *115 required: - url - id @@ -17290,7 +18616,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#create-a-gist-comment parameters: - - *111 + - *123 requestBody: required: true content: @@ -17316,9 +18642,9 @@ paths: description: Response content: application/json: - schema: *112 + schema: *124 examples: - default: &113 + default: &125 value: id: 1 node_id: MDExOkdpc3RDb21tZW50MQ== @@ -17376,8 +18702,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#get-a-gist-comment parameters: - - *111 - - &115 + - *123 + - &127 name: comment_id description: The unique identifier of the comment. in: path @@ -17390,12 +18716,12 @@ paths: description: Response content: application/json: - schema: *112 + schema: *124 examples: - default: *113 + default: *125 '304': *35 '404': *6 - '403': *114 + '403': *126 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -17417,8 +18743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#update-a-gist-comment parameters: - - *111 - - *115 + - *123 + - *127 requestBody: required: true content: @@ -17444,9 +18770,9 @@ paths: description: Response content: application/json: - schema: *112 + schema: *124 examples: - default: *113 + default: *125 '404': *6 x-github: githubCloudOnly: false @@ -17463,8 +18789,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/comments#delete-a-gist-comment parameters: - - *111 - - *115 + - *123 + - *127 responses: '204': description: Response @@ -17487,7 +18813,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-commits parameters: - - *111 + - *123 - *17 - *18 responses: @@ -17588,7 +18914,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gist-forks parameters: - - *111 + - *123 - *17 - *18 responses: @@ -17598,7 +18924,7 @@ paths: application/json: schema: type: array - items: *109 + items: *121 examples: default: value: @@ -17663,13 +18989,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#fork-a-gist parameters: - - *111 + - *123 responses: '201': description: Response content: application/json: - schema: *107 + schema: *119 examples: default: value: @@ -17740,7 +19066,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#check-if-a-gist-is-starred parameters: - - *111 + - *123 responses: '204': description: Response if gist is starred @@ -17770,7 +19096,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#star-a-gist parameters: - - *111 + - *123 responses: '204': description: Response @@ -17792,7 +19118,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#unstar-a-gist parameters: - - *111 + - *123 responses: '204': description: Response @@ -17821,7 +19147,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#get-a-gist-revision parameters: - - *111 + - *123 - name: sha in: path required: true @@ -17832,9 +19158,9 @@ paths: description: Response content: application/json: - schema: *109 + schema: *121 examples: - default: *110 + default: *122 '422': *15 '404': *6 '403': *27 @@ -18203,7 +19529,7 @@ paths: - closed - all default: open - - &235 + - &247 name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query @@ -18222,7 +19548,7 @@ paths: - comments default: created - *76 - - *106 + - *118 - name: collab in: query required: false @@ -18252,9 +19578,9 @@ paths: application/json: schema: type: array - items: *116 + items: *128 examples: - default: &236 + default: &248 value: - id: 1 node_id: MDU6SXNzdWUx @@ -18534,7 +19860,7 @@ paths: application/json: schema: type: array - items: *117 + items: *129 examples: default: value: @@ -18831,7 +20157,7 @@ paths: example: '279' schema: type: string - X-CommonMarker-Version: &118 + X-CommonMarker-Version: &130 example: 0.17.4 schema: type: string @@ -18886,7 +20212,7 @@ paths: '200': description: Response headers: - X-CommonMarker-Version: *118 + X-CommonMarker-Version: *130 content: text/html: schema: @@ -18915,7 +20241,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: - - &121 + - &133 name: account_id description: account_id parameter in: path @@ -18927,7 +20253,7 @@ paths: description: Response content: application/json: - schema: &120 + schema: &132 title: Marketplace Purchase description: Marketplace Purchase type: object @@ -18961,7 +20287,7 @@ paths: - 'null' id: type: integer - plan: &119 + plan: &131 title: Marketplace Listing Plan description: Marketplace Listing Plan type: object @@ -19064,7 +20390,7 @@ paths: - 'null' updated_at: type: string - plan: *119 + plan: *131 required: - url - id @@ -19072,7 +20398,7 @@ paths: - login - marketplace_purchase examples: - default: &122 + default: &134 value: url: https://api.github.com/orgs/github type: Organization @@ -19157,9 +20483,9 @@ paths: application/json: schema: type: array - items: *119 + items: *131 examples: - default: &123 + default: &135 value: - url: https://api.github.com/marketplace_listing/plans/1313 accounts_url: https://api.github.com/marketplace_listing/plans/1313/accounts @@ -19199,14 +20525,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan parameters: - - &124 + - &136 name: plan_id description: The unique identifier of the plan. in: path required: true schema: type: integer - - &125 + - &137 name: sort description: The property to sort the results by. in: query @@ -19236,9 +20562,9 @@ paths: application/json: schema: type: array - items: *120 + items: *132 examples: - default: &126 + default: &138 value: - url: https://api.github.com/orgs/github type: Organization @@ -19312,15 +20638,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: - - *121 + - *133 responses: '200': description: Response content: application/json: - schema: *120 + schema: *132 examples: - default: *122 + default: *134 '404': description: Not Found when the account has not purchased the listing '401': *23 @@ -19352,9 +20678,9 @@ paths: application/json: schema: type: array - items: *119 + items: *131 examples: - default: *123 + default: *135 headers: Link: *37 '401': *23 @@ -19377,8 +20703,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/apps/marketplace#list-accounts-for-a-plan-stubbed parameters: - - *124 - - *125 + - *136 + - *137 - name: direction description: To return the oldest accounts first, set to `asc`. Ignored without the `sort` parameter. @@ -19398,9 +20724,9 @@ paths: application/json: schema: type: array - items: *120 + items: *132 examples: - default: *126 + default: *138 headers: Link: *37 '401': *23 @@ -19650,14 +20976,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: - - &312 + - &319 name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string - - &313 + - &320 name: repo description: The name of the repository without the `.git` extension. The name is not case sensitive. @@ -19674,7 +21000,7 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: default: value: @@ -19728,7 +21054,7 @@ paths: '404': *6 '403': *27 '304': *35 - '301': &326 + '301': &333 description: Moved permanently content: application/json: @@ -19750,7 +21076,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#list-notifications-for-the-authenticated-user parameters: - - &517 + - &524 name: all description: If `true`, show notifications marked as read. in: query @@ -19758,7 +21084,7 @@ paths: schema: type: boolean default: false - - &518 + - &525 name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. @@ -19767,8 +21093,8 @@ paths: schema: type: boolean default: false - - *106 - - &519 + - *118 + - &526 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: @@ -19793,14 +21119,14 @@ paths: application/json: schema: type: array - items: &128 + items: &140 title: Thread description: Thread type: object properties: id: type: string - repository: &156 + repository: &168 title: Minimal Repository description: Minimal Repository type: object @@ -20139,7 +21465,7 @@ paths: type: boolean examples: - false - security_and_analysis: &264 + security_and_analysis: &277 type: - object - 'null' @@ -20294,7 +21620,7 @@ paths: - url - subscription_url examples: - default: &520 + default: &527 value: - id: '1' repository: @@ -20460,7 +21786,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#get-a-thread parameters: - - &129 + - &141 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 @@ -20474,7 +21800,7 @@ paths: description: Response content: application/json: - schema: *128 + schema: *140 examples: default: value: @@ -20577,7 +21903,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-read parameters: - - *129 + - *141 responses: '205': description: Reset Content @@ -20600,7 +21926,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-a-thread-as-done parameters: - - *129 + - *141 responses: '204': description: No content @@ -20623,13 +21949,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: - - *129 + - *141 responses: '200': description: Response content: application/json: - schema: &130 + schema: &142 title: Thread Subscription description: Thread Subscription type: object @@ -20673,7 +21999,7 @@ paths: - url - subscribed examples: - default: &131 + default: &143 value: subscribed: true ignored: false @@ -20704,7 +22030,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#set-a-thread-subscription parameters: - - *129 + - *141 requestBody: required: false content: @@ -20725,9 +22051,9 @@ paths: description: Response content: application/json: - schema: *130 + schema: *142 examples: - default: *131 + default: *143 '304': *35 '403': *27 '401': *23 @@ -20750,7 +22076,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#delete-a-thread-subscription parameters: - - *129 + - *141 responses: '204': description: Response @@ -20847,7 +22173,7 @@ paths: type: array items: *50 examples: - default: &653 + default: &660 value: - login: github id: 1 @@ -20912,7 +22238,7 @@ paths: - 3 custom_roles: type: array - items: &193 + items: &205 title: Organization Custom Repository Role description: Custom repository roles created by organization owners @@ -20961,7 +22287,7 @@ paths: - created_at - updated_at examples: - default: &194 + default: &206 value: id: 8030 name: Security Engineer @@ -21007,29 +22333,29 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/billing/enhanced-billing#get-billing-usage-report-for-an-organization parameters: - - &138 + - &150 name: org description: The organization name. The name is not case sensitive. in: path required: true schema: type: string - - *132 - - *133 - - *134 - - *135 + - *144 + - *145 + - *146 + - *147 responses: '200': description: Billing usage report response for an organization content: application/json: - schema: *136 + schema: *148 examples: - default: *137 + default: *149 '400': *14 '403': *27 '500': *80 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21055,13 +22381,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#get-an-organization parameters: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: &139 + schema: &151 title: Organization Full description: |- Prevents users in the organization from using insecure methods of two-factor authentication to fulfill a two-factor requirement. @@ -21431,7 +22757,7 @@ paths: - updated_at - archived_at examples: - default-response: &140 + default-response: &152 value: login: github id: 1 @@ -21524,7 +22850,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#update-an-organization parameters: - - *138 + - *150 requestBody: required: false content: @@ -21748,18 +23074,18 @@ paths: description: Response content: application/json: - schema: *139 + schema: *151 examples: - default: *140 + default: *152 '422': description: Validation failed content: application/json: schema: oneOf: - - *141 - - *142 - '409': *143 + - *153 + - *154 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -21782,9 +23108,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#delete-an-organization parameters: - - *138 + - *150 responses: - '202': *144 + '202': *156 '404': *6 '403': *27 x-github: @@ -21807,15 +23133,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: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: *145 + schema: *157 examples: - default: *146 + default: *158 headers: Link: *37 x-github: @@ -21838,7 +23164,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: - - *138 + - *150 - *17 - *18 responses: @@ -21856,7 +23182,7 @@ paths: type: integer repository_cache_usages: type: array - items: &331 + items: &338 title: Actions Cache Usage by repository description: GitHub Actions Cache Usage by repository. type: object @@ -21914,13 +23240,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: - - *138 + - *150 responses: '200': description: A JSON serialized template for OIDC subject claim customization content: application/json: - schema: &147 + schema: &159 title: Actions OIDC Subject customization description: Actions OIDC Subject customization type: object @@ -21934,7 +23260,7 @@ paths: required: - include_claim_keys examples: - default: &148 + default: &160 value: include_claim_keys: - repo @@ -21956,20 +23282,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: - - *138 + - *150 requestBody: required: true content: application/json: - schema: *147 + schema: *159 examples: - default: *148 + default: *160 responses: '201': description: Empty response content: application/json: - schema: &167 + schema: &179 title: Empty Object description: An object without any properties. type: object @@ -21999,7 +23325,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: - - *138 + - *150 responses: '200': description: Response @@ -22008,7 +23334,7 @@ paths: schema: type: object properties: - enabled_repositories: &150 + enabled_repositories: &162 type: string description: The policy that controls the repositories in the organization that are allowed to run GitHub Actions. @@ -22022,7 +23348,7 @@ paths: that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`. allowed_actions: *40 - selected_actions_url: *149 + selected_actions_url: *161 required: - enabled_repositories examples: @@ -22051,7 +23377,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: - - *138 + - *150 responses: '204': description: Response @@ -22062,7 +23388,7 @@ paths: schema: type: object properties: - enabled_repositories: *150 + enabled_repositories: *162 allowed_actions: *40 required: - enabled_repositories @@ -22090,7 +23416,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: - - *138 + - *150 - *17 - *18 responses: @@ -22110,7 +23436,7 @@ paths: type: array items: *55 examples: - default: &647 + default: &654 value: total_count: 1 repositories: @@ -22250,7 +23576,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: - - *138 + - *150 responses: '204': description: Response @@ -22294,8 +23620,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: - - *138 - - &151 + - *150 + - &163 name: repository_id description: The unique identifier of the repository. in: path @@ -22323,8 +23649,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: - - *138 - - *151 + - *150 + - *163 responses: '204': description: Response @@ -22347,7 +23673,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: - - *138 + - *150 responses: '200': description: Response @@ -22378,7 +23704,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: - - *138 + - *150 responses: '204': description: Response @@ -22410,13 +23736,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: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: *152 + schema: *164 examples: default: *46 x-github: @@ -22439,7 +23765,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: - - *138 + - *150 responses: '204': description: Success response @@ -22450,7 +23776,7 @@ paths: required: false content: application/json: - schema: *153 + schema: *165 examples: default: *46 x-github: @@ -22472,7 +23798,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: - - *138 + - *150 - *17 - *18 - name: visible_to_repository @@ -22497,7 +23823,7 @@ paths: type: number runner_groups: type: array - items: &154 + items: &166 type: object properties: id: @@ -22610,7 +23936,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: - - *138 + - *150 requestBody: required: true content: @@ -22680,9 +24006,9 @@ paths: description: Response content: application/json: - schema: *154 + schema: *166 examples: - default: &155 + default: &167 value: id: 2 name: octo-runner-group @@ -22717,14 +24043,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: - - *138 + - *150 - *49 responses: '200': description: Response content: application/json: - schema: *154 + schema: *166 examples: default: value: @@ -22760,7 +24086,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: - - *138 + - *150 - *49 requestBody: required: true @@ -22812,9 +24138,9 @@ paths: description: Response content: application/json: - schema: *154 + schema: *166 examples: - default: *155 + default: *167 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -22833,7 +24159,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: - - *138 + - *150 - *49 responses: '204': @@ -22857,7 +24183,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: - - *138 + - *150 - *49 - *18 - *17 @@ -22876,9 +24202,9 @@ paths: type: number repositories: type: array - items: *156 + items: *168 examples: - default: &639 + default: &646 value: total_count: 1 repositories: @@ -23130,7 +24456,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: - - *138 + - *150 - *49 requestBody: required: true @@ -23175,9 +24501,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: - - *138 + - *150 - *49 - - *151 + - *163 responses: '204': description: Response @@ -23199,9 +24525,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: - - *138 + - *150 - *49 - - *151 + - *163 responses: '204': description: Response @@ -23224,7 +24550,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: - - *138 + - *150 - *49 - *17 - *18 @@ -23266,7 +24592,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: - - *138 + - *150 - *49 requestBody: required: true @@ -23311,7 +24637,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: - - *138 + - *150 - *49 - *52 responses: @@ -23335,7 +24661,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: - - *138 + - *150 - *49 - *52 responses: @@ -23367,7 +24693,7 @@ paths: in: query schema: type: string - - *138 + - *150 - *17 - *18 responses: @@ -23411,7 +24737,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: - - *138 + - *150 responses: '200': description: Response @@ -23419,9 +24745,9 @@ paths: application/json: schema: type: array - items: *157 + items: *169 examples: - default: *158 + default: *170 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23443,7 +24769,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: - - *138 + - *150 requestBody: required: true content: @@ -23486,7 +24812,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *159 + '201': *171 '404': *6 '422': *7 x-github: @@ -23516,7 +24842,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: - - *138 + - *150 responses: '201': description: Response @@ -23524,7 +24850,7 @@ paths: application/json: schema: *56 examples: - default: *160 + default: *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23552,7 +24878,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: - - *138 + - *150 responses: '201': description: Response @@ -23560,7 +24886,7 @@ paths: application/json: schema: *56 examples: - default: *161 + default: *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23582,7 +24908,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: - - *138 + - *150 - *52 responses: '200': @@ -23591,7 +24917,7 @@ paths: application/json: schema: *53 examples: - default: *162 + default: *174 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -23612,7 +24938,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: - - *138 + - *150 - *52 responses: '204': @@ -23638,7 +24964,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: - - *138 + - *150 - *52 responses: '200': *58 @@ -23663,7 +24989,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: - - *138 + - *150 - *52 requestBody: required: true @@ -23712,7 +25038,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: - - *138 + - *150 - *52 requestBody: required: true @@ -23762,10 +25088,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: - - *138 + - *150 - *52 responses: - '200': *163 + '200': *175 '404': *6 x-github: githubCloudOnly: false @@ -23792,9 +25118,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: - - *138 + - *150 - *52 - - *164 + - *176 responses: '200': *58 '404': *6 @@ -23821,7 +25147,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-organization-secrets parameters: - - *138 + - *150 - *17 - *18 responses: @@ -23839,7 +25165,7 @@ paths: type: integer secrets: type: array - items: &165 + items: &177 title: Actions Secret for an Organization description: Secrets for GitHub Actions for an organization. type: object @@ -23914,13 +25240,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-public-key parameters: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: &351 + schema: &358 title: ActionsPublicKey description: The public key used for setting Actions Secrets. type: object @@ -23955,7 +25281,7 @@ paths: - key_id - key examples: - default: &352 + default: &359 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -23980,8 +25306,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-organization-secret parameters: - - *138 - - &166 + - *150 + - &178 name: secret_name description: The name of the secret. in: path @@ -23993,7 +25319,7 @@ paths: description: Response content: application/json: - schema: *165 + schema: *177 examples: default: value: @@ -24023,8 +25349,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-organization-secret parameters: - - *138 - - *166 + - *150 + - *178 requestBody: required: true content: @@ -24079,7 +25405,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -24105,8 +25431,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-organization-secret parameters: - - *138 - - *166 + - *150 + - *178 responses: '204': description: Response @@ -24132,8 +25458,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: - - *138 - - *166 + - *150 + - *178 - *18 - *17 responses: @@ -24151,9 +25477,9 @@ paths: type: integer repositories: type: array - items: *156 + items: *168 examples: - default: &170 + default: &182 value: total_count: 1 repositories: @@ -24245,8 +25571,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: - - *138 - - *166 + - *150 + - *178 requestBody: required: true content: @@ -24298,8 +25624,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: - - *138 - - *166 + - *150 + - *178 - name: repository_id in: path required: true @@ -24332,8 +25658,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: - - *138 - - *166 + - *150 + - *178 - name: repository_id in: path required: true @@ -24365,8 +25691,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-organization-variables parameters: - - *138 - - &336 + - *150 + - &343 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)." @@ -24390,7 +25716,7 @@ paths: type: integer variables: type: array - items: &168 + items: &180 title: Actions Variable for an Organization description: Organization variable for GitHub Actions. type: object @@ -24480,7 +25806,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-organization-variable parameters: - - *138 + - *150 requestBody: required: true content: @@ -24528,7 +25854,7 @@ paths: description: Response when creating a variable content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -24553,8 +25879,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-organization-variable parameters: - - *138 - - &169 + - *150 + - &181 name: name description: The name of the variable. in: path @@ -24566,7 +25892,7 @@ paths: description: Response content: application/json: - schema: *168 + schema: *180 examples: default: value: @@ -24596,8 +25922,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-organization-variable parameters: - - *138 - - *169 + - *150 + - *181 requestBody: required: true content: @@ -24659,8 +25985,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-organization-variable parameters: - - *138 - - *169 + - *150 + - *181 responses: '204': description: Response @@ -24686,8 +26012,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: - - *138 - - *169 + - *150 + - *181 - *18 - *17 responses: @@ -24705,9 +26031,9 @@ paths: type: integer repositories: type: array - items: *156 + items: *168 examples: - default: *170 + default: *182 '409': description: Response when the visibility of the variable is not set to `selected` @@ -24733,8 +26059,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: - - *138 - - *169 + - *150 + - *181 requestBody: required: true content: @@ -24783,8 +26109,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: - - *138 - - *169 + - *150 + - *181 - name: repository_id in: path required: true @@ -24818,8 +26144,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: - - *138 - - *169 + - *150 + - *181 - name: repository_id in: path required: true @@ -24850,7 +26176,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#get-announcement-banner-for-organization parameters: - - *138 + - *150 responses: '200': description: Response @@ -24877,11 +26203,11 @@ paths: required: true content: application/json: - schema: *171 + schema: *183 examples: default: *61 parameters: - - *138 + - *150 responses: '200': description: Response @@ -24905,7 +26231,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/announcement-banners/organizations#remove-announcement-banner-from-organization parameters: - - *138 + - *150 responses: '204': description: Response @@ -24933,7 +26259,7 @@ paths: - *17 - *74 - *75 - - *138 + - *150 - name: subject_digest description: The parameter should be set to the attestation's subject's SHA256 digest, in the form `sha256:HEX_DIGEST`. @@ -24973,8 +26299,10 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: - default: &365 + default: &372 value: attestations: - bundle: @@ -25092,7 +26420,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: - - *138 + - *150 - 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). @@ -25100,10 +26428,10 @@ paths: required: false schema: type: string - - *172 - - *173 - - *174 - - *175 + - *184 + - *185 + - *186 + - *187 - *17 responses: '200': @@ -25112,9 +26440,9 @@ paths: application/json: schema: type: array - items: *176 + items: *188 examples: - default: *177 + default: *189 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -25131,7 +26459,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#list-users-blocked-by-an-organization parameters: - - *138 + - *150 - *17 - *18 responses: @@ -25143,7 +26471,7 @@ paths: type: array items: *4 examples: - default: &237 + default: &249 value: - login: octocat id: 1 @@ -25181,8 +26509,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: - - *138 - - &178 + - *150 + - &190 name: username description: The handle for the GitHub user account. in: path @@ -25213,8 +26541,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#block-a-user-from-an-organization parameters: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response @@ -25234,8 +26562,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/blocking#unblock-a-user-from-an-organization parameters: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response @@ -25260,9 +26588,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: - - *138 - - *179 - - *180 + - *150 + - *191 + - *192 - *74 - *75 - *18 @@ -25273,7 +26601,7 @@ paths: be returned. in: query required: false - schema: *181 + schema: *193 - name: sort description: The property by which to sort the results. in: query @@ -25289,7 +26617,7 @@ paths: be returned. in: query required: false - schema: &391 + schema: &398 type: string description: Severity of a code scanning alert. enum: @@ -25307,13 +26635,13 @@ paths: application/json: schema: type: array - items: *182 + items: *194 examples: - default: *183 + default: *195 headers: Link: *37 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -25335,7 +26663,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: - - *138 + - *150 - name: target_type in: query description: The target type of the code security configuration @@ -25363,7 +26691,7 @@ paths: application/json: schema: type: array - items: &184 + items: &196 type: object description: A code security configuration properties: @@ -25625,7 +26953,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#create-a-code-security-configuration parameters: - - *138 + - *150 requestBody: required: true content: @@ -25698,7 +27026,7 @@ paths: - disabled - not_set default: disabled - code_scanning_default_setup_options: &188 + code_scanning_default_setup_options: &200 type: - object - 'null' @@ -25817,9 +27145,9 @@ paths: description: Successfully created code security configuration content: application/json: - schema: *184 + schema: *196 examples: - default: &186 + default: &198 value: id: 1325 target_type: organization @@ -25868,7 +27196,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-default-code-security-configurations parameters: - - *138 + - *150 responses: '200': description: Response @@ -25888,7 +27216,7 @@ paths: description: The visibility of newly created repositories for which the code security configuration will be applied to by default - configuration: *184 + configuration: *196 examples: default: value: @@ -25978,7 +27306,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#detach-configurations-from-repositories parameters: - - *138 + - *150 requestBody: required: true content: @@ -26001,11 +27329,11 @@ paths: - 32 - 91 responses: - '204': *185 + '204': *197 '400': *14 '403': *27 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26027,8 +27355,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#get-a-code-security-configuration parameters: - - *138 - - &187 + - *150 + - &199 name: configuration_id description: The unique identifier of the code security configuration. in: path @@ -26040,9 +27368,9 @@ paths: description: Response content: application/json: - schema: *184 + schema: *196 examples: - default: *186 + default: *198 '304': *35 '403': *27 '404': *6 @@ -26066,8 +27394,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#update-a-code-security-configuration parameters: - - *138 - - *187 + - *150 + - *199 requestBody: required: true content: @@ -26133,7 +27461,7 @@ paths: - enabled - disabled - not_set - code_scanning_default_setup_options: *188 + code_scanning_default_setup_options: *200 secret_scanning: type: string description: The enablement status of secret scanning @@ -26220,7 +27548,7 @@ paths: description: Response when a configuration is updated content: application/json: - schema: *184 + schema: *196 examples: default: value: @@ -26274,14 +27602,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#delete-a-code-security-configuration parameters: - - *138 - - *187 + - *150 + - *199 responses: - '204': *185 + '204': *197 '400': *14 '403': *27 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26305,8 +27633,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-security/configurations#attach-a-configuration-to-repositories parameters: - - *138 - - *187 + - *150 + - *199 requestBody: required: true content: @@ -26345,7 +27673,7 @@ paths: - 32 - 91 responses: - '202': *144 + '202': *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -26369,8 +27697,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: - - *138 - - *187 + - *150 + - *199 requestBody: required: true content: @@ -26410,12 +27738,12 @@ paths: - none - private_and_internal - public - configuration: *184 + configuration: *196 examples: default: value: default_for_new_repos: all - configuration: *186 + configuration: *198 '403': *27 '404': *6 x-github: @@ -26439,8 +27767,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: - - *138 - - *187 + - *150 + - *199 - 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)." @@ -26583,7 +27911,7 @@ paths: parameters: - *17 - *18 - - *138 + - *150 responses: '200': description: Response @@ -26599,7 +27927,7 @@ paths: type: integer codespaces: type: array - items: &238 + items: &250 type: object title: Codespace description: A codespace. @@ -26630,11 +27958,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *156 + repository: *168 machine: anyOf: - type: 'null' - - &417 + - &424 type: object title: Codespace machine description: A description of the machine powering a codespace. @@ -26921,7 +28249,7 @@ paths: - pulls_url - recent_folders examples: - default: &239 + default: &251 value: total_count: 3 codespaces: @@ -27353,7 +28681,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#manage-access-control-for-organization-codespaces parameters: - - *138 + - *150 deprecated: true requestBody: required: true @@ -27420,7 +28748,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: - - *138 + - *150 deprecated: true requestBody: required: true @@ -27475,7 +28803,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#remove-users-from-codespaces-access-for-an-organization deprecated: true parameters: - - *138 + - *150 requestBody: required: true content: @@ -27527,7 +28855,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#list-organization-secrets parameters: - - *138 + - *150 - *17 - *18 responses: @@ -27545,7 +28873,7 @@ paths: type: integer secrets: type: array - items: &189 + items: &201 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -27586,7 +28914,7 @@ paths: - updated_at - visibility examples: - default: &418 + default: &425 value: total_count: 2 secrets: @@ -27618,13 +28946,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-public-key parameters: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: &419 + schema: &426 title: CodespacesPublicKey description: The public key used for setting Codespaces secrets. type: object @@ -27659,7 +28987,7 @@ paths: - key_id - key examples: - default: &420 + default: &427 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -27682,16 +29010,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#get-an-organization-secret parameters: - - *138 - - *166 + - *150 + - *178 responses: '200': description: Response content: application/json: - schema: *189 + schema: *201 examples: - default: &422 + default: &429 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -27718,8 +29046,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: - - *138 - - *166 + - *150 + - *178 requestBody: required: true content: @@ -27774,7 +29102,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -27800,8 +29128,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organization-secrets#delete-an-organization-secret parameters: - - *138 - - *166 + - *150 + - *178 responses: '204': description: Response @@ -27826,8 +29154,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: - - *138 - - *166 + - *150 + - *178 - *18 - *17 responses: @@ -27845,9 +29173,9 @@ paths: type: integer repositories: type: array - items: *156 + items: *168 examples: - default: *170 + default: *182 '404': *6 x-github: githubCloudOnly: false @@ -27869,8 +29197,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: - - *138 - - *166 + - *150 + - *178 requestBody: required: true content: @@ -27920,8 +29248,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: - - *138 - - *166 + - *150 + - *178 - name: repository_id in: path required: true @@ -27954,8 +29282,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: - - *138 - - *166 + - *150 + - *178 - name: repository_id in: path required: true @@ -27994,7 +29322,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: - - *138 + - *150 responses: '200': description: OK @@ -28137,7 +29465,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: - - *138 + - *150 - *18 - name: per_page description: The number of results per page (max 100). For more information, @@ -28160,9 +29488,9 @@ paths: currently being billed. seats: type: array - items: *190 + items: *202 examples: - default: *191 + default: *203 headers: Link: *37 '500': *80 @@ -28198,7 +29526,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: - - *138 + - *150 requestBody: content: application/json: @@ -28276,7 +29604,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: - - *138 + - *150 requestBody: content: application/json: @@ -28356,7 +29684,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: - - *138 + - *150 requestBody: content: application/json: @@ -28433,7 +29761,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: - - *138 + - *150 requestBody: content: application/json: @@ -28514,7 +29842,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-an-organization parameters: - - *138 + - *150 - 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`). @@ -28546,13 +29874,13 @@ paths: application/json: schema: type: array - items: *98 + items: *110 examples: - default: *99 + default: *111 '500': *80 '403': *27 '404': *6 - '422': *100 + '422': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -28583,7 +29911,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: - - *138 + - *150 - 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`). @@ -28615,9 +29943,9 @@ paths: application/json: schema: type: array - items: *101 + items: *113 examples: - default: *192 + default: *204 '500': *80 '401': *23 '403': *27 @@ -28643,7 +29971,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: - - *138 + - *150 - *17 - name: page description: Page token @@ -28802,7 +30130,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: - - *138 + - *150 - name: credential_id in: path required: true @@ -28833,7 +30161,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: - - *138 + - *150 responses: '200': description: Response - list of custom role names @@ -28849,7 +30177,7 @@ paths: - 3 custom_roles: type: array - items: *193 + items: *205 examples: default: value: @@ -28936,12 +30264,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#create-a-custom-repository-role parameters: - - *138 + - *150 requestBody: required: true content: application/json: - schema: &196 + schema: &208 type: object properties: name: @@ -28983,9 +30311,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *205 examples: - default: *194 + default: *206 '422': *15 '404': *6 x-github: @@ -29009,8 +30337,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#get-a-custom-repository-role parameters: - - *138 - - &195 + - *150 + - &207 name: role_id description: The unique identifier of the role. in: path @@ -29022,9 +30350,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *205 examples: - default: *194 + default: *206 '404': *6 x-github: githubCloudOnly: true @@ -29046,13 +30374,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#update-a-custom-repository-role parameters: - - *138 - - *195 + - *150 + - *207 requestBody: required: true content: application/json: - schema: &197 + schema: &209 type: object properties: name: @@ -29091,9 +30419,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *205 examples: - default: *194 + default: *206 '422': *15 '404': *6 x-github: @@ -29117,8 +30445,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-roles#delete-a-custom-repository-role parameters: - - *138 - - *195 + - *150 + - *207 responses: '204': description: Response @@ -29146,12 +30474,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: - - *138 + - *150 requestBody: required: true content: application/json: - schema: *196 + schema: *208 examples: default: value: @@ -29165,9 +30493,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *205 examples: - default: *194 + default: *206 '422': *15 '404': *6 x-github: @@ -29197,16 +30525,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: - - *138 - - *195 + - *150 + - *207 responses: '200': description: Response content: application/json: - schema: *193 + schema: *205 examples: - default: *194 + default: *206 '404': *6 x-github: githubCloudOnly: true @@ -29234,13 +30562,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: - - *138 - - *195 + - *150 + - *207 requestBody: required: true content: application/json: - schema: *197 + schema: *209 examples: default: value: @@ -29255,9 +30583,9 @@ paths: description: Response content: application/json: - schema: *193 + schema: *205 examples: - default: *194 + default: *206 '422': *15 '404': *6 x-github: @@ -29287,8 +30615,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: - - *138 - - *195 + - *150 + - *207 responses: '204': description: Response @@ -29316,18 +30644,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-an-organization parameters: - - *138 - - *198 - - *199 - - *200 - - *201 - - *202 - - *203 + - *150 + - *210 + - *211 + - *212 + - *213 + - *214 + - *215 - *76 - *74 - *75 - - *204 - - *205 + - *216 + - *217 - *17 responses: '200': @@ -29336,9 +30664,9 @@ paths: application/json: schema: type: array - items: *206 + items: *218 examples: - default: *207 + default: *219 '304': *35 '400': *14 '403': *27 @@ -29364,7 +30692,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-organization-secrets parameters: - - *138 + - *150 - *17 - *18 responses: @@ -29382,7 +30710,7 @@ paths: type: integer secrets: type: array - items: &208 + items: &220 title: Dependabot Secret for an Organization description: Secrets for GitHub Dependabot for an organization. type: object @@ -29455,13 +30783,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-public-key parameters: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: &445 + schema: &452 title: DependabotPublicKey description: The public key used for setting Dependabot Secrets. type: object @@ -29480,7 +30808,7 @@ paths: - key_id - key examples: - default: &446 + default: &453 value: key_id: '012345678912345678' key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 @@ -29503,14 +30831,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-an-organization-secret parameters: - - *138 - - *166 + - *150 + - *178 responses: '200': description: Response content: application/json: - schema: *208 + schema: *220 examples: default: value: @@ -29538,8 +30866,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-an-organization-secret parameters: - - *138 - - *166 + - *150 + - *178 requestBody: required: true content: @@ -29594,7 +30922,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -29618,8 +30946,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-an-organization-secret parameters: - - *138 - - *166 + - *150 + - *178 responses: '204': description: Response @@ -29643,8 +30971,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: - - *138 - - *166 + - *150 + - *178 - *18 - *17 responses: @@ -29662,9 +30990,9 @@ paths: type: integer repositories: type: array - items: *156 + items: *168 examples: - default: *170 + default: *182 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -29685,8 +31013,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: - - *138 - - *166 + - *150 + - *178 requestBody: required: true content: @@ -29736,8 +31064,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: - - *138 - - *166 + - *150 + - *178 - name: repository_id in: path required: true @@ -29768,8 +31096,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: - - *138 - - *166 + - *150 + - *178 - name: repository_id in: path required: true @@ -29799,7 +31127,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: - - *138 + - *150 responses: '200': description: Response @@ -29807,7 +31135,7 @@ paths: application/json: schema: type: array - items: &249 + items: &261 title: Package description: A software package type: object @@ -29860,7 +31188,7 @@ paths: repository: anyOf: - type: 'null' - - *156 + - *168 created_at: type: string format: date-time @@ -29878,7 +31206,7 @@ paths: - created_at - updated_at examples: - default: &250 + default: &262 value: - id: 197 name: hello_docker @@ -29956,7 +31284,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-organization-events parameters: - - *138 + - *150 - *17 - *18 responses: @@ -29966,7 +31294,7 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: 200-response: value: @@ -30036,7 +31364,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/external-groups#get-an-external-group parameters: - - *138 + - *150 - name: group_id description: The unique identifier of the group. in: path @@ -30062,7 +31390,7 @@ paths: description: Response content: application/json: - schema: &307 + schema: &314 title: ExternalGroup description: Information about an external group's usage and its members type: object @@ -30152,7 +31480,7 @@ paths: member_name: Octo Lisa member_email: octo_lisa@github.com examples: - default: &308 + default: &315 value: group_id: '123' group_name: Octocat admins @@ -30190,7 +31518,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: - - *138 + - *150 - *17 - name: page description: Page token @@ -30207,7 +31535,7 @@ paths: description: Response content: application/json: - schema: &305 + schema: &312 title: ExternalGroups description: A list of external groups available to be connected to a team @@ -30247,7 +31575,7 @@ paths: group_name: group-azuread-test2 updated_at: 2021-06-03 22:27:15:000 -700 examples: - default: &306 + default: &313 value: groups: - group_id: '123' @@ -30281,7 +31609,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-failed-organization-invitations parameters: - - *138 + - *150 - *17 - *18 responses: @@ -30291,7 +31619,7 @@ paths: application/json: schema: type: array - items: &231 + items: &243 title: Organization Invitation description: Organization Invitation type: object @@ -30345,7 +31673,7 @@ paths: - invitation_teams_url - node_id examples: - default: &232 + default: &244 value: - id: 1 login: monalisa @@ -30404,7 +31732,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: - - *138 + - *150 responses: '200': description: Response @@ -30412,7 +31740,7 @@ paths: application/json: schema: type: array - items: &265 + items: &278 title: Repository Fine-Grained Permission description: A fine-grained permission that protects repository resources. @@ -30426,7 +31754,7 @@ paths: - name - description examples: - default: &266 + default: &279 value: - name: add_assignee description: Assign or remove a user @@ -30457,7 +31785,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-organization-webhooks parameters: - - *138 + - *150 - *17 - *18 responses: @@ -30467,7 +31795,7 @@ paths: application/json: schema: type: array - items: &209 + items: &221 title: Org Hook description: Org Hook type: object @@ -30588,7 +31916,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#create-an-organization-webhook parameters: - - *138 + - *150 requestBody: required: true content: @@ -30650,9 +31978,9 @@ paths: description: Response content: application/json: - schema: *209 + schema: *221 examples: - default: &210 + default: &222 value: id: 1 url: https://api.github.com/orgs/octocat/hooks/1 @@ -30696,8 +32024,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#get-an-organization-webhook parameters: - - *138 - - &211 + - *150 + - &223 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. @@ -30710,9 +32038,9 @@ paths: description: Response content: application/json: - schema: *209 + schema: *221 examples: - default: *210 + default: *222 '404': *6 x-github: githubCloudOnly: false @@ -30733,8 +32061,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#update-an-organization-webhook parameters: - - *138 - - *211 + - *150 + - *223 requestBody: required: false content: @@ -30780,7 +32108,7 @@ paths: description: Response content: application/json: - schema: *209 + schema: *221 examples: default: value: @@ -30819,8 +32147,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#delete-an-organization-webhook parameters: - - *138 - - *211 + - *150 + - *223 responses: '204': description: Response @@ -30845,8 +32173,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: - - *138 - - *211 + - *150 + - *223 responses: '200': description: Response @@ -30874,8 +32202,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: - - *138 - - *211 + - *150 + - *223 requestBody: required: false content: @@ -30923,10 +32251,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#list-deliveries-for-an-organization-webhook parameters: - - *138 - - *211 + - *150 + - *223 - *17 - - *212 + - *224 responses: '200': description: Response @@ -30934,9 +32262,9 @@ paths: application/json: schema: type: array - items: *213 + items: *225 examples: - default: *214 + default: *226 '400': *14 '422': *15 x-github: @@ -30959,17 +32287,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: - - *138 - - *211 + - *150 + - *223 - *16 responses: '200': description: Response content: application/json: - schema: *215 + schema: *227 examples: - default: *216 + default: *228 '400': *14 '422': *15 x-github: @@ -30992,11 +32320,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: - - *138 - - *211 + - *150 + - *223 - *16 responses: - '202': *144 + '202': *156 '400': *14 '422': *15 x-github: @@ -31019,8 +32347,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/webhooks#ping-an-organization-webhook parameters: - - *138 - - *211 + - *150 + - *223 responses: '204': description: Response @@ -31042,8 +32370,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-route-stats-by-actor parameters: - - *138 - - &221 + - *150 + - &233 name: actor_type in: path description: The type of the actor @@ -31056,14 +32384,14 @@ paths: - fine_grained_pat - oauth_app - github_app_user_to_server - - &222 + - &234 name: actor_id in: path description: The ID of the actor required: true schema: type: integer - - &217 + - &229 name: min_timestamp description: 'The minimum timestamp to query for stats. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' @@ -31071,7 +32399,7 @@ paths: required: true schema: type: string - - &218 + - &230 name: max_timestamp description: 'The maximum timestamp to query for stats. Defaults to the time 30 days ago. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) @@ -31165,13 +32493,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-subject-stats parameters: - - *138 - - *217 - - *218 + - *150 + - *229 + - *230 - *18 - *17 - *76 - - &227 + - &239 name: sort description: The property to sort the results by. in: query @@ -31250,15 +32578,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats parameters: - - *138 - - *217 - - *218 + - *150 + - *229 + - *230 responses: '200': description: Response content: application/json: - schema: &219 + schema: &231 title: Summary Stats description: API Insights usage summary stats for an organization type: object @@ -31274,7 +32602,7 @@ paths: type: integer format: int64 examples: - default: &220 + default: &232 value: total_request_count: 34225 rate_limited_request_count: 23 @@ -31294,24 +32622,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-user parameters: - - *138 - - &223 + - *150 + - &235 name: user_id in: path description: The ID of the user to query for stats required: true schema: type: string - - *217 - - *218 + - *229 + - *230 responses: '200': description: Response content: application/json: - schema: *219 + schema: *231 examples: - default: *220 + default: *232 x-github: enabledForGitHubApps: true category: orgs @@ -31329,19 +32657,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-summary-stats-by-actor parameters: - - *138 - - *217 - - *218 - - *221 - - *222 + - *150 + - *229 + - *230 + - *233 + - *234 responses: '200': description: Response content: application/json: - schema: *219 + schema: *231 examples: - default: *220 + default: *232 x-github: enabledForGitHubApps: true category: orgs @@ -31358,10 +32686,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats parameters: - - *138 - - *217 - - *218 - - &224 + - *150 + - *229 + - *230 + - &236 name: timestamp_increment description: The increment of time used to breakdown the query results (5m, 10m, 1h, etc.) @@ -31374,7 +32702,7 @@ paths: description: Response content: application/json: - schema: &225 + schema: &237 title: Time Stats description: API Insights usage time stats for an organization type: array @@ -31390,7 +32718,7 @@ paths: type: integer format: int64 examples: - default: &226 + default: &238 value: - timestamp: '2024-09-11T15:00:00Z' total_request_count: 34225 @@ -31426,19 +32754,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-user parameters: - - *138 - - *223 - - *217 - - *218 - - *224 + - *150 + - *235 + - *229 + - *230 + - *236 responses: '200': description: Response content: application/json: - schema: *225 + schema: *237 examples: - default: *226 + default: *238 x-github: enabledForGitHubApps: true category: orgs @@ -31455,20 +32783,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-time-stats-by-actor parameters: - - *138 - - *221 - - *222 - - *217 - - *218 - - *224 + - *150 + - *233 + - *234 + - *229 + - *230 + - *236 responses: '200': description: Response content: application/json: - schema: *225 + schema: *237 examples: - default: *226 + default: *238 x-github: enabledForGitHubApps: true category: orgs @@ -31485,14 +32813,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/api-insights#get-user-stats parameters: - - *138 - - *223 - - *217 - - *218 + - *150 + - *235 + - *229 + - *230 - *18 - *17 - *76 - - *227 + - *239 - name: actor_name_substring in: query description: Providing a substring will filter results where the actor name @@ -31568,7 +32896,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: - - *138 + - *150 responses: '200': description: Response @@ -31576,7 +32904,7 @@ paths: application/json: schema: *20 examples: - default: &484 + default: &491 value: id: 1 account: @@ -31645,7 +32973,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-app-installations-for-an-organization parameters: - - *138 + - *150 - *17 - *18 responses: @@ -31734,7 +33062,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#get-interaction-restrictions-for-an-organization parameters: - - *138 + - *150 responses: '200': description: Response @@ -31742,12 +33070,12 @@ paths: application/json: schema: anyOf: - - &229 + - &241 title: Interaction Limits description: Interaction limit settings. type: object properties: - limit: &228 + limit: &240 type: string description: The type of GitHub user that can comment, open issues, or create pull requests while the interaction limit @@ -31775,7 +33103,7 @@ paths: properties: {} additionalProperties: false examples: - default: &230 + default: &242 value: limit: collaborators_only origin: organization @@ -31799,18 +33127,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#set-interaction-restrictions-for-an-organization parameters: - - *138 + - *150 requestBody: required: true content: application/json: - schema: &485 + schema: &492 title: Interaction Restrictions description: Limit interactions to a specific type of user for a specified duration type: object properties: - limit: *228 + limit: *240 expiry: type: string description: 'The duration of the interaction restriction. Default: @@ -31835,9 +33163,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *241 examples: - default: *230 + default: *242 '422': *15 x-github: githubCloudOnly: false @@ -31855,7 +33183,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/orgs#remove-interaction-restrictions-for-an-organization parameters: - - *138 + - *150 responses: '204': description: Response @@ -31881,7 +33209,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-pending-organization-invitations parameters: - - *138 + - *150 - *17 - *18 - name: role @@ -31915,9 +33243,9 @@ paths: application/json: schema: type: array - items: *231 + items: *243 examples: - default: *232 + default: *244 headers: Link: *37 '404': *6 @@ -31941,7 +33269,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#create-an-organization-invitation parameters: - - *138 + - *150 requestBody: required: false content: @@ -31995,7 +33323,7 @@ paths: description: Response content: application/json: - schema: *231 + schema: *243 examples: default: value: @@ -32051,8 +33379,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#cancel-an-organization-invitation parameters: - - *138 - - &233 + - *150 + - &245 name: invitation_id description: The unique identifier of the invitation. in: path @@ -32085,8 +33413,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-invitation-teams parameters: - - *138 - - *233 + - *150 + - *245 - *17 - *18 responses: @@ -32096,9 +33424,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - default: &248 + default: &260 value: - id: 1 node_id: MDQ6VGVhbTE= @@ -32143,7 +33471,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: - - *138 + - *150 - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means @@ -32173,7 +33501,7 @@ paths: - closed - all default: open - - *235 + - *247 - name: sort description: What to sort results by. in: query @@ -32186,7 +33514,7 @@ paths: - comments default: created - *76 - - *106 + - *118 - *17 - *18 responses: @@ -32196,9 +33524,9 @@ paths: application/json: schema: type: array - items: *116 + items: *128 examples: - default: *236 + default: *248 headers: Link: *37 '404': *6 @@ -32220,7 +33548,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-organization-members parameters: - - *138 + - *150 - 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) @@ -32256,7 +33584,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 '422': *15 @@ -32276,8 +33604,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#check-organization-membership-for-a-user parameters: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response if requester is an organization member and user is @@ -32308,8 +33636,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-an-organization-member parameters: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response @@ -32335,8 +33663,8 @@ paths: parameters: - *17 - *18 - - *138 - - *178 + - *150 + - *190 responses: '200': description: Response @@ -32352,9 +33680,9 @@ paths: type: integer codespaces: type: array - items: *238 + items: *250 examples: - default: *239 + default: *251 '304': *35 '500': *80 '401': *23 @@ -32379,9 +33707,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/organizations#delete-a-codespace-from-the-organization parameters: - - *138 - - *178 - - &240 + - *150 + - *190 + - &252 name: codespace_name in: path required: true @@ -32389,7 +33717,7 @@ paths: schema: type: string responses: - '202': *144 + '202': *156 '304': *35 '500': *80 '401': *23 @@ -32414,17 +33742,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: - - *138 - - *178 - - *240 + - *150 + - *190 + - *252 responses: '200': description: Response content: application/json: - schema: *238 + schema: *250 examples: - default: &416 + default: &423 value: id: 1 name: monalisa-octocat-hello-world-g4wpq6h95q @@ -32597,14 +33925,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: - - *138 - - *178 + - *150 + - *190 responses: '200': description: The user's GitHub Copilot seat details, including usage. content: application/json: - schema: *190 + schema: *202 examples: default: value: @@ -32672,14 +34000,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#get-organization-membership-for-a-user parameters: - - *138 - - *178 + - *150 + - *190 responses: '200': description: Response content: application/json: - schema: &241 + schema: &253 title: Org Membership description: Org Membership type: object @@ -32732,7 +34060,7 @@ paths: - organization - user examples: - response-if-user-has-an-active-admin-membership-with-organization: &242 + response-if-user-has-an-active-admin-membership-with-organization: &254 summary: Response if user has an active admin membership with organization value: url: https://api.github.com/orgs/octocat/memberships/defunkt @@ -32800,8 +34128,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#set-organization-membership-for-a-user parameters: - - *138 - - *178 + - *150 + - *190 requestBody: required: false content: @@ -32829,9 +34157,9 @@ paths: description: Response content: application/json: - schema: *241 + schema: *253 examples: - response-if-user-already-had-membership-with-organization: *242 + response-if-user-already-had-membership-with-organization: *254 '422': *15 '403': *27 x-github: @@ -32852,8 +34180,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#remove-organization-membership-for-a-user parameters: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response @@ -32878,7 +34206,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-organization-migrations parameters: - - *138 + - *150 - *17 - *18 - name: exclude @@ -32900,7 +34228,7 @@ paths: application/json: schema: type: array - items: &243 + items: &255 title: Migration description: A migration. type: object @@ -33157,7 +34485,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#start-an-organization-migration parameters: - - *138 + - *150 requestBody: required: true content: @@ -33238,7 +34566,7 @@ paths: description: Response content: application/json: - schema: *243 + schema: *255 examples: default: value: @@ -33416,8 +34744,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#get-an-organization-migration-status parameters: - - *138 - - &244 + - *150 + - &256 name: migration_id description: The unique identifier of the migration. in: path @@ -33445,7 +34773,7 @@ paths: * `failed`, which means the migration failed. content: application/json: - schema: *243 + schema: *255 examples: default: value: @@ -33614,8 +34942,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#download-an-organization-migration-archive parameters: - - *138 - - *244 + - *150 + - *256 responses: '302': description: Response @@ -33636,8 +34964,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#delete-an-organization-migration-archive parameters: - - *138 - - *244 + - *150 + - *256 responses: '204': description: Response @@ -33660,9 +34988,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#unlock-an-organization-repository parameters: - - *138 - - *244 - - &652 + - *150 + - *256 + - &659 name: repo_name description: repo_name parameter in: path @@ -33689,8 +35017,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/orgs#list-repositories-in-an-organization-migration parameters: - - *138 - - *244 + - *150 + - *256 - *17 - *18 responses: @@ -33700,9 +35028,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: &255 + default: &267 value: - id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -33841,7 +35169,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: - - *138 + - *150 responses: '200': description: Response @@ -33895,7 +35223,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: - - *138 + - *150 responses: '200': description: Response - list of organization roles @@ -33911,7 +35239,7 @@ paths: roles: type: array description: The list of organization roles available to the organization. - items: &245 + items: &257 title: Organization Role description: Organization roles type: object @@ -34073,7 +35401,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#create-a-custom-organization-role parameters: - - *138 + - *150 requestBody: required: true content: @@ -34120,7 +35448,7 @@ paths: description: Response content: application/json: - schema: *245 + schema: *257 examples: default: value: @@ -34149,7 +35477,7 @@ paths: updated_at: '2022-07-04T22:19:11Z' '422': *15 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -34171,8 +35499,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: - - *138 - - *246 + - *150 + - *258 responses: '204': description: Response @@ -34197,9 +35525,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: - - *138 - - *246 - - *195 + - *150 + - *258 + - *207 responses: '204': description: Response @@ -34228,9 +35556,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: - - *138 - - *246 - - *195 + - *150 + - *258 + - *207 responses: '204': description: Response @@ -34255,8 +35583,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: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response @@ -34281,9 +35609,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: - - *138 - - *178 - - *195 + - *150 + - *190 + - *207 responses: '204': description: Response @@ -34313,9 +35641,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: - - *138 - - *178 - - *195 + - *150 + - *190 + - *207 responses: '204': description: Response @@ -34343,14 +35671,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#get-an-organization-role parameters: - - *138 - - *195 + - *150 + - *207 responses: '200': description: Response content: application/json: - schema: *245 + schema: *257 examples: default: value: @@ -34407,8 +35735,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#update-a-custom-organization-role parameters: - - *138 - - *195 + - *150 + - *207 requestBody: required: true content: @@ -34447,7 +35775,7 @@ paths: description: Response content: application/json: - schema: *245 + schema: *257 examples: default: value: @@ -34475,7 +35803,7 @@ paths: created_at: '2022-07-04T22:19:11Z' updated_at: '2022-07-04T22:19:11Z' '422': *15 - '409': *143 + '409': *155 '404': *6 x-github: githubCloudOnly: true @@ -34500,8 +35828,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/organization-roles#delete-a-custom-organization-role parameters: - - *138 - - *195 + - *150 + - *207 responses: '204': description: Response @@ -34526,8 +35854,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: - - *138 - - *195 + - *150 + - *207 - *17 - *18 responses: @@ -34606,7 +35934,7 @@ paths: parent: anyOf: - type: 'null' - - *247 + - *259 required: - id - node_id @@ -34620,7 +35948,7 @@ paths: - slug - parent examples: - default: *248 + default: *260 headers: Link: *37 '404': @@ -34649,8 +35977,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: - - *138 - - *195 + - *150 + - *207 - *17 - *18 responses: @@ -34679,7 +36007,7 @@ paths: inherited_from: description: Team the user has gotten the role through type: array - items: *247 + items: *259 name: type: - string @@ -34796,7 +36124,7 @@ paths: - type - url examples: - default: *237 + default: *249 headers: Link: *37 '404': @@ -34820,7 +36148,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: - - *138 + - *150 - 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) @@ -34844,7 +36172,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 x-github: @@ -34869,8 +36197,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: - - *138 - - *178 + - *150 + - *190 requestBody: required: false content: @@ -34927,8 +36255,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: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response @@ -34985,8 +36313,8 @@ paths: - docker - nuget - container - - *138 - - &654 + - *150 + - &661 name: visibility description: |- The selected visibility of the packages. This parameter is optional and only filters an existing result set. @@ -35022,12 +36350,12 @@ paths: application/json: schema: type: array - items: *249 + items: *261 examples: - default: *250 + default: *262 '403': *27 '401': *23 - '400': &656 + '400': &663 description: The value of `per_page` multiplied by `page` cannot be greater than 10000. x-github: @@ -35049,7 +36377,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-an-organization parameters: - - &251 + - &263 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 @@ -35067,20 +36395,20 @@ paths: - docker - nuget - container - - &252 + - &264 name: package_name description: The name of the package. in: path required: true schema: type: string - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: *249 + schema: *261 examples: default: value: @@ -35132,9 +36460,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-an-organization parameters: - - *251 - - *252 - - *138 + - *263 + - *264 + - *150 responses: '204': description: Response @@ -35166,9 +36494,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-an-organization parameters: - - *251 - - *252 - - *138 + - *263 + - *264 + - *150 - name: token description: package token schema: @@ -35200,9 +36528,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: - - *251 - - *252 - - *138 + - *263 + - *264 + - *150 - *18 - *17 - name: state @@ -35222,7 +36550,7 @@ paths: application/json: schema: type: array - items: &253 + items: &265 title: Package Version description: A version of a software package type: object @@ -35357,10 +36685,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: - - *251 - - *252 - - *138 - - &254 + - *263 + - *264 + - *150 + - &266 name: package_version_id description: Unique identifier of the package version. in: path @@ -35372,7 +36700,7 @@ paths: description: Response content: application/json: - schema: *253 + schema: *265 examples: default: value: @@ -35408,10 +36736,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-an-organization parameters: - - *251 - - *252 - - *138 - - *254 + - *263 + - *264 + - *150 + - *266 responses: '204': description: Response @@ -35443,10 +36771,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-an-organization parameters: - - *251 - - *252 - - *138 - - *254 + - *263 + - *264 + - *150 + - *266 responses: '204': description: Response @@ -35473,10 +36801,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: - - *138 + - *150 - *17 - *18 - - &256 + - &268 name: sort description: The property by which to sort the results. in: query @@ -35487,7 +36815,7 @@ paths: - created_at default: created_at - *76 - - &257 + - &269 name: owner description: A list of owner usernames to use to filter the results. in: query @@ -35499,7 +36827,7 @@ paths: type: string examples: - owner[]=octocat1,owner[]=octocat2 - - &258 + - &270 name: repository description: The name of the repository to use to filter the results. in: query @@ -35508,7 +36836,7 @@ paths: type: string examples: - Hello-World - - &259 + - &271 name: permission description: The permission to use to filter the results. in: query @@ -35517,7 +36845,7 @@ paths: type: string examples: - issues_read - - &260 + - &272 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) @@ -35527,7 +36855,7 @@ paths: schema: type: string format: date-time - - &261 + - &273 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) @@ -35693,7 +37021,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: - - *138 + - *150 requestBody: required: true content: @@ -35739,7 +37067,7 @@ paths: '422': *15 '404': *6 '403': *27 - '202': *144 + '202': *156 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35760,7 +37088,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: - - *138 + - *150 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -35801,7 +37129,7 @@ paths: '422': *15 '404': *6 '403': *27 - '204': *185 + '204': *197 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -35822,7 +37150,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: - - *138 + - *150 - name: pat_request_id in: path description: Unique identifier of the request for access via fine-grained @@ -35842,9 +37170,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 x-github: @@ -35867,16 +37195,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: - - *138 + - *150 - *17 - *18 - - *256 + - *268 - *76 - - *257 - - *258 - - *259 - - *260 - - *261 + - *269 + - *270 + - *271 + - *272 + - *273 responses: '500': *80 '422': *15 @@ -36027,7 +37355,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: - - *138 + - *150 requestBody: required: true content: @@ -36064,7 +37392,7 @@ paths: responses: '500': *80 '404': *6 - '202': *144 + '202': *156 '403': *27 '422': *15 x-github: @@ -36087,7 +37415,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: - - *138 + - *150 - name: pat_id description: The unique identifier of the fine-grained personal access token. in: path @@ -36117,7 +37445,7 @@ paths: responses: '500': *80 '404': *6 - '204': *185 + '204': *197 '403': *27 '422': *15 x-github: @@ -36139,7 +37467,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: - - *138 + - *150 - name: pat_id in: path description: Unique identifier of the fine-grained personal access token. @@ -36158,9 +37486,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 x-github: @@ -36182,7 +37510,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-organization-projects parameters: - - *138 + - *150 - name: state description: Indicates the state of the projects to return. in: query @@ -36203,7 +37531,7 @@ paths: application/json: schema: type: array - items: &262 + items: &274 title: Project description: Projects are a way to organize columns and cards of work. @@ -36356,7 +37684,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-an-organization-project parameters: - - *138 + - *150 requestBody: required: true content: @@ -36382,7 +37710,7 @@ paths: description: Response content: application/json: - schema: *262 + schema: *274 examples: default: value: @@ -36420,7 +37748,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': &323 + '410': &330 description: Gone content: application/json: @@ -36444,7 +37772,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: - - *138 + - *150 responses: '200': description: Response @@ -36477,7 +37805,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: - - *138 + - *150 requestBody: required: true content: @@ -36541,7 +37869,7 @@ 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: - - *138 + - *150 - *94 responses: '200': @@ -36573,57 +37901,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/custom-properties#create-or-update-a-custom-property-for-an-organization parameters: - - *138 + - *150 - *94 requestBody: required: true content: application/json: - schema: - type: object - properties: - value_type: - type: string - enum: - - string - - single_select - - multi_select - - true_false - description: The type of the value for the property - examples: - - single_select - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - description: Default value of the property - type: - - 'null' - - string - - array - description: - type: - - string - - 'null' - description: Short description of the property - allowed_values: - type: - - array - - 'null' - items: - type: string - maxLength: 75 - maxItems: 200 - description: |- - An ordered list of the allowed values of the property. - The property can have up to 200 allowed values. - required: - - value_type + schema: *275 examples: default: value: @@ -36664,10 +37948,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: - - *138 + - *150 - *94 responses: - '204': *185 + '204': *197 '403': *27 '404': *6 x-github: @@ -36688,7 +37972,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: - - *138 + - *150 - *17 - *18 - name: repository_query @@ -36729,7 +38013,7 @@ paths: - octocat/Hello-World properties: type: array - items: &263 + items: &276 title: Custom Property Value description: Custom property name and associated value type: object @@ -36799,7 +38083,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: - - *138 + - *150 requestBody: required: true content: @@ -36819,7 +38103,7 @@ paths: type: array description: List of custom property names and associated values to apply to the repositories. - items: *263 + items: *276 required: - repository_names - properties @@ -36860,7 +38144,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/members#list-public-organization-members parameters: - - *138 + - *150 - *17 - *18 responses: @@ -36872,7 +38156,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 x-github: @@ -36891,8 +38175,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: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response if user is a public member @@ -36916,8 +38200,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: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response @@ -36938,8 +38222,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: - - *138 - - *178 + - *150 + - *190 responses: '204': description: Response @@ -36963,7 +38247,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-organization-repositories parameters: - - *138 + - *150 - 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 @@ -37010,9 +38294,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 x-github: @@ -37033,7 +38317,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-organization-repository parameters: - - *138 + - *150 requestBody: required: true content: @@ -37216,7 +38500,7 @@ paths: description: Response content: application/json: - schema: &325 + schema: &332 title: Full Repository description: Full Repository type: object @@ -37662,7 +38946,7 @@ paths: license: anyOf: - type: 'null' - - *117 + - *129 organization: anyOf: - type: 'null' @@ -37681,7 +38965,7 @@ paths: description: Whether anonymous git access is allowed. default: true type: boolean - code_of_conduct: &435 + code_of_conduct: &442 title: Code Of Conduct Simple description: Code of Conduct Simple type: object @@ -37711,7 +38995,7 @@ paths: - key - name - html_url - security_and_analysis: *264 + security_and_analysis: *277 custom_properties: type: object description: The custom properties that were defined for the repository. @@ -37795,7 +39079,7 @@ paths: - network_count - subscribers_count examples: - default: &327 + default: &334 value: id: 1296269 node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 @@ -38313,7 +39597,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: - - *138 + - *150 responses: '200': description: Response @@ -38321,9 +39605,9 @@ paths: application/json: schema: type: array - items: *265 + items: *278 examples: - default: *266 + default: *279 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -38345,10 +39629,10 @@ paths: category: orgs subcategory: rules parameters: - - *138 + - *150 - *17 - *18 - - &566 + - &573 name: targets description: | A comma-separated list of rule targets to filter by. @@ -38367,935 +39651,7 @@ paths: application/json: schema: type: array - items: &273 - title: Repository ruleset - type: object - description: A set of rules to apply when specified conditions are - met. - required: - - id - - name - - source - - enforcement - properties: - id: - type: integer - description: The ID of the ruleset - name: - type: string - description: The name of the ruleset - target: - type: string - description: The target of the ruleset - enum: - - branch - - tag - - push - source_type: - type: string - description: The type of the source of the ruleset - enum: - - Repository - - Organization - source: - type: string - description: The name of the source - enforcement: &269 - type: string - description: The enforcement level of the ruleset. `evaluate` - allows admins to test rules before enforcing them. Admins - can view insights on the Rule Insights page. - enum: - - disabled - - active - - evaluate - bypass_actors: - type: array - description: The actors that can bypass the rules in this ruleset - items: &270 - title: Repository Ruleset Bypass Actor - type: object - description: An actor that can bypass rules in a ruleset - required: - - actor_type - properties: - actor_id: - type: - - integer - - 'null' - description: The ID of the actor that can bypass a ruleset. - If `actor_type` is `OrganizationAdmin`, this should - be `1`. If `actor_type` is `DeployKey`, this should - be null. If `actor_type` is `EnterpriseOwner`, `actor_id` - is ignored. `OrganizationAdmin` and `EnterpriseOwner` - are not applicable for personal repositories. - actor_type: - type: string - enum: - - Integration - - OrganizationAdmin - - RepositoryRole - - Team - - DeployKey - - EnterpriseOwner - description: The type of actor that can bypass a ruleset - bypass_mode: - type: string - description: When the specified actor can bypass the ruleset. - `pull_request` means that an actor can only bypass rules - on pull requests. `pull_request` is not applicable for - the `DeployKey` actor type. Also, `pull_request` is - only applicable to branch rulesets. - enum: - - always - - pull_request - default: always - current_user_can_bypass: - type: string - description: |- - The bypass type of the user making the API request for this ruleset. This field is only returned when - querying the repository-level endpoint. - enum: - - always - - pull_requests_only - - never - node_id: - type: string - _links: - type: object - properties: - self: - type: object - properties: - href: - type: string - description: The URL of the ruleset - html: - type: - - object - - 'null' - properties: - href: - type: string - description: The html URL of the ruleset - conditions: - anyOf: - - &267 - title: Repository ruleset conditions for ref names - type: object - description: Parameters for a repository ruleset ref name - condition - properties: - ref_name: - type: object - properties: - include: - type: array - description: Array of ref names or patterns to include. - One of these patterns must match for the condition - to pass. Also accepts `~DEFAULT_BRANCH` to include - the default branch or `~ALL` to include all branches. - items: - type: string - exclude: - type: array - description: Array of ref names or patterns to exclude. - The condition will not pass if any of these patterns - match. - items: - type: string - - &271 - title: Organization ruleset conditions - type: object - description: |- - Conditions for an organization ruleset. - The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. - The push rulesets conditions object does not require the `ref_name` property. - oneOf: - - type: object - title: repository_name_and_ref_name - description: Conditions to target repositories by name and - refs by name - allOf: - - *267 - - title: Repository ruleset conditions for repository names - type: object - description: Parameters for a repository name condition - properties: - repository_name: - type: object - properties: - include: - type: array - description: Array of repository names or patterns - to include. One of these patterns must match - for the condition to pass. Also accepts `~ALL` - to include all repositories. - items: - type: string - exclude: - type: array - description: Array of repository names or patterns - to exclude. The condition will not pass if any - of these patterns match. - items: - type: string - protected: - type: boolean - description: Whether renaming of target repositories - is prevented. - required: - - repository_name - - type: object - title: repository_id_and_ref_name - description: Conditions to target repositories by id and - refs by name - allOf: - - *267 - - title: Repository ruleset conditions for repository IDs - type: object - description: Parameters for a repository ID condition - properties: - repository_id: - type: object - properties: - repository_ids: - type: array - description: The repository IDs that the ruleset - applies to. One of these IDs must match for - the condition to pass. - items: - type: integer - required: - - repository_id - - type: object - title: repository_property_and_ref_name - description: Conditions to target repositories by property - and refs by name - allOf: - - *267 - - title: Repository ruleset conditions for repository properties - type: object - description: Parameters for a repository property condition - properties: - repository_property: - type: object - properties: - include: - type: array - description: The repository properties and values - to include. All of these properties must match - for the condition to pass. - items: &268 - title: Repository ruleset property targeting - definition - type: object - description: Parameters for a targeting a repository - property - properties: - name: - type: string - description: The name of the repository - property to target - property_values: - type: array - description: The values to match for the - repository property - items: - type: string - source: - type: string - description: The source of the repository - property. Defaults to 'custom' if not - specified. - enum: - - custom - - system - required: - - name - - property_values - exclude: - type: array - description: The repository properties and values - to exclude. The condition will not pass if any - of these properties match. - items: *268 - required: - - repository_property - type: - - 'null' - - object - rules: - type: array - items: &272 - title: Repository Rule - type: object - description: A repository rule. - oneOf: - - &548 - title: creation - description: Only allow users with bypass permission to - create matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - creation - - &549 - title: update - description: Only allow users with bypass permission to - update matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - update - parameters: - type: object - properties: - update_allows_fetch_and_merge: - type: boolean - description: Branch can pull changes from its upstream - repository - required: - - update_allows_fetch_and_merge - - &551 - title: deletion - description: Only allow users with bypass permissions to - delete matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - deletion - - &552 - title: required_linear_history - description: Prevent merge commits from being pushed to - matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_linear_history - - &553 - title: merge_queue - description: Merges must be performed via a merge queue. - type: object - required: - - type - properties: - type: - type: string - enum: - - merge_queue - parameters: - type: object - properties: - check_response_timeout_minutes: - type: integer - description: Maximum time for a required status - check to report a conclusion. After this much - time has elapsed, checks that have not reported - a conclusion will be assumed to have failed - minimum: 1 - maximum: 360 - grouping_strategy: - type: string - description: When set to ALLGREEN, the merge commit - created by merge queue for each PR in the group - must pass all required checks to merge. When set - to HEADGREEN, only the commit at the head of the - merge group, i.e. the commit containing changes - from all of the PRs in the group, must pass its - required checks to merge. - enum: - - ALLGREEN - - HEADGREEN - max_entries_to_build: - type: integer - description: Limit the number of queued pull requests - requesting checks and workflow runs at the same - time. - minimum: 0 - maximum: 100 - max_entries_to_merge: - type: integer - description: The maximum number of PRs that will - be merged together in a group. - minimum: 0 - maximum: 100 - merge_method: - type: string - description: Method to use when merging changes - from queued pull requests. - enum: - - MERGE - - SQUASH - - REBASE - min_entries_to_merge: - type: integer - description: The minimum number of PRs that will - be merged together in a group. - minimum: 0 - maximum: 100 - min_entries_to_merge_wait_minutes: - type: integer - description: The time merge queue should wait after - the first PR is added to the queue for the minimum - group size to be met. After this time has elapsed, - the minimum group size will be ignored and a smaller - group will be merged. - minimum: 0 - maximum: 360 - required: - - check_response_timeout_minutes - - grouping_strategy - - max_entries_to_build - - max_entries_to_merge - - merge_method - - min_entries_to_merge - - min_entries_to_merge_wait_minutes - - &554 - title: required_deployments - description: Choose which environments must be successfully - deployed to before refs can be pushed into a ref that - matches this rule. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_deployments - parameters: - type: object - properties: - required_deployment_environments: - type: array - description: The environments that must be successfully - deployed to before branches can be merged. - items: - type: string - required: - - required_deployment_environments - - &555 - title: required_signatures - description: Commits pushed to matching refs must have verified - signatures. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_signatures - - &556 - title: pull_request - description: Require all commits be made to a non-target - branch and submitted via a pull request before they can - be merged. - type: object - required: - - type - properties: - type: - type: string - enum: - - pull_request - parameters: - type: object - properties: - dismiss_stale_reviews_on_push: - type: boolean - description: New, reviewable commits pushed will - dismiss previous pull request review approvals. - require_code_owner_review: - type: boolean - description: Require an approving review in pull - requests that modify files that have a designated - code owner. - require_last_push_approval: - type: boolean - description: Whether the most recent reviewable - push must be approved by someone other than the - person who pushed it. - required_approving_review_count: - type: integer - description: The number of approving reviews that - are required before a pull request can be merged. - minimum: 0 - maximum: 10 - required_review_thread_resolution: - type: boolean - description: All conversations on code must be resolved - before a pull request can be merged. - required: - - dismiss_stale_reviews_on_push - - require_code_owner_review - - require_last_push_approval - - required_approving_review_count - - required_review_thread_resolution - - &557 - title: required_status_checks - description: Choose which status checks must pass before - the ref is updated. When enabled, commits must first be - pushed to another ref where the checks pass. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_status_checks - parameters: - type: object - properties: - do_not_enforce_on_create: - type: boolean - description: Allow repositories and branches to - be created if a check would otherwise prohibit - it. - required_status_checks: - type: array - description: Status checks that are required. - items: - title: StatusCheckConfiguration - description: Required status check - type: object - properties: - context: - type: string - description: The status check context name - that must be present on the commit. - integration_id: - type: integer - description: The optional integration ID that - this status check must originate from. - required: - - context - strict_required_status_checks_policy: - type: boolean - description: Whether pull requests targeting a matching - branch must be tested with the latest code. This - setting will not take effect unless at least one - status check is enabled. - required: - - required_status_checks - - strict_required_status_checks_policy - - &558 - title: non_fast_forward - description: Prevent users with push access from force pushing - to refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - non_fast_forward - - &559 - title: commit_message_pattern - description: Parameters to be used for the commit_message_pattern - rule - type: object - required: - - type - properties: - type: - type: string - enum: - - commit_message_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the - pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - - &560 - title: commit_author_email_pattern - description: Parameters to be used for the commit_author_email_pattern - rule - type: object - required: - - type - properties: - type: - type: string - enum: - - commit_author_email_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the - pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - - &561 - title: committer_email_pattern - description: Parameters to be used for the committer_email_pattern - rule - type: object - required: - - type - properties: - type: - type: string - enum: - - committer_email_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the - pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - - &562 - title: branch_name_pattern - description: Parameters to be used for the branch_name_pattern - rule - type: object - required: - - type - properties: - type: - type: string - enum: - - branch_name_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the - pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - - &563 - title: tag_name_pattern - description: Parameters to be used for the tag_name_pattern - rule - type: object - required: - - type - properties: - type: - type: string - enum: - - tag_name_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the - pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - - title: file_path_restriction - description: Prevent commits that include changes in specified - file paths from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_path_restriction - parameters: - type: object - properties: - restricted_file_paths: - type: array - description: The file paths that are restricted - from being pushed to the commit graph. - items: - type: string - required: - - restricted_file_paths - - title: max_file_path_length - description: Prevent commits that include file paths that - exceed a specified character limit from being pushed to - the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_path_length - parameters: - type: object - properties: - max_file_path_length: - type: integer - description: The maximum amount of characters allowed - in file paths - minimum: 1 - maximum: 256 - required: - - max_file_path_length - - title: file_extension_restriction - description: Prevent commits that include files with specified - file extensions from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_extension_restriction - parameters: - type: object - properties: - restricted_file_extensions: - type: array - description: The file extensions that are restricted - from being pushed to the commit graph. - items: - type: string - required: - - restricted_file_extensions - - title: max_file_size - description: Prevent commits that exceed a specified file - size limit from being pushed to the commit. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_size - parameters: - type: object - properties: - max_file_size: - type: integer - description: The maximum file size allowed in megabytes. - This limit does not apply to Git Large File Storage - (Git LFS). - minimum: 1 - maximum: 100 - required: - - max_file_size - - &564 - title: workflows - description: Require all changes made to a targeted branch - to pass the specified workflows before they can be merged. - type: object - required: - - type - properties: - type: - type: string - enum: - - workflows - parameters: - type: object - properties: - do_not_enforce_on_create: - type: boolean - description: Allow repositories and branches to - be created if a check would otherwise prohibit - it. - workflows: - type: array - description: Workflows that must pass for this rule - to pass. - items: - title: WorkflowFileReference - description: A workflow that must run for this - rule to pass - type: object - properties: - path: - type: string - description: The path to the workflow file - ref: - type: string - description: The ref (branch or tag) of the - workflow file to use - repository_id: - type: integer - description: The ID of the repository where - the workflow is defined - sha: - type: string - description: The commit SHA of the workflow - file to use - required: - - path - - repository_id - required: - - workflows - - &565 - title: code_scanning - description: Choose which tools must provide code scanning - results before the reference is updated. When configured, - code scanning must be enabled and have results for both - the commit and the reference being updated. - type: object - required: - - type - properties: - type: - type: string - enum: - - code_scanning - parameters: - type: object - properties: - code_scanning_tools: - type: array - description: Tools that must provide code scanning - results for this rule to pass. - items: - title: CodeScanningTool - description: A tool that must provide code scanning - results for this rule to pass. - type: object - properties: - alerts_threshold: - type: string - description: The severity level at which code - scanning results that raise alerts block - a reference update. For more information - on alert severity levels, see "[About code - scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." - enum: - - none - - errors - - errors_and_warnings - - all - security_alerts_threshold: - type: string - description: The severity level at which code - scanning results that raise security alerts - block a reference update. For more information - on security severity levels, see "[About - code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." - enum: - - none - - critical - - high_or_higher - - medium_or_higher - - all - tool: - type: string - description: The name of a code scanning tool - required: - - alerts_threshold - - security_alerts_threshold - - tool - required: - - code_scanning_tools - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time + items: *105 examples: default: value: @@ -39342,7 +39698,7 @@ paths: category: orgs subcategory: rules parameters: - - *138 + - *150 requestBody: description: Request body required: true @@ -39361,17 +39717,18 @@ paths: - branch - tag - push + - repository default: branch - enforcement: *269 + enforcement: *102 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *270 - conditions: *271 + items: *103 + conditions: *280 rules: type: array description: An array of rules within the ruleset. - items: *272 + items: *104 required: - name - enforcement @@ -39409,9 +39766,9 @@ paths: description: Response content: application/json: - schema: *273 + schema: *105 examples: - default: &274 + default: &281 value: id: 21 name: super cool ruleset @@ -39465,8 +39822,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#list-organization-rule-suites parameters: - - *138 - - &567 + - *150 + - &574 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 @@ -39481,7 +39838,7 @@ paths: in: query schema: type: string - - &568 + - &575 name: time_period description: |- The time period to filter by. @@ -39497,14 +39854,14 @@ paths: - week - month default: day - - &569 + - &576 name: actor_name description: The handle for the GitHub user account to filter on. When specified, only rule evaluations triggered by this actor will be returned. in: query schema: type: string - - &570 + - &577 name: rule_suite_result description: The rule results to filter on. When specified, only suites with this result will be returned. @@ -39524,7 +39881,7 @@ paths: description: Response content: application/json: - schema: &571 + schema: &578 title: Rule Suites description: Response type: array @@ -39580,7 +39937,7 @@ paths: whether rules would pass or fail if all rules in the rule suite were `active`. examples: - default: &572 + default: &579 value: - id: 21 actor_id: 12 @@ -39623,8 +39980,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/rule-suites#get-an-organization-rule-suite parameters: - - *138 - - &573 + - *150 + - &580 name: rule_suite_id description: |- The unique identifier of the rule suite result. @@ -39640,7 +39997,7 @@ paths: description: Response content: application/json: - schema: &574 + schema: &581 title: Rule Suite description: Response type: object @@ -39747,7 +40104,7 @@ paths: description: The detailed failure message for the rule. Null if the rule passed. examples: - default: &575 + default: &582 value: id: 21 actor_id: 12 @@ -39808,7 +40165,7 @@ paths: category: orgs subcategory: rules parameters: - - *138 + - *150 - name: ruleset_id description: The ID of the ruleset. in: path @@ -39820,9 +40177,9 @@ paths: description: Response content: application/json: - schema: *273 + schema: *105 examples: - default: *274 + default: *281 '404': *6 '500': *80 put: @@ -39840,7 +40197,7 @@ paths: category: orgs subcategory: rules parameters: - - *138 + - *150 - name: ruleset_id description: The ID of the ruleset. in: path @@ -39865,16 +40222,17 @@ paths: - branch - tag - push - enforcement: *269 + - repository + enforcement: *102 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *270 - conditions: *271 + items: *103 + conditions: *280 rules: description: An array of rules within the ruleset. type: array - items: *272 + items: *104 examples: default: value: @@ -39909,9 +40267,9 @@ paths: description: Response content: application/json: - schema: *273 + schema: *105 examples: - default: *274 + default: *281 '404': *6 '500': *80 delete: @@ -39929,7 +40287,7 @@ paths: category: orgs subcategory: rules parameters: - - *138 + - *150 - name: ruleset_id description: The ID of the ruleset. in: path @@ -39957,15 +40315,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: - - *138 - - *275 - - *276 - - *277 - - *278 + - *150 + - *282 + - *283 + - *284 + - *285 - *76 - *18 - *17 - - &577 + - &584 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 @@ -39975,7 +40333,7 @@ paths: required: false schema: type: string - - &578 + - &585 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 @@ -39985,9 +40343,9 @@ paths: required: false schema: type: string - - *279 - - *280 - - *281 + - *286 + - *287 + - *288 responses: '200': description: Response @@ -39995,13 +40353,13 @@ paths: application/json: schema: type: array - items: *282 + items: *289 examples: - default: *283 + default: *290 headers: Link: *37 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40023,7 +40381,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: - - *138 + - *150 - *76 - name: sort description: The property to sort the results by. @@ -40067,7 +40425,7 @@ paths: application/json: schema: type: array - items: &585 + items: &592 description: A repository security advisory. type: object properties: @@ -40311,7 +40669,7 @@ paths: login: type: string description: The username of the user credited. - type: *284 + type: *291 credits_detailed: type: - array @@ -40322,7 +40680,7 @@ paths: type: object properties: user: *4 - type: *284 + type: *291 state: type: string description: The state of the user's acceptance of the @@ -40348,7 +40706,7 @@ paths: - array - 'null' description: A list of teams that collaborate on the advisory. - items: *234 + items: *246 private_fork: readOnly: true description: A temporary private fork of the advisory's repository @@ -40386,7 +40744,7 @@ paths: - private_fork additionalProperties: false examples: - default: &586 + default: &593 value: - ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -40768,7 +41126,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#list-security-manager-teams parameters: - - *138 + - *150 responses: '200': description: Response @@ -40776,9 +41134,9 @@ paths: application/json: schema: type: array - items: *247 + items: *259 examples: - default: *248 + default: *260 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -40801,8 +41159,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#add-a-security-manager-team parameters: - - *138 - - *246 + - *150 + - *258 responses: '204': description: Response @@ -40827,8 +41185,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/security-managers#remove-a-security-manager-team parameters: - - *138 - - *246 + - *150 + - *258 responses: '204': description: Response @@ -40854,15 +41212,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: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: *285 + schema: *292 examples: - default: *286 + default: *293 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -40886,7 +41244,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: - - *138 + - *150 - *17 - *18 responses: @@ -40894,9 +41252,9 @@ paths: description: Success content: application/json: - schema: *287 + schema: *294 examples: - default: *288 + default: *295 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -40918,15 +41276,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: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: *289 + schema: *296 examples: - default: *290 + default: *297 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -40948,15 +41306,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: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: *291 + schema: *298 examples: - default: *292 + default: *299 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -40973,7 +41331,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: - - *138 + - *150 - *17 - name: page description: Page token @@ -40992,7 +41350,7 @@ paths: description: Response content: application/json: - schema: &314 + schema: &321 title: GroupMapping description: External Groups to be mapped to a team for membership type: object @@ -41044,7 +41402,7 @@ paths: group_description: Another group of Developers working on AzureAD SAML SSO examples: - default: &315 + default: &322 value: groups: - group_id: '123' @@ -41089,8 +41447,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-metrics#get-copilot-metrics-for-a-team parameters: - - *138 - - *246 + - *150 + - *258 - 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`). @@ -41122,13 +41480,13 @@ paths: application/json: schema: type: array - items: *98 + items: *110 examples: - default: *99 + default: *111 '500': *80 '403': *27 '404': *6 - '422': *100 + '422': *112 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -41162,8 +41520,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/copilot/copilot-usage#get-a-summary-of-copilot-usage-for-a-team parameters: - - *138 - - *246 + - *150 + - *258 - 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`). @@ -41195,9 +41553,9 @@ paths: application/json: schema: type: array - items: *101 + items: *113 examples: - default: *192 + default: *204 '500': *80 '401': *23 '403': *27 @@ -41219,7 +41577,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-teams parameters: - - *138 + - *150 - *17 - *18 responses: @@ -41229,9 +41587,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - default: *248 + default: *260 headers: Link: *37 '403': *27 @@ -41253,7 +41611,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#create-a-team parameters: - - *138 + - *150 requestBody: required: true content: @@ -41325,7 +41683,7 @@ paths: description: Response content: application/json: - schema: &293 + schema: &300 title: Full Team description: Groups of organization members that gives permissions on specified repositories. @@ -41399,7 +41757,7 @@ paths: parent: anyOf: - type: 'null' - - *247 + - *259 members_count: type: integer examples: @@ -41705,7 +42063,7 @@ paths: - repos_count - organization examples: - default: &294 + default: &301 value: id: 1 node_id: MDQ6VGVhbTE= @@ -41775,16 +42133,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-by-name parameters: - - *138 - - *246 + - *150 + - *258 responses: '200': description: Response content: application/json: - schema: *293 + schema: *300 examples: - default: *294 + default: *301 '404': *6 x-github: githubCloudOnly: false @@ -41805,8 +42163,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team parameters: - - *138 - - *246 + - *150 + - *258 requestBody: required: false content: @@ -41869,16 +42227,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *293 + schema: *300 examples: - default: *294 + default: *301 '201': description: Response content: application/json: - schema: *293 + schema: *300 examples: - default: *294 + default: *301 '404': *6 '422': *15 '403': *27 @@ -41903,8 +42261,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team parameters: - - *138 - - *246 + - *150 + - *258 responses: '204': description: Response @@ -41930,8 +42288,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions parameters: - - *138 - - *246 + - *150 + - *258 - *76 - *17 - *18 @@ -41948,7 +42306,7 @@ paths: application/json: schema: type: array - items: &295 + items: &302 title: Team Discussion description: A team discussion is a persistent record of a free-form conversation within a team. @@ -42039,7 +42397,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2343027/discussions/1 - reactions: *104 + reactions: *116 required: - author - body @@ -42059,7 +42417,7 @@ paths: - updated_at - url examples: - default: &626 + default: &633 value: - author: login: octocat @@ -42133,8 +42491,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion parameters: - - *138 - - *246 + - *150 + - *258 requestBody: required: true content: @@ -42168,9 +42526,9 @@ paths: description: Response content: application/json: - schema: *295 + schema: *302 examples: - default: &296 + default: &303 value: author: login: octocat @@ -42242,9 +42600,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion parameters: - - *138 - - *246 - - &297 + - *150 + - *258 + - &304 name: discussion_number description: The number that identifies the discussion. in: path @@ -42256,9 +42614,9 @@ paths: description: Response content: application/json: - schema: *295 + schema: *302 examples: - default: *296 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42280,9 +42638,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion parameters: - - *138 - - *246 - - *297 + - *150 + - *258 + - *304 requestBody: required: false content: @@ -42305,9 +42663,9 @@ paths: description: Response content: application/json: - schema: *295 + schema: *302 examples: - default: &627 + default: &634 value: author: login: octocat @@ -42377,9 +42735,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion parameters: - - *138 - - *246 - - *297 + - *150 + - *258 + - *304 responses: '204': description: Response @@ -42405,9 +42763,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments parameters: - - *138 - - *246 - - *297 + - *150 + - *258 + - *304 - *76 - *17 - *18 @@ -42418,7 +42776,7 @@ paths: application/json: schema: type: array - items: &298 + items: &305 title: Team Discussion Comment description: A reply to a discussion within a team. type: object @@ -42483,7 +42841,7 @@ paths: format: uri examples: - https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1 - reactions: *104 + reactions: *116 required: - author - body @@ -42498,7 +42856,7 @@ paths: - updated_at - url examples: - default: &628 + default: &635 value: - author: login: octocat @@ -42566,9 +42924,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment parameters: - - *138 - - *246 - - *297 + - *150 + - *258 + - *304 requestBody: required: true content: @@ -42590,9 +42948,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: &299 + default: &306 value: author: login: octocat @@ -42658,10 +43016,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment parameters: - - *138 - - *246 - - *297 - - &300 + - *150 + - *258 + - *304 + - &307 name: comment_number description: The number that identifies the comment. in: path @@ -42673,9 +43031,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -42697,10 +43055,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment parameters: - - *138 - - *246 - - *297 - - *300 + - *150 + - *258 + - *304 + - *307 requestBody: required: true content: @@ -42722,9 +43080,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: &629 + default: &636 value: author: login: octocat @@ -42788,10 +43146,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment parameters: - - *138 - - *246 - - *297 - - *300 + - *150 + - *258 + - *304 + - *307 responses: '204': description: Response @@ -42817,10 +43175,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: - - *138 - - *246 - - *297 - - *300 + - *150 + - *258 + - *304 + - *307 - 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. @@ -42846,7 +43204,7 @@ paths: application/json: schema: type: array - items: &301 + items: &308 title: Reaction description: Reactions to conversations provide a way to help people express their feelings more simply and effectively. @@ -42890,7 +43248,7 @@ paths: - content - created_at examples: - default: &303 + default: &310 value: - id: 1 node_id: MDg6UmVhY3Rpb24x @@ -42940,10 +43298,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: - - *138 - - *246 - - *297 - - *300 + - *150 + - *258 + - *304 + - *307 requestBody: required: true content: @@ -42976,9 +43334,9 @@ paths: team discussion comment content: application/json: - schema: *301 + schema: *308 examples: - default: &302 + default: &309 value: id: 1 node_id: MDg6UmVhY3Rpb24x @@ -43007,9 +43365,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -43032,11 +43390,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-comment-reaction parameters: - - *138 - - *246 - - *297 - - *300 - - &304 + - *150 + - *258 + - *304 + - *307 + - &311 name: reaction_id description: The unique identifier of the reaction. in: path @@ -43068,9 +43426,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-team-discussion parameters: - - *138 - - *246 - - *297 + - *150 + - *258 + - *304 - 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. @@ -43096,9 +43454,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *303 + default: *310 headers: Link: *37 x-github: @@ -43124,9 +43482,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-team-discussion parameters: - - *138 - - *246 - - *297 + - *150 + - *258 + - *304 requestBody: required: true content: @@ -43158,16 +43516,16 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '201': description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -43190,10 +43548,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-team-discussion-reaction parameters: - - *138 - - *246 - - *297 + - *150 + - *258 - *304 + - *311 responses: '204': description: Response @@ -43216,16 +43574,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: - - *138 - - *246 + - *150 + - *258 responses: '200': description: Response content: application/json: - schema: *305 + schema: *312 examples: - default: *306 + default: *313 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -43244,8 +43602,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: - - *138 - - *246 + - *150 + - *258 requestBody: required: true content: @@ -43269,9 +43627,9 @@ paths: description: Response content: application/json: - schema: *307 + schema: *314 examples: - default: *308 + default: *315 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -43290,8 +43648,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: - - *138 - - *246 + - *150 + - *258 responses: '204': description: Response @@ -43315,8 +43673,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations parameters: - - *138 - - *246 + - *150 + - *258 - *17 - *18 responses: @@ -43326,9 +43684,9 @@ paths: application/json: schema: type: array - items: *231 + items: *243 examples: - default: *232 + default: *244 headers: Link: *37 x-github: @@ -43350,8 +43708,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members parameters: - - *138 - - *246 + - *150 + - *258 - name: role description: Filters members returned by their role in the team. in: query @@ -43374,7 +43732,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 x-github: @@ -43404,15 +43762,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-membership-for-a-user parameters: - - *138 - - *246 - - *178 + - *150 + - *258 + - *190 responses: '200': description: Response content: application/json: - schema: &309 + schema: &316 title: Team Membership description: Team Membership type: object @@ -43440,7 +43798,7 @@ paths: - state - url examples: - response-if-user-is-a-team-maintainer: &630 + response-if-user-is-a-team-maintainer: &637 summary: Response if user is a team maintainer value: url: https://api.github.com/teams/1/memberships/octocat @@ -43476,9 +43834,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: - - *138 - - *246 - - *178 + - *150 + - *258 + - *190 requestBody: required: false content: @@ -43503,9 +43861,9 @@ paths: description: Response content: application/json: - schema: *309 + schema: *316 examples: - response-if-users-membership-with-team-is-now-pending: &631 + response-if-users-membership-with-team-is-now-pending: &638 summary: Response if user's membership with team is now pending value: url: https://api.github.com/teams/1/memberships/octocat @@ -43540,9 +43898,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-membership-for-a-user parameters: - - *138 - - *246 - - *178 + - *150 + - *258 + - *190 responses: '204': description: Response @@ -43568,8 +43926,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects parameters: - - *138 - - *246 + - *150 + - *258 - *17 - *18 responses: @@ -43579,7 +43937,7 @@ paths: application/json: schema: type: array - items: &310 + items: &317 title: Team Project description: A team's access to a project. type: object @@ -43648,7 +44006,7 @@ paths: - updated_at - permissions examples: - default: &632 + default: &639 value: - owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -43709,9 +44067,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-project parameters: - - *138 - - *246 - - &311 + - *150 + - *258 + - &318 name: project_id description: The unique identifier of the project. in: path @@ -43723,9 +44081,9 @@ paths: description: Response content: application/json: - schema: *310 + schema: *317 examples: - default: &633 + default: &640 value: owner_url: https://api.github.com/orgs/octocat url: https://api.github.com/projects/1002605 @@ -43785,9 +44143,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-project-permissions parameters: - - *138 - - *246 - - *311 + - *150 + - *258 + - *318 requestBody: required: false content: @@ -43852,9 +44210,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-project-from-a-team parameters: - - *138 - - *246 - - *311 + - *150 + - *258 + - *318 responses: '204': description: Response @@ -43878,8 +44236,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories parameters: - - *138 - - *246 + - *150 + - *258 - *17 - *18 responses: @@ -43889,9 +44247,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 x-github: @@ -43920,16 +44278,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#check-team-permissions-for-a-repository parameters: - - *138 - - *246 - - *312 - - *313 + - *150 + - *258 + - *319 + - *320 responses: '200': description: Alternative response with repository permissions content: application/json: - schema: &634 + schema: &641 title: Team Repository description: A team's access to a repository. type: object @@ -43955,7 +44313,7 @@ paths: license: anyOf: - type: 'null' - - *117 + - *129 forks: type: integer permissions: @@ -44570,10 +44928,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#add-or-update-team-repository-permissions parameters: - - *138 - - *246 - - *312 - - *313 + - *150 + - *258 + - *319 + - *320 requestBody: required: false content: @@ -44618,10 +44976,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#remove-a-repository-from-a-team parameters: - - *138 - - *246 - - *312 - - *313 + - *150 + - *258 + - *319 + - *320 responses: '204': description: Response @@ -44647,16 +45005,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: - - *138 - - *246 + - *150 + - *258 responses: '200': description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 x-github: githubCloudOnly: true enabledForGitHubApps: false @@ -44678,8 +45036,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: - - *138 - - *246 + - *150 + - *258 requestBody: required: true content: @@ -44722,7 +45080,7 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: default: value: @@ -44754,8 +45112,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams parameters: - - *138 - - *246 + - *150 + - *258 - *17 - *18 responses: @@ -44765,9 +45123,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - response-if-child-teams-exist: &635 + response-if-child-teams-exist: &642 value: - id: 2 node_id: MDQ6VGVhbTI= @@ -44820,7 +45178,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: - - *138 + - *150 - name: security_product in: path description: The security feature to enable or disable. @@ -44891,7 +45249,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#get-a-project-card parameters: - - &316 + - &323 name: card_id description: The unique identifier of the card. in: path @@ -44903,7 +45261,7 @@ paths: description: Response content: application/json: - schema: &317 + schema: &324 title: Project Card description: Project cards represent a scope of work. type: object @@ -44978,7 +45336,7 @@ paths: - created_at - updated_at examples: - default: &318 + default: &325 value: url: https://api.github.com/projects/columns/cards/1478 id: 1478 @@ -45028,7 +45386,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#update-an-existing-project-card parameters: - - *316 + - *323 requestBody: required: false content: @@ -45058,9 +45416,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *324 examples: - default: *318 + default: *325 '304': *35 '403': *27 '401': *23 @@ -45081,7 +45439,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#delete-a-project-card parameters: - - *316 + - *323 responses: '204': description: Response @@ -45119,7 +45477,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#move-a-project-card parameters: - - *316 + - *323 requestBody: required: true content: @@ -45226,7 +45584,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#get-a-project-column parameters: - - &319 + - &326 name: column_id description: The unique identifier of the column. in: path @@ -45238,7 +45596,7 @@ paths: description: Response content: application/json: - schema: &320 + schema: &327 title: Project Column description: Project columns contain cards of work. type: object @@ -45292,7 +45650,7 @@ paths: - created_at - updated_at examples: - default: &321 + default: &328 value: url: https://api.github.com/projects/columns/367 project_url: https://api.github.com/projects/120 @@ -45321,7 +45679,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#update-an-existing-project-column parameters: - - *319 + - *326 requestBody: required: true content: @@ -45346,9 +45704,9 @@ paths: description: Response content: application/json: - schema: *320 + schema: *327 examples: - default: *321 + default: *328 '304': *35 '403': *27 '401': *23 @@ -45367,7 +45725,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#delete-a-project-column parameters: - - *319 + - *326 responses: '204': description: Response @@ -45390,7 +45748,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#list-project-cards parameters: - - *319 + - *326 - name: archived_state description: Filters the project cards that are returned by the card's state. in: query @@ -45411,7 +45769,7 @@ paths: application/json: schema: type: array - items: *317 + items: *324 examples: default: value: @@ -45464,7 +45822,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/cards#create-a-project-card parameters: - - *319 + - *326 requestBody: required: true content: @@ -45508,9 +45866,9 @@ paths: description: Response content: application/json: - schema: *317 + schema: *324 examples: - default: *318 + default: *325 '304': *35 '403': *27 '401': *23 @@ -45520,8 +45878,8 @@ paths: application/json: schema: oneOf: - - *141 - - *142 + - *153 + - *154 '503': description: Response content: @@ -45560,7 +45918,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#move-a-project-column parameters: - - *319 + - *326 requestBody: required: true content: @@ -45617,15 +45975,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#get-a-project parameters: - - *311 + - *318 responses: '200': description: Response content: application/json: - schema: *262 + schema: *274 examples: - default: &322 + default: &329 value: owner_url: https://api.github.com/repos/api-playground/projects-test url: https://api.github.com/projects/1002604 @@ -45678,7 +46036,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#update-a-project parameters: - - *311 + - *318 requestBody: required: false content: @@ -45727,9 +46085,9 @@ paths: description: Response content: application/json: - schema: *262 + schema: *274 examples: - default: *322 + default: *329 '404': description: Not Found if the authenticated user does not have access to the project @@ -45750,7 +46108,7 @@ paths: items: type: string '401': *23 - '410': *323 + '410': *330 '422': *7 x-github: githubCloudOnly: false @@ -45768,7 +46126,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#delete-a-project parameters: - - *311 + - *318 responses: '204': description: Delete Success @@ -45789,7 +46147,7 @@ paths: items: type: string '401': *23 - '410': *323 + '410': *330 '404': *6 x-github: githubCloudOnly: false @@ -45812,7 +46170,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#list-project-collaborators parameters: - - *311 + - *318 - 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 @@ -45839,7 +46197,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 '404': *6 @@ -45864,8 +46222,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#add-project-collaborator parameters: - - *311 - - *178 + - *318 + - *190 requestBody: required: false content: @@ -45914,8 +46272,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#remove-user-as-a-collaborator parameters: - - *311 - - *178 + - *318 + - *190 responses: '204': description: Response @@ -45943,8 +46301,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/collaborators#get-project-permission-for-a-user parameters: - - *311 - - *178 + - *318 + - *190 responses: '200': description: Response @@ -46008,7 +46366,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#list-project-columns parameters: - - *311 + - *318 - *17 - *18 responses: @@ -46018,7 +46376,7 @@ paths: application/json: schema: type: array - items: *320 + items: *327 examples: default: value: @@ -46050,7 +46408,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/columns#create-a-project-column parameters: - - *311 + - *318 requestBody: required: true content: @@ -46074,7 +46432,7 @@ paths: description: Response content: application/json: - schema: *320 + schema: *327 examples: default: value: @@ -46135,7 +46493,7 @@ paths: resources: type: object properties: - core: &324 + core: &331 title: Rate Limit type: object properties: @@ -46152,19 +46510,20 @@ paths: - remaining - reset - used - graphql: *324 - search: *324 - code_search: *324 - source_import: *324 - integration_manifest: *324 - code_scanning_upload: *324 - actions_runner_registration: *324 - scim: *324 - dependency_snapshots: *324 + graphql: *331 + search: *331 + code_search: *331 + source_import: *331 + integration_manifest: *331 + code_scanning_upload: *331 + actions_runner_registration: *331 + scim: *331 + dependency_snapshots: *331 + code_scanning_autofix: *331 required: - core - search - rate: *324 + rate: *331 required: - rate - resources @@ -46222,6 +46581,11 @@ paths: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -46263,14 +46627,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: *325 + schema: *332 examples: default-response: summary: Default response @@ -46775,7 +47139,7 @@ paths: status: disabled '403': *27 '404': *6 - '301': *326 + '301': *333 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -46793,8 +47157,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#update-a-repository parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: false content: @@ -47041,10 +47405,10 @@ paths: description: Response content: application/json: - schema: *325 + schema: *332 examples: - default: *327 - '307': &328 + default: *334 + '307': &335 description: Temporary Redirect content: application/json: @@ -47073,8 +47437,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#delete-a-repository parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -47096,7 +47460,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': *328 + '307': *335 '404': *6 x-github: githubCloudOnly: false @@ -47119,11 +47483,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-artifacts-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 - - &343 + - &350 name: name description: The name field of an artifact. When specified, only artifacts with this name will be returned. @@ -47146,7 +47510,7 @@ paths: type: integer artifacts: type: array - items: &329 + items: &336 title: Artifact description: An artifact type: object @@ -47232,7 +47596,7 @@ paths: - expires_at - updated_at examples: - default: &344 + default: &351 value: total_count: 2 artifacts: @@ -47291,9 +47655,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#get-an-artifact parameters: - - *312 - - *313 - - &330 + - *319 + - *320 + - &337 name: artifact_id description: The unique identifier of the artifact. in: path @@ -47305,7 +47669,7 @@ paths: description: Response content: application/json: - schema: *329 + schema: *336 examples: default: value: @@ -47342,9 +47706,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#delete-an-artifact parameters: - - *312 - - *313 - - *330 + - *319 + - *320 + - *337 responses: '204': description: Response @@ -47368,9 +47732,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#download-an-artifact parameters: - - *312 - - *313 - - *330 + - *319 + - *320 + - *337 - name: archive_format in: path required: true @@ -47384,7 +47748,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': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47407,14 +47771,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: *331 + schema: *338 examples: default: value: @@ -47440,11 +47804,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: - - *312 - - *313 + - *319 + - *320 - *17 - *18 - - &332 + - &339 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 @@ -47478,7 +47842,7 @@ paths: description: Response content: application/json: - schema: &333 + schema: &340 title: Repository actions caches description: Repository actions caches type: object @@ -47528,7 +47892,7 @@ paths: - total_count - actions_caches examples: - default: &334 + default: &341 value: total_count: 1 actions_caches: @@ -47560,23 +47924,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: - - *312 - - *313 + - *319 + - *320 - name: key description: A key for identifying the cache. in: query required: true schema: type: string - - *332 + - *339 responses: '200': description: Response content: application/json: - schema: *333 + schema: *340 examples: - default: *334 + default: *341 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -47596,8 +47960,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: - - *312 - - *313 + - *319 + - *320 - name: cache_id description: The unique identifier of the GitHub Actions cache. in: path @@ -47628,9 +47992,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: - - *312 - - *313 - - &335 + - *319 + - *320 + - &342 name: job_id description: The unique identifier of the job. in: path @@ -47642,7 +48006,7 @@ paths: description: Response content: application/json: - schema: &347 + schema: &354 title: Job description: Information of a job execution in a workflow run type: object @@ -47989,9 +48353,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: - - *312 - - *313 - - *335 + - *319 + - *320 + - *342 responses: '302': description: Response @@ -48019,9 +48383,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: - - *312 - - *313 - - *335 + - *319 + - *320 + - *342 requestBody: required: false content: @@ -48043,7 +48407,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -48067,8 +48431,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Status response @@ -48118,8 +48482,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -48153,7 +48517,7 @@ paths: description: Empty response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -48182,8 +48546,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-organization-secrets parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -48201,7 +48565,7 @@ paths: type: integer secrets: type: array - items: &349 + items: &356 title: Actions Secret description: Set secrets for GitHub Actions. type: object @@ -48222,7 +48586,7 @@ paths: - created_at - updated_at examples: - default: &350 + default: &357 value: total_count: 2 secrets: @@ -48255,9 +48619,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-organization-variables parameters: - - *312 - - *313 - - *336 + - *319 + - *320 + - *343 - *18 responses: '200': @@ -48274,7 +48638,7 @@ paths: type: integer variables: type: array - items: &353 + items: &360 title: Actions Variable type: object properties: @@ -48308,7 +48672,7 @@ paths: - created_at - updated_at examples: - default: &354 + default: &361 value: total_count: 2 variables: @@ -48341,8 +48705,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -48351,11 +48715,11 @@ paths: schema: type: object properties: - enabled: &337 + enabled: &344 type: boolean description: Whether GitHub Actions is enabled on the repository. allowed_actions: *40 - selected_actions_url: *149 + selected_actions_url: *161 required: - enabled examples: @@ -48384,8 +48748,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: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -48396,7 +48760,7 @@ paths: schema: type: object properties: - enabled: *337 + enabled: *344 allowed_actions: *40 required: - enabled @@ -48427,14 +48791,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: &338 + schema: &345 type: object properties: access_level: @@ -48452,7 +48816,7 @@ paths: required: - access_level examples: - default: &339 + default: &346 value: access_level: organization x-github: @@ -48477,15 +48841,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: application/json: - schema: *338 + schema: *345 examples: - default: *339 + default: *346 responses: '204': description: Response @@ -48509,8 +48873,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -48541,8 +48905,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: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -48574,14 +48938,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: *152 + schema: *164 examples: default: *46 x-github: @@ -48604,8 +48968,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: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Success response @@ -48616,7 +48980,7 @@ paths: required: true content: application/json: - schema: *153 + schema: *165 examples: default: *46 x-github: @@ -48645,8 +49009,8 @@ paths: in: query schema: type: string - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -48690,8 +49054,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -48699,9 +49063,9 @@ paths: application/json: schema: type: array - items: *157 + items: *169 examples: - default: *158 + default: *170 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48723,8 +49087,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -48767,7 +49131,7 @@ paths: - no-gpu work_folder: _work responses: - '201': *159 + '201': *171 '404': *6 '422': *7 x-github: @@ -48797,8 +49161,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: - - *312 - - *313 + - *319 + - *320 responses: '201': description: Response @@ -48806,7 +49170,7 @@ paths: application/json: schema: *56 examples: - default: *160 + default: *172 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48834,8 +49198,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: - - *312 - - *313 + - *319 + - *320 responses: '201': description: Response @@ -48843,7 +49207,7 @@ paths: application/json: schema: *56 examples: - default: *161 + default: *173 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48865,8 +49229,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: - - *312 - - *313 + - *319 + - *320 - *52 responses: '200': @@ -48875,7 +49239,7 @@ paths: application/json: schema: *53 examples: - default: *162 + default: *174 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -48896,8 +49260,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: - - *312 - - *313 + - *319 + - *320 - *52 responses: '204': @@ -48923,8 +49287,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: - - *312 - - *313 + - *319 + - *320 - *52 responses: '200': *58 @@ -48949,8 +49313,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: - - *312 - - *313 + - *319 + - *320 - *52 requestBody: required: true @@ -48999,8 +49363,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: - - *312 - - *313 + - *319 + - *320 - *52 requestBody: required: true @@ -49050,11 +49414,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: - - *312 - - *313 + - *319 + - *320 - *52 responses: - '200': *163 + '200': *175 '404': *6 x-github: githubCloudOnly: false @@ -49081,10 +49445,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: - - *312 - - *313 + - *319 + - *320 - *52 - - *164 + - *176 responses: '200': *58 '404': *6 @@ -49112,9 +49476,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: - - *312 - - *313 - - &357 + - *319 + - *320 + - &364 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. @@ -49122,7 +49486,7 @@ paths: required: false schema: type: string - - &358 + - &365 name: branch description: Returns workflow runs associated with a branch. Use the name of the branch of the `push`. @@ -49130,7 +49494,7 @@ paths: required: false schema: type: string - - &359 + - &366 name: event description: Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see "[Events @@ -49139,7 +49503,7 @@ paths: required: false schema: type: string - - &360 + - &367 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 @@ -49166,7 +49530,7 @@ paths: - pending - *17 - *18 - - &361 + - &368 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)." @@ -49175,7 +49539,7 @@ paths: schema: type: string format: date-time - - &340 + - &347 name: exclude_pull_requests description: If `true` pull requests are omitted from the response (empty array). @@ -49184,13 +49548,13 @@ paths: schema: type: boolean default: false - - &362 + - &369 name: check_suite_id description: Returns workflow runs with the `check_suite_id` that you specify. in: query schema: type: integer - - &363 + - &370 name: head_sha description: Only returns workflow runs that are associated with the specified `head_sha`. @@ -49213,7 +49577,7 @@ paths: type: integer workflow_runs: type: array - items: &341 + items: &348 title: Workflow Run description: An invocation of a workflow type: object @@ -49330,7 +49694,7 @@ paths: type: - array - 'null' - items: &382 + items: &389 title: Pull Request Minimal type: object properties: @@ -49457,7 +49821,7 @@ paths: head_commit: anyOf: - type: 'null' - - &386 + - &393 title: Simple Commit description: A commit. type: object @@ -49531,8 +49895,8 @@ paths: - timestamp - author - committer - repository: *156 - head_repository: *156 + repository: *168 + head_repository: *168 head_repository_id: type: integer examples: @@ -49572,7 +49936,7 @@ paths: - workflow_url - pull_requests examples: - default: &364 + default: &371 value: total_count: 1 workflow_runs: @@ -49808,24 +50172,24 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run parameters: - - *312 - - *313 - - &342 + - *319 + - *320 + - &349 name: run_id description: The unique identifier of the workflow run. in: path required: true schema: type: integer - - *340 + - *347 responses: '200': description: Response content: application/json: - schema: *341 + schema: *348 examples: - default: &345 + default: &352 value: id: 30433642 name: Build @@ -50066,9 +50430,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-a-workflow-run parameters: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '204': description: Response @@ -50091,9 +50455,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: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '200': description: Response @@ -50221,15 +50585,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: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '201': description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -50256,12 +50620,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/artifacts#list-workflow-run-artifacts parameters: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 - *17 - *18 - - *343 + - *350 responses: '200': description: Response @@ -50277,9 +50641,9 @@ paths: type: integer artifacts: type: array - items: *329 + items: *336 examples: - default: *344 + default: *351 headers: Link: *37 x-github: @@ -50303,25 +50667,25 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-a-workflow-run-attempt parameters: - - *312 - - *313 - - *342 - - &346 + - *319 + - *320 + - *349 + - &353 name: attempt_number description: The attempt number of the workflow run. in: path required: true schema: type: integer - - *340 + - *347 responses: '200': description: Response content: application/json: - schema: *341 + schema: *348 examples: - default: *345 + default: *352 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50344,10 +50708,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: - - *312 - - *313 - - *342 - - *346 + - *319 + - *320 + - *349 + - *353 - *17 - *18 responses: @@ -50365,9 +50729,9 @@ paths: type: integer jobs: type: array - items: *347 + items: *354 examples: - default: &348 + default: &355 value: total_count: 1 jobs: @@ -50480,10 +50844,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-attempt-logs parameters: - - *312 - - *313 - - *342 - - *346 + - *319 + - *320 + - *349 + - *353 responses: '302': description: Response @@ -50511,19 +50875,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#cancel-a-workflow-run parameters: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '202': description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50546,9 +50910,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: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 requestBody: required: true content: @@ -50615,19 +50979,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#force-cancel-a-workflow-run parameters: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '202': description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -50650,9 +51014,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: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 - 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 @@ -50682,9 +51046,9 @@ paths: type: integer jobs: type: array - items: *347 + items: *354 examples: - default: *348 + default: *355 headers: Link: *37 x-github: @@ -50709,9 +51073,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#download-workflow-run-logs parameters: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '302': description: Response @@ -50738,9 +51102,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#delete-workflow-run-logs parameters: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '204': description: Response @@ -50767,9 +51131,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: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '200': description: Response @@ -50838,7 +51202,7 @@ paths: items: type: object properties: - type: &454 + type: &461 type: string description: The type of reviewer. enum: @@ -50849,7 +51213,7 @@ paths: reviewer: anyOf: - *4 - - *234 + - *246 required: - environment - wait_timer @@ -50924,9 +51288,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: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 requestBody: required: true content: @@ -50976,7 +51340,7 @@ paths: application/json: schema: type: array - items: &449 + items: &456 title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed @@ -51088,7 +51452,7 @@ paths: - created_at - updated_at examples: - default: &450 + default: &457 value: - url: https://api.github.com/repos/octocat/example/deployments/1 id: 1 @@ -51144,9 +51508,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#re-run-a-workflow parameters: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 requestBody: required: false content: @@ -51168,7 +51532,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -51191,9 +51555,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: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 requestBody: required: false content: @@ -51215,7 +51579,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -51240,9 +51604,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflow-runs#get-workflow-run-usage parameters: - - *312 - - *313 - - *342 + - *319 + - *320 + - *349 responses: '200': description: Response @@ -51379,8 +51743,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-repository-secrets parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -51398,9 +51762,9 @@ paths: type: integer secrets: type: array - items: *349 + items: *356 examples: - default: *350 + default: *357 headers: Link: *37 x-github: @@ -51425,16 +51789,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-public-key parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: *351 + schema: *358 examples: - default: *352 + default: *359 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -51456,17 +51820,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-a-repository-secret parameters: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 responses: '200': description: Response content: application/json: - schema: *349 + schema: *356 examples: - default: &467 + default: &474 value: name: GH_TOKEN created_at: '2019-08-10T14:59:22Z' @@ -51492,9 +51856,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-a-repository-secret parameters: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 requestBody: required: true content: @@ -51522,7 +51886,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -51548,9 +51912,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-a-repository-secret parameters: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 responses: '204': description: Response @@ -51575,9 +51939,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-repository-variables parameters: - - *312 - - *313 - - *336 + - *319 + - *320 + - *343 - *18 responses: '200': @@ -51594,9 +51958,9 @@ paths: type: integer variables: type: array - items: *353 + items: *360 examples: - default: *354 + default: *361 headers: Link: *37 x-github: @@ -51619,8 +51983,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-a-repository-variable parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -51647,7 +52011,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -51672,17 +52036,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-a-repository-variable parameters: - - *312 - - *313 - - *169 + - *319 + - *320 + - *181 responses: '200': description: Response content: application/json: - schema: *353 + schema: *360 examples: - default: &468 + default: &475 value: name: USERNAME value: octocat @@ -51708,9 +52072,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-a-repository-variable parameters: - - *312 - - *313 - - *169 + - *319 + - *320 + - *181 requestBody: required: true content: @@ -51752,9 +52116,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-a-repository-variable parameters: - - *312 - - *313 - - *169 + - *319 + - *320 + - *181 responses: '204': description: Response @@ -51779,8 +52143,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#list-repository-workflows parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -51798,7 +52162,7 @@ paths: type: integer workflows: type: array - items: &355 + items: &362 title: Workflow description: A GitHub Actions workflow type: object @@ -51916,9 +52280,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-a-workflow parameters: - - *312 - - *313 - - &356 + - *319 + - *320 + - &363 name: workflow_id in: path description: The ID of the workflow. You can also pass the workflow file name @@ -51933,7 +52297,7 @@ paths: description: Response content: application/json: - schema: *355 + schema: *362 examples: default: value: @@ -51966,9 +52330,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#disable-a-workflow parameters: - - *312 - - *313 - - *356 + - *319 + - *320 + - *363 responses: '204': description: Response @@ -51993,9 +52357,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#create-a-workflow-dispatch-event parameters: - - *312 - - *313 - - *356 + - *319 + - *320 + - *363 responses: '204': description: Response @@ -52046,9 +52410,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#enable-a-workflow parameters: - - *312 - - *313 - - *356 + - *319 + - *320 + - *363 responses: '204': description: Response @@ -52075,19 +52439,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: - - *312 - - *313 - - *356 - - *357 - - *358 - - *359 - - *360 + - *319 + - *320 + - *363 + - *364 + - *365 + - *366 + - *367 - *17 - *18 - - *361 - - *340 - - *362 - - *363 + - *368 + - *347 + - *369 + - *370 responses: '200': description: Response @@ -52103,9 +52467,9 @@ paths: type: integer workflow_runs: type: array - items: *341 + items: *348 examples: - default: *364 + default: *371 headers: Link: *37 x-github: @@ -52131,9 +52495,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/workflows#get-workflow-usage parameters: - - *312 - - *313 - - *356 + - *319 + - *320 + - *363 responses: '200': description: Response @@ -52194,8 +52558,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-activities parameters: - - *312 - - *313 + - *319 + - *320 - *76 - *17 - *74 @@ -52363,8 +52727,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#list-assignees parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -52376,7 +52740,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 '404': *6 @@ -52401,8 +52765,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: - - *312 - - *313 + - *319 + - *320 - name: assignee in: path required: true @@ -52438,8 +52802,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-an-attestation parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -52551,8 +52915,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-attestations parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *74 - *75 @@ -52595,8 +52959,10 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: - default: *365 + default: *372 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -52616,8 +52982,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/autolinks#get-all-autolinks-of-a-repository parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -52625,7 +52991,7 @@ paths: application/json: schema: type: array - items: &366 + items: &373 title: Autolink reference description: An autolink reference. type: object @@ -52679,8 +53045,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -52719,9 +53085,9 @@ paths: description: response content: application/json: - schema: *366 + schema: *373 examples: - default: &367 + default: &374 value: id: 1 key_prefix: TICKET- @@ -52752,9 +53118,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: - - *312 - - *313 - - &368 + - *319 + - *320 + - &375 name: autolink_id description: The unique identifier of the autolink. in: path @@ -52766,9 +53132,9 @@ paths: description: Response content: application/json: - schema: *366 + schema: *373 examples: - default: *367 + default: *374 '404': *6 x-github: githubCloudOnly: false @@ -52788,9 +53154,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: - - *312 - - *313 - - *368 + - *319 + - *320 + - *375 responses: '204': description: Response @@ -52814,8 +53180,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response if Dependabot is enabled @@ -52865,8 +53231,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-automated-security-fixes parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -52887,8 +53253,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-automated-security-fixes parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -52908,8 +53274,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#list-branches parameters: - - *312 - - *313 + - *319 + - *320 - name: protected description: Setting to `true` returns only branches protected by branch protections or rulesets. When set to `false`, only unprotected branches are returned. @@ -52947,7 +53313,7 @@ paths: - url protected: type: boolean - protection: &370 + protection: &377 title: Branch Protection description: Branch Protection type: object @@ -52990,7 +53356,7 @@ paths: required: - contexts - checks - enforce_admins: &373 + enforce_admins: &380 title: Protected Branch Admin Enforced description: Protected Branch Admin Enforced type: object @@ -53007,7 +53373,7 @@ paths: required: - url - enabled - required_pull_request_reviews: &375 + required_pull_request_reviews: &382 title: Protected Branch Pull Request Review description: Protected Branch Pull Request Review type: object @@ -53029,7 +53395,7 @@ paths: description: The list of teams with review dismissal access. type: array - items: *234 + items: *246 apps: description: The list of apps with review dismissal access. @@ -53061,7 +53427,7 @@ paths: description: The list of teams allowed to bypass pull request requirements. type: array - items: *234 + items: *246 apps: description: The list of apps allowed to bypass pull request requirements. @@ -53091,7 +53457,7 @@ paths: required: - dismiss_stale_reviews - require_code_owner_reviews - restrictions: &372 + restrictions: &379 title: Branch Restriction Policy description: Branch Restriction Policy type: object @@ -53416,9 +53782,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#get-a-branch parameters: - - *312 - - *313 - - &371 + - *319 + - *320 + - &378 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). @@ -53432,14 +53798,14 @@ paths: description: Response content: application/json: - schema: &381 + schema: &388 title: Branch With Protection description: Branch With Protection type: object properties: name: type: string - commit: &425 + commit: &432 title: Commit description: Commit type: object @@ -53478,7 +53844,7 @@ paths: author: anyOf: - type: 'null' - - &369 + - &376 title: Git User description: Metaproperties for Git author/committer information. @@ -53499,7 +53865,7 @@ paths: committer: anyOf: - type: 'null' - - *369 + - *376 message: type: string examples: @@ -53523,7 +53889,7 @@ paths: required: - sha - url - verification: &474 + verification: &481 title: Verification type: object properties: @@ -53558,14 +53924,14 @@ paths: author: oneOf: - *4 - - *167 + - *179 type: - 'null' - object committer: oneOf: - *4 - - *167 + - *179 type: - 'null' - object @@ -53602,7 +53968,7 @@ paths: type: integer files: type: array - items: &437 + items: &444 title: Diff Entry description: Diff Entry type: object @@ -53696,7 +54062,7 @@ paths: - self protected: type: boolean - protection: *370 + protection: *377 protection_url: type: string format: uri @@ -53805,7 +54171,7 @@ paths: contexts: [] checks: [] protection_url: https://api.github.com/repos/octocat/Hello-World/branches/main/protection - '301': *326 + '301': *333 '404': *6 x-github: githubCloudOnly: false @@ -53827,15 +54193,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-branch-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response content: application/json: - schema: *370 + schema: *377 examples: default: value: @@ -54029,9 +54395,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-branch-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: true content: @@ -54291,7 +54657,7 @@ paths: url: type: string format: uri - required_status_checks: &378 + required_status_checks: &385 title: Status Check Policy description: Status Check Policy type: object @@ -54372,7 +54738,7 @@ paths: items: *4 teams: type: array - items: *234 + items: *246 apps: type: array items: *5 @@ -54390,7 +54756,7 @@ paths: items: *4 teams: type: array - items: *234 + items: *246 apps: type: array items: *5 @@ -54450,7 +54816,7 @@ paths: additionalProperties: false required: - enabled - restrictions: *372 + restrictions: *379 required_conversation_resolution: type: object properties: @@ -54562,9 +54928,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-branch-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '204': description: Response @@ -54589,17 +54955,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-admin-branch-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response content: application/json: - schema: *373 + schema: *380 examples: - default: &374 + default: &381 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins enabled: true @@ -54621,17 +54987,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-admin-branch-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response content: application/json: - schema: *373 + schema: *380 examples: - default: *374 + default: *381 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -54650,9 +55016,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-admin-branch-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '204': description: Response @@ -54677,17 +55043,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-pull-request-review-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response content: application/json: - schema: *375 + schema: *382 examples: - default: &376 + default: &383 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews dismissal_restrictions: @@ -54783,9 +55149,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-pull-request-review-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: false content: @@ -54883,9 +55249,9 @@ paths: description: Response content: application/json: - schema: *375 + schema: *382 examples: - default: *376 + default: *383 '422': *15 x-github: githubCloudOnly: false @@ -54906,9 +55272,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-pull-request-review-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '204': description: Response @@ -54935,17 +55301,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-commit-signature-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response content: application/json: - schema: *373 + schema: *380 examples: - default: &377 + default: &384 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures enabled: true @@ -54968,17 +55334,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#create-commit-signature-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response content: application/json: - schema: *373 + schema: *380 examples: - default: *377 + default: *384 '404': *6 x-github: githubCloudOnly: false @@ -54998,9 +55364,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-commit-signature-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '204': description: Response @@ -55025,17 +55391,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-status-checks-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response content: application/json: - schema: *378 + schema: *385 examples: - default: &379 + default: &386 value: url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks strict: true @@ -55061,9 +55427,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#update-status-check-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: false content: @@ -55115,9 +55481,9 @@ paths: description: Response content: application/json: - schema: *378 + schema: *385 examples: - default: *379 + default: *386 '404': *6 '422': *15 x-github: @@ -55139,9 +55505,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-protection parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '204': description: Response @@ -55165,9 +55531,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-all-status-check-contexts parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response @@ -55201,9 +55567,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-status-check-contexts parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: false content: @@ -55270,9 +55636,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-status-check-contexts parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: false content: @@ -55336,9 +55702,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-status-check-contexts parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: content: application/json: @@ -55404,15 +55770,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#get-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response content: application/json: - schema: *372 + schema: *379 examples: default: value: @@ -55503,9 +55869,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#delete-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '204': description: Response @@ -55528,9 +55894,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: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response @@ -55540,7 +55906,7 @@ paths: type: array items: *5 examples: - default: &380 + default: &387 value: - id: 1 slug: octoapp @@ -55597,9 +55963,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-app-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: true content: @@ -55633,7 +55999,7 @@ paths: type: array items: *5 examples: - default: *380 + default: *387 '422': *15 x-github: githubCloudOnly: false @@ -55654,9 +56020,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-app-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: true content: @@ -55690,7 +56056,7 @@ paths: type: array items: *5 examples: - default: *380 + default: *387 '422': *15 x-github: githubCloudOnly: false @@ -55711,9 +56077,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-app-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: true content: @@ -55747,7 +56113,7 @@ paths: type: array items: *5 examples: - default: *380 + default: *387 '422': *15 x-github: githubCloudOnly: false @@ -55769,9 +56135,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: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response @@ -55779,9 +56145,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - default: *248 + default: *260 '404': *6 x-github: githubCloudOnly: false @@ -55801,9 +56167,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-team-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: false content: @@ -55839,9 +56205,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - default: *248 + default: *260 '422': *15 x-github: githubCloudOnly: false @@ -55862,9 +56228,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-team-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: false content: @@ -55900,9 +56266,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - default: *248 + default: *260 '422': *15 x-github: githubCloudOnly: false @@ -55923,9 +56289,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-team-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: content: application/json: @@ -55960,9 +56326,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - default: *248 + default: *260 '422': *15 x-github: githubCloudOnly: false @@ -55984,9 +56350,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: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 responses: '200': description: Response @@ -55996,7 +56362,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 '404': *6 x-github: githubCloudOnly: false @@ -56020,9 +56386,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#add-user-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: true content: @@ -56055,7 +56421,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 '422': *15 x-github: githubCloudOnly: false @@ -56080,9 +56446,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#set-user-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: true content: @@ -56115,7 +56481,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 '422': *15 x-github: githubCloudOnly: false @@ -56140,9 +56506,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branch-protection#remove-user-access-restrictions parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: true content: @@ -56175,7 +56541,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 '422': *15 x-github: githubCloudOnly: false @@ -56202,9 +56568,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#rename-a-branch parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 requestBody: required: true content: @@ -56226,7 +56592,7 @@ paths: description: Response content: application/json: - schema: *381 + schema: *388 examples: default: value: @@ -56342,8 +56708,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#create-a-check-run parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -56622,7 +56988,7 @@ paths: description: Response content: application/json: - schema: &383 + schema: &390 title: CheckRun description: A check performed on the code of a given code change type: object @@ -56757,8 +57123,8 @@ paths: do not necessarily indicate pull requests that triggered the check. type: array - items: *382 - deployment: &685 + items: *389 + deployment: &692 title: Deployment description: A deployment created as the result of an Actions check run from a workflow that references an environment @@ -57045,9 +57411,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#get-a-check-run parameters: - - *312 - - *313 - - &384 + - *319 + - *320 + - &391 name: check_run_id description: The unique identifier of the check run. in: path @@ -57059,9 +57425,9 @@ paths: description: Response content: application/json: - schema: *383 + schema: *390 examples: - default: &385 + default: &392 value: id: 4 head_sha: ce587453ced02b1526dfb4cb910479d431683101 @@ -57161,9 +57527,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#update-a-check-run parameters: - - *312 - - *313 - - *384 + - *319 + - *320 + - *391 requestBody: required: true content: @@ -57403,9 +57769,9 @@ paths: description: Response content: application/json: - schema: *383 + schema: *390 examples: - default: *385 + default: *392 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -57425,9 +57791,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#list-check-run-annotations parameters: - - *312 - - *313 - - *384 + - *319 + - *320 + - *391 - *17 - *18 responses: @@ -57539,15 +57905,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/runs#rerequest-a-check-run parameters: - - *312 - - *313 - - *384 + - *319 + - *320 + - *391 responses: '201': description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -57585,8 +57951,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#create-a-check-suite parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -57608,7 +57974,7 @@ paths: description: Response when the suite already exists content: application/json: - schema: &387 + schema: &394 title: CheckSuite description: A suite of checks performed on the code of a given code change @@ -57690,12 +58056,12 @@ paths: type: - array - 'null' - items: *382 + items: *389 app: anyOf: - type: 'null' - *5 - repository: *156 + repository: *168 created_at: type: - string @@ -57706,7 +58072,7 @@ paths: - string - 'null' format: date-time - head_commit: *386 + head_commit: *393 latest_check_runs_count: type: integer check_runs_url: @@ -57734,7 +58100,7 @@ paths: - check_runs_url - pull_requests examples: - default: &388 + default: &395 value: id: 5 node_id: MDEwOkNoZWNrU3VpdGU1 @@ -58025,9 +58391,9 @@ paths: description: Response when the suite was created content: application/json: - schema: *387 + schema: *394 examples: - default: *388 + default: *395 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58046,8 +58412,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#update-repository-preferences-for-check-suites parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -58108,7 +58474,7 @@ paths: required: - app_id - setting - repository: *156 + repository: *168 examples: default: value: @@ -58356,9 +58722,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#get-a-check-suite parameters: - - *312 - - *313 - - &389 + - *319 + - *320 + - &396 name: check_suite_id description: The unique identifier of the check suite. in: path @@ -58370,9 +58736,9 @@ paths: description: Response content: application/json: - schema: *387 + schema: *394 examples: - default: *388 + default: *395 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58395,17 +58761,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: - - *312 - - *313 - - *389 - - &432 + - *319 + - *320 + - *396 + - &439 name: check_name description: Returns check runs with the specified `name`. in: query required: false schema: type: string - - &433 + - &440 name: status description: Returns check runs with the specified `status`. in: query @@ -58444,9 +58810,9 @@ paths: type: integer check_runs: type: array - items: *383 + items: *390 examples: - default: &434 + default: &441 value: total_count: 1 check_runs: @@ -58548,15 +58914,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/checks/suites#rerequest-a-check-suite parameters: - - *312 - - *313 - - *389 + - *319 + - *320 + - *396 responses: '201': description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -58583,21 +58949,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: - - *312 - - *313 - - *179 - - *180 + - *319 + - *320 + - *191 + - *192 - *18 - *17 - - &401 + - &408 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: *390 - - &402 + schema: *397 + - &409 name: pr description: The number of the pull request for the results you want to list. in: query @@ -58622,13 +58988,13 @@ paths: be returned. in: query required: false - schema: *181 + schema: *193 - name: severity description: If specified, only code scanning alerts with this severity will be returned. in: query required: false - schema: *391 + schema: *398 responses: '200': description: Response @@ -58644,7 +59010,7 @@ paths: updated_at: *88 url: *85 html_url: *86 - instances_url: *392 + instances_url: *399 state: *79 fixed_at: *90 dismissed_by: @@ -58652,11 +59018,11 @@ paths: - type: 'null' - *4 dismissed_at: *89 - dismissed_reason: *393 - dismissed_comment: *394 - rule: *395 - tool: *396 - most_recent_instance: *397 + dismissed_reason: *400 + dismissed_comment: *401 + rule: *402 + tool: *403 + most_recent_instance: *404 required: - number - created_at @@ -58772,14 +59138,14 @@ paths: classifications: [] instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances '304': *35 - '403': &398 + '403': &405 description: Response if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -58799,9 +59165,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: - - *312 - - *313 - - &399 + - *319 + - *320 + - &406 name: alert_number in: path description: The number that identifies an alert. You can find this at the @@ -58815,7 +59181,7 @@ paths: description: Response content: application/json: - schema: &400 + schema: &407 type: object properties: number: *81 @@ -58823,7 +59189,7 @@ paths: updated_at: *88 url: *85 html_url: *86 - instances_url: *392 + instances_url: *399 state: *79 fixed_at: *90 dismissed_by: @@ -58831,8 +59197,8 @@ paths: - type: 'null' - *4 dismissed_at: *89 - dismissed_reason: *393 - dismissed_comment: *394 + dismissed_reason: *400 + dismissed_comment: *401 rule: type: object properties: @@ -58894,8 +59260,8 @@ paths: - 'null' description: A link to the documentation for the rule used to detect the alert. - tool: *396 - most_recent_instance: *397 + tool: *403 + most_recent_instance: *404 required: - number - created_at @@ -58984,9 +59350,9 @@ paths: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances '304': *35 - '403': *398 + '403': *405 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59004,9 +59370,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: - - *312 - - *313 - - *399 + - *319 + - *320 + - *406 requestBody: required: true content: @@ -59021,8 +59387,8 @@ paths: enum: - open - dismissed - dismissed_reason: *393 - dismissed_comment: *394 + dismissed_reason: *400 + dismissed_comment: *401 required: - state examples: @@ -59037,7 +59403,7 @@ paths: description: Response content: application/json: - schema: *400 + schema: *407 examples: default: value: @@ -59112,14 +59478,14 @@ paths: classifications: - test instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances - '403': &407 + '403': &414 description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository content: application/json: schema: *3 '404': *6 - '503': *96 + '503': *108 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -59139,13 +59505,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: - - *312 - - *313 - - *399 + - *319 + - *320 + - *406 - *18 - *17 - - *401 - - *402 + - *408 + - *409 responses: '200': description: Response @@ -59153,7 +59519,7 @@ paths: application/json: schema: type: array - items: *397 + items: *404 examples: default: value: @@ -59192,9 +59558,9 @@ paths: end_column: 50 classifications: - source - '403': *398 + '403': *405 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59226,25 +59592,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: - - *312 - - *313 - - *179 - - *180 + - *319 + - *320 + - *191 + - *192 - *18 - *17 - - *402 + - *409 - 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: *390 + schema: *397 - name: sarif_id in: query description: Filter analyses belonging to the same SARIF upload. required: false - schema: &405 + schema: &412 type: string description: An identifier for the upload. examples: @@ -59266,23 +59632,23 @@ paths: application/json: schema: type: array - items: &406 + items: &413 type: object properties: - ref: *390 - commit_sha: &415 + ref: *397 + commit_sha: &422 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: *403 + analysis_key: *410 environment: type: string description: Identifies the variable values associated with the environment in which this analysis was performed. - category: *404 + category: *411 error: type: string examples: @@ -59307,8 +59673,8 @@ paths: description: The REST API URL of the analysis resource. format: uri readOnly: true - sarif_id: *405 - tool: *396 + sarif_id: *412 + tool: *403 deletable: type: boolean warning: @@ -59370,9 +59736,9 @@ paths: version: 1.2.0 deletable: true warning: '' - '403': *398 + '403': *405 '404': *6 - '503': *96 + '503': *108 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -59406,8 +59772,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: - - *312 - - *313 + - *319 + - *320 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -59420,7 +59786,7 @@ paths: description: Response content: application/json: - schema: *406 + schema: *413 examples: response: summary: application/json response @@ -59474,9 +59840,9 @@ paths: properties: - github/alertNumber: 2 - github/alertUrl: https://api.github.com/repos/monalisa/monalisa/code-scanning/alerts/2 - '403': *398 + '403': *405 '404': *6 - '503': *96 + '503': *108 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -59556,8 +59922,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: - - *312 - - *313 + - *319 + - *320 - name: analysis_id in: path description: The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` @@ -59613,9 +59979,9 @@ paths: next_analysis_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41 confirm_delete_url: https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/41?confirm_delete '400': *14 - '403': *407 + '403': *414 '404': *6 - '503': *96 + '503': *108 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -59635,8 +60001,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -59644,7 +60010,7 @@ paths: application/json: schema: type: array - items: &408 + items: &415 title: CodeQL Database description: A CodeQL database. type: object @@ -59756,9 +60122,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': *398 + '403': *405 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59785,8 +60151,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: - - *312 - - *313 + - *319 + - *320 - name: language in: path description: The language of the CodeQL database. @@ -59798,7 +60164,7 @@ paths: description: Response content: application/json: - schema: *408 + schema: *415 examples: default: value: @@ -59830,11 +60196,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': &439 + '302': &446 description: Found - '403': *398 + '403': *405 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59854,8 +60220,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/code-scanning/code-scanning#delete-a-codeql-database parameters: - - *312 - - *313 + - *319 + - *320 - name: language in: path description: The language of the CodeQL database. @@ -59865,9 +60231,9 @@ paths: responses: '204': description: Response - '403': *407 + '403': *414 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -59893,8 +60259,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -59903,7 +60269,7 @@ paths: type: object additionalProperties: false properties: - language: &409 + language: &416 type: string description: The language targeted by the CodeQL query enum: @@ -59981,7 +60347,7 @@ paths: description: Variant analysis submitted for processing content: application/json: - schema: &413 + schema: &420 title: Variant Analysis description: A run of a CodeQL query against one or more repositories. type: object @@ -59991,7 +60357,7 @@ paths: description: The ID of the variant analysis. controller_repo: *91 actor: *4 - query_language: *409 + query_language: *416 query_pack_url: type: string description: The download url for the query pack. @@ -60039,7 +60405,7 @@ paths: items: type: object properties: - repository: &410 + repository: &417 title: Repository Identifier description: Repository Identifier type: object @@ -60081,7 +60447,7 @@ paths: - private - stargazers_count - updated_at - analysis_status: &414 + analysis_status: &421 type: string description: The new status of the CodeQL variant analysis repository task. @@ -60113,7 +60479,7 @@ paths: from processing. This information is only available to the user that initiated the variant analysis. properties: - access_mismatch_repos: &411 + access_mismatch_repos: &418 type: object properties: repository_count: @@ -60128,7 +60494,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: *410 + items: *417 required: - repository_count - repositories @@ -60151,8 +60517,8 @@ paths: required: - repository_count - repository_full_names - no_codeql_db_repos: *411 - over_limit_repos: *411 + no_codeql_db_repos: *418 + over_limit_repos: *418 required: - access_mismatch_repos - not_found_repos @@ -60168,7 +60534,7 @@ paths: examples: repositories_parameter: summary: Response for a successful variant analysis submission - value: &412 + value: &419 summary: Default response value: id: 1 @@ -60320,17 +60686,17 @@ paths: private: false repository_owners: summary: Response for a successful variant analysis submission - value: *412 + value: *419 repository_lists: summary: Response for a successful variant analysis submission - value: *412 + value: *419 '404': *6 '422': description: Unable to process variant analysis submission content: application/json: schema: *3 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60351,8 +60717,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: - - *312 - - *313 + - *319 + - *320 - name: codeql_variant_analysis_id in: path description: The unique identifier of the variant analysis. @@ -60364,11 +60730,11 @@ paths: description: Response content: application/json: - schema: *413 + schema: *420 examples: - default: *412 + default: *419 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60389,7 +60755,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: - - *312 + - *319 - name: repo in: path description: The name of the controller repository. @@ -60424,7 +60790,7 @@ paths: type: object properties: repository: *91 - analysis_status: *414 + analysis_status: *421 artifact_size_in_bytes: type: integer description: The size of the artifact. This is only available @@ -60528,7 +60894,7 @@ paths: source_location_prefix: "/" artifact_url: https://example.com '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60549,8 +60915,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -60615,9 +60981,9 @@ paths: query_suite: default updated_at: '2023-01-19T11:21:34Z' schedule: weekly - '403': *398 + '403': *405 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60636,8 +61002,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -60695,7 +61061,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -60720,7 +61086,7 @@ paths: value: run_id: 42 run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42 - '403': *407 + '403': *414 '404': *6 '409': description: Response if there is already a validation run in progress with @@ -60728,7 +61094,7 @@ paths: content: application/json: schema: *3 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -60785,8 +61151,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -60794,7 +61160,7 @@ paths: schema: type: object properties: - commit_sha: *415 + commit_sha: *422 ref: type: string description: |- @@ -60854,7 +61220,7 @@ paths: schema: type: object properties: - id: *405 + id: *412 url: type: string description: The REST API URL for checking the status of the upload. @@ -60868,11 +61234,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': *407 + '403': *414 '404': *6 '413': description: Payload Too Large if the sarif field is too large - '503': *96 + '503': *108 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -60891,8 +61257,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: - - *312 - - *313 + - *319 + - *320 - name: sarif_id description: The SARIF ID obtained after uploading. in: path @@ -60940,10 +61306,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': *398 + '403': *405 '404': description: Not Found if the sarif id does not match any upload - '503': *96 + '503': *108 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -60965,8 +61331,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -60990,7 +61356,7 @@ paths: - failed - updating - removed_by_enterprise - configuration: *184 + configuration: *196 examples: default: value: @@ -61019,7 +61385,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': *185 + '204': *197 '304': *35 '403': *27 '404': *6 @@ -61044,8 +61410,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-codeowners-errors parameters: - - *312 - - *313 + - *319 + - *320 - 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 @@ -61173,8 +61539,8 @@ paths: parameters: - *17 - *18 - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -61190,7 +61556,7 @@ paths: type: integer codespaces: type: array - items: *238 + items: *250 examples: default: value: @@ -61488,8 +61854,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#create-a-codespace-in-a-repository parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -61553,22 +61919,22 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '400': *14 '401': *23 '403': *27 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -61592,8 +61958,8 @@ paths: parameters: - *17 - *18 - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -61657,8 +62023,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: - - *312 - - *313 + - *319 + - *320 - name: location description: The location to check for available machines. Assigned by IP if not provided. @@ -61695,9 +62061,9 @@ paths: type: integer machines: type: array - items: *417 + items: *424 examples: - default: &642 + default: &649 value: total_count: 2 machines: @@ -61737,8 +62103,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-default-attributes-for-a-codespace parameters: - - *312 - - *313 + - *319 + - *320 - name: ref description: The branch or commit to check for a default devcontainer path. If not specified, the default branch will be checked. @@ -61825,8 +62191,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: - - *312 - - *313 + - *319 + - *320 - 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 @@ -61874,7 +62240,7 @@ paths: '403': *27 '404': *6 '422': *15 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -61895,8 +62261,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#list-repository-secrets parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -61914,7 +62280,7 @@ paths: type: integer secrets: type: array - items: &421 + items: &428 title: Codespaces Secret description: Set repository secrets for GitHub Codespaces. type: object @@ -61935,7 +62301,7 @@ paths: - created_at - updated_at examples: - default: *418 + default: *425 headers: Link: *37 x-github: @@ -61958,16 +62324,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-public-key parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: *419 + schema: *426 examples: - default: *420 + default: *427 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -61987,17 +62353,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#get-a-repository-secret parameters: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 responses: '200': description: Response content: application/json: - schema: *421 + schema: *428 examples: - default: *422 + default: *429 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -62017,9 +62383,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: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 requestBody: required: true content: @@ -62047,7 +62413,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -62071,9 +62437,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/repository-secrets#delete-a-repository-secret parameters: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 responses: '204': description: Response @@ -62101,8 +62467,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#list-repository-collaborators parameters: - - *312 - - *313 + - *319 + - *320 - name: affiliation description: Filter collaborators returned by their affiliation. `outside` means all outside collaborators of an organization-owned repository. `direct` @@ -62140,7 +62506,7 @@ paths: application/json: schema: type: array - items: &423 + items: &430 title: Collaborator description: Collaborator type: object @@ -62333,9 +62699,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: - - *312 - - *313 - - *178 + - *319 + - *320 + - *190 responses: '204': description: Response if user is a collaborator @@ -62377,9 +62743,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#add-a-repository-collaborator parameters: - - *312 - - *313 - - *178 + - *319 + - *320 + - *190 requestBody: required: false content: @@ -62405,7 +62771,7 @@ paths: description: Response when a new invitation is created content: application/json: - schema: &487 + schema: &494 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -62417,7 +62783,7 @@ paths: format: int64 examples: - 42 - repository: *156 + repository: *168 invitee: anyOf: - type: 'null' @@ -62626,9 +62992,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#remove-a-repository-collaborator parameters: - - *312 - - *313 - - *178 + - *319 + - *320 + - *190 responses: '204': description: No Content when collaborator was removed from the repository. @@ -62657,9 +63023,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/collaborators#get-repository-permissions-for-a-user parameters: - - *312 - - *313 - - *178 + - *319 + - *320 + - *190 responses: '200': description: if user has admin permissions @@ -62679,7 +63045,7 @@ paths: user: anyOf: - type: 'null' - - *423 + - *430 required: - permission - role_name @@ -62733,8 +63099,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -62744,7 +63110,7 @@ paths: application/json: schema: type: array - items: &424 + items: &431 title: Commit Comment description: Commit Comment type: object @@ -62785,8 +63151,8 @@ paths: updated_at: type: string format: date-time - author_association: *103 - reactions: *104 + author_association: *115 + reactions: *116 required: - url - html_url @@ -62802,7 +63168,7 @@ paths: - created_at - updated_at examples: - default: &427 + default: &434 value: - html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -62861,17 +63227,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#get-a-commit-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 responses: '200': description: Response content: application/json: - schema: *424 + schema: *431 examples: - default: &428 + default: &435 value: html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1 url: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -62928,9 +63294,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#update-a-commit-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 requestBody: required: true content: @@ -62952,7 +63318,7 @@ paths: description: Response content: application/json: - schema: *424 + schema: *431 examples: default: value: @@ -63003,9 +63369,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#delete-a-commit-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 responses: '204': description: Response @@ -63026,9 +63392,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-commit-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 - 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. @@ -63054,9 +63420,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *303 + default: *310 headers: Link: *37 '404': *6 @@ -63077,9 +63443,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-commit-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 requestBody: required: true content: @@ -63111,16 +63477,16 @@ paths: description: Reaction exists content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '201': description: Reaction created content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '422': *15 x-github: githubCloudOnly: false @@ -63142,10 +63508,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-commit-comment-reaction parameters: - - *312 - - *313 - - *115 - - *304 + - *319 + - *320 + - *127 + - *311 responses: '204': description: Response @@ -63194,8 +63560,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-commits parameters: - - *312 - - *313 + - *319 + - *320 - name: sha description: 'SHA or branch to start listing commits from. Default: the repository’s default branch (usually `main`).' @@ -63251,9 +63617,9 @@ paths: application/json: schema: type: array - items: *425 + items: *432 examples: - default: &535 + default: &542 value: - url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -63327,7 +63693,7 @@ paths: '500': *80 '400': *14 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63347,9 +63713,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#list-branches-for-head-commit parameters: - - *312 - - *313 - - &426 + - *319 + - *320 + - &433 name: commit_sha description: The SHA of the commit. in: path @@ -63396,7 +63762,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc protected: false '422': *15 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -63421,9 +63787,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#list-commit-comments parameters: - - *312 - - *313 - - *426 + - *319 + - *320 + - *433 - *17 - *18 responses: @@ -63433,9 +63799,9 @@ paths: application/json: schema: type: array - items: *424 + items: *431 examples: - default: *427 + default: *434 headers: Link: *37 x-github: @@ -63463,9 +63829,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/comments#create-a-commit-comment parameters: - - *312 - - *313 - - *426 + - *319 + - *320 + - *433 requestBody: required: true content: @@ -63500,9 +63866,9 @@ paths: description: Response content: application/json: - schema: *424 + schema: *431 examples: - default: *428 + default: *435 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/comments/1 @@ -63530,9 +63896,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: - - *312 - - *313 - - *426 + - *319 + - *320 + - *433 - *17 - *18 responses: @@ -63542,7 +63908,7 @@ paths: application/json: schema: type: array - items: &526 + items: &533 title: Pull Request Simple description: Pull Request Simple type: object @@ -63662,7 +64028,7 @@ paths: milestone: anyOf: - type: 'null' - - *429 + - *436 active_lock_reason: type: - string @@ -63717,7 +64083,7 @@ paths: type: - array - 'null' - items: *234 + items: *246 head: type: object properties: @@ -63761,7 +64127,7 @@ paths: _links: type: object properties: - comments: &430 + comments: &437 title: Link description: Hypermedia Link type: object @@ -63770,13 +64136,13 @@ paths: type: string required: - href - commits: *430 - statuses: *430 - html: *430 - issue: *430 - review_comments: *430 - review_comment: *430 - self: *430 + commits: *437 + statuses: *437 + html: *437 + issue: *437 + review_comments: *437 + review_comment: *437 + self: *437 required: - comments - commits @@ -63786,8 +64152,8 @@ paths: - review_comments - review_comment - self - author_association: *103 - auto_merge: &528 + author_association: *115 + auto_merge: &535 title: Auto merge description: The status of auto merging a pull request. type: @@ -63852,7 +64218,7 @@ paths: - author_association - auto_merge examples: - default: &527 + default: &534 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -64332,7 +64698,7 @@ paths: draft: false headers: Link: *37 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64389,11 +64755,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#get-a-commit parameters: - - *312 - - *313 + - *319 + - *320 - *18 - *17 - - &431 + - &438 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)" @@ -64408,9 +64774,9 @@ paths: description: Response content: application/json: - schema: *425 + schema: *432 examples: - default: &514 + default: &521 value: url: https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e @@ -64497,8 +64863,8 @@ paths: '422': *15 '404': *6 '500': *80 - '503': *96 - '409': *143 + '503': *108 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -64523,11 +64889,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: - - *312 - - *313 - - *431 - - *432 - - *433 + - *319 + - *320 + - *438 + - *439 + - *440 - name: filter description: Filters check runs by their `completed_at` timestamp. `latest` returns the most recent check runs. @@ -64561,9 +64927,9 @@ paths: type: integer check_runs: type: array - items: *383 + items: *390 examples: - default: *434 + default: *441 headers: Link: *37 x-github: @@ -64588,9 +64954,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: - - *312 - - *313 - - *431 + - *319 + - *320 + - *438 - name: app_id description: Filters check suites by GitHub App `id`. in: query @@ -64598,7 +64964,7 @@ paths: schema: type: integer example: 1 - - *432 + - *439 - *17 - *18 responses: @@ -64616,7 +64982,7 @@ paths: type: integer check_suites: type: array - items: *387 + items: *394 examples: default: value: @@ -64816,9 +65182,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: - - *312 - - *313 - - *431 + - *319 + - *320 + - *438 - *17 - *18 responses: @@ -64889,7 +65255,7 @@ paths: type: string total_count: type: integer - repository: *156 + repository: *168 commit_url: type: string format: uri @@ -65020,9 +65386,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#list-commit-statuses-for-a-reference parameters: - - *312 - - *313 - - *431 + - *319 + - *320 + - *438 - *17 - *18 responses: @@ -65032,7 +65398,7 @@ paths: application/json: schema: type: array - items: &590 + items: &597 title: Status description: The status of a commit. type: object @@ -65113,7 +65479,7 @@ paths: site_admin: false headers: Link: *37 - '301': *326 + '301': *333 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65141,8 +65507,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/community#get-community-profile-metrics parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -65175,11 +65541,11 @@ paths: code_of_conduct: anyOf: - type: 'null' - - *435 + - *442 code_of_conduct_file: anyOf: - type: 'null' - - &436 + - &443 title: Community Health File type: object properties: @@ -65195,23 +65561,23 @@ paths: license: anyOf: - type: 'null' - - *117 + - *129 contributing: anyOf: - type: 'null' - - *436 + - *443 readme: anyOf: - type: 'null' - - *436 + - *443 issue_template: anyOf: - type: 'null' - - *436 + - *443 pull_request_template: anyOf: - type: 'null' - - *436 + - *443 required: - code_of_conduct - code_of_conduct_file @@ -65340,8 +65706,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/commits#compare-two-commits parameters: - - *312 - - *313 + - *319 + - *320 - *18 - *17 - name: basehead @@ -65389,8 +65755,8 @@ paths: format: uri examples: - https://github.com/octocat/Hello-World/compare/master...topic.patch - base_commit: *425 - merge_base_commit: *425 + base_commit: *432 + merge_base_commit: *432 status: type: string enum: @@ -65414,10 +65780,10 @@ paths: - 6 commits: type: array - items: *425 + items: *432 files: type: array - items: *437 + items: *444 required: - url - html_url @@ -65661,7 +66027,7 @@ paths: module Test" '404': *6 '500': *80 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -65703,8 +66069,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-repository-content parameters: - - *312 - - *313 + - *319 + - *320 - name: path description: path parameter in: path @@ -65855,7 +66221,7 @@ paths: - type - url examples: - response-if-content-is-a-file: &438 + response-if-content-is-a-file: &445 summary: Response if content is a file value: type: file @@ -65992,7 +66358,7 @@ paths: - size - type - url - - &540 + - &547 title: Content File description: Content File type: object @@ -66210,7 +66576,7 @@ paths: - url - submodule_git_url examples: - response-if-content-is-a-file: *438 + response-if-content-is-a-file: *445 response-if-content-is-a-directory: summary: Response if content is a directory and the application/json media type is requested @@ -66279,7 +66645,7 @@ paths: html: https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9 '404': *6 '403': *27 - '302': *439 + '302': *446 '304': *35 x-github: githubCloudOnly: false @@ -66302,8 +66668,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#create-or-update-file-contents parameters: - - *312 - - *313 + - *319 + - *320 - name: path description: path parameter in: path @@ -66398,7 +66764,7 @@ paths: description: Response content: application/json: - schema: &440 + schema: &447 title: File Commit description: File Commit type: object @@ -66554,7 +66920,7 @@ paths: description: Response content: application/json: - schema: *440 + schema: *447 examples: example-for-creating-a-file: value: @@ -66608,7 +66974,7 @@ paths: schema: oneOf: - *3 - - &469 + - &476 description: Repository rule violation was detected type: object properties: @@ -66629,7 +66995,7 @@ paths: items: type: object properties: - placeholder_id: &582 + placeholder_id: &589 description: The ID of the push protection bypass placeholder. This value is returned on any push protected routes. @@ -66661,8 +67027,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#delete-a-file parameters: - - *312 - - *313 + - *319 + - *320 - name: path description: path parameter in: path @@ -66723,7 +67089,7 @@ paths: description: Response content: application/json: - schema: *440 + schema: *447 examples: default: value: @@ -66757,8 +67123,8 @@ paths: verified_at: '422': *15 '404': *6 - '409': *143 - '503': *96 + '409': *155 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -66778,8 +67144,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-contributors parameters: - - *312 - - *313 + - *319 + - *320 - name: anon description: Set to `1` or `true` to include anonymous contributors in results. in: query @@ -66903,20 +67269,20 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#list-dependabot-alerts-for-a-repository parameters: - - *312 - - *313 - - *198 - - *199 - - *200 - - *201 + - *319 + - *320 + - *210 + - *211 + - *212 + - *213 - 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 - - *202 - - *203 + - *214 + - *215 - *76 - name: page description: "**Closing down notice**. Page number of the results to fetch. @@ -66936,8 +67302,8 @@ paths: default: 30 - *74 - *75 - - *204 - - *205 + - *216 + - *217 responses: '200': description: Response @@ -66945,7 +67311,7 @@ paths: application/json: schema: type: array - items: &443 + items: &450 type: object description: A Dependabot alert. properties: @@ -66980,7 +67346,7 @@ paths: - development - runtime - - security_advisory: *441 + security_advisory: *448 security_vulnerability: *84 url: *85 html_url: *86 @@ -67011,7 +67377,7 @@ paths: dismissal. maxLength: 280 fixed_at: *90 - auto_dismissed_at: *442 + auto_dismissed_at: *449 required: - number - state @@ -67238,9 +67604,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#get-a-dependabot-alert parameters: - - *312 - - *313 - - &444 + - *319 + - *320 + - &451 name: alert_number in: path description: |- @@ -67255,7 +67621,7 @@ paths: description: Response content: application/json: - schema: *443 + schema: *450 examples: default: value: @@ -67365,9 +67731,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/alerts#update-a-dependabot-alert parameters: - - *312 - - *313 - - *444 + - *319 + - *320 + - *451 requestBody: required: true content: @@ -67412,7 +67778,7 @@ paths: description: Response content: application/json: - schema: *443 + schema: *450 examples: default: value: @@ -67518,7 +67884,7 @@ paths: '400': *14 '403': *27 '404': *6 - '409': *143 + '409': *155 '422': *7 x-github: githubCloudOnly: false @@ -67541,8 +67907,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#list-repository-secrets parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -67560,7 +67926,7 @@ paths: type: integer secrets: type: array - items: &447 + items: &454 title: Dependabot Secret description: Set secrets for Dependabot. type: object @@ -67614,16 +67980,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-public-key parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: *445 + schema: *452 examples: - default: *446 + default: *453 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -67643,15 +68009,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#get-a-repository-secret parameters: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 responses: '200': description: Response content: application/json: - schema: *447 + schema: *454 examples: default: value: @@ -67677,9 +68043,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#create-or-update-a-repository-secret parameters: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 requestBody: required: true content: @@ -67707,7 +68073,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -67731,9 +68097,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/dependabot/secrets#delete-a-repository-secret parameters: - - *312 - - *313 - - *166 + - *319 + - *320 + - *178 responses: '204': description: Response @@ -67755,8 +68121,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: - - *312 - - *313 + - *319 + - *320 - 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 @@ -67930,8 +68296,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -68191,8 +68557,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -68275,7 +68641,7 @@ paths: - version - url additionalProperties: false - metadata: &448 + metadata: &455 title: metadata description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -68314,7 +68680,7 @@ paths: examples: - "/src/build/package-lock.json" additionalProperties: false - metadata: *448 + metadata: *455 resolved: type: object description: A collection of resolved package dependencies. @@ -68328,7 +68694,7 @@ paths: pattern: "^pkg" examples: - pkg:/npm/%40actions/http-client@1.0.11 - metadata: *448 + metadata: *455 relationship: type: string description: A notation of whether a dependency is requested @@ -68461,8 +68827,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#list-deployments parameters: - - *312 - - *313 + - *319 + - *320 - name: sha description: The SHA recorded at creation time. in: query @@ -68503,9 +68869,9 @@ paths: application/json: schema: type: array - items: *449 + items: *456 examples: - default: *450 + default: *457 headers: Link: *37 x-github: @@ -68571,8 +68937,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#create-a-deployment parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -68654,7 +69020,7 @@ paths: description: Response content: application/json: - schema: *449 + schema: *456 examples: simple-example: summary: Simple example @@ -68727,9 +69093,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#get-a-deployment parameters: - - *312 - - *313 - - &451 + - *319 + - *320 + - &458 name: deployment_id description: deployment_id parameter in: path @@ -68741,7 +69107,7 @@ paths: description: Response content: application/json: - schema: *449 + schema: *456 examples: default: value: @@ -68806,9 +69172,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/deployments#delete-a-deployment parameters: - - *312 - - *313 - - *451 + - *319 + - *320 + - *458 responses: '204': description: Response @@ -68830,9 +69196,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#list-deployment-statuses parameters: - - *312 - - *313 - - *451 + - *319 + - *320 + - *458 - *17 - *18 responses: @@ -68842,7 +69208,7 @@ paths: application/json: schema: type: array - items: &452 + items: &459 title: Deployment Status description: The status of a deployment. type: object @@ -69006,9 +69372,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#create-a-deployment-status parameters: - - *312 - - *313 - - *451 + - *319 + - *320 + - *458 requestBody: required: true content: @@ -69083,9 +69449,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *459 examples: - default: &453 + default: &460 value: url: https://api.github.com/repos/octocat/example/deployments/42/statuses/1 id: 1 @@ -69141,9 +69507,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/statuses#get-a-deployment-status parameters: - - *312 - - *313 - - *451 + - *319 + - *320 + - *458 - name: status_id in: path required: true @@ -69154,9 +69520,9 @@ paths: description: Response content: application/json: - schema: *452 + schema: *459 examples: - default: *453 + default: *460 '404': *6 x-github: githubCloudOnly: false @@ -69181,8 +69547,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#create-a-repository-dispatch-event parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -69239,8 +69605,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#list-environments parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -69258,7 +69624,7 @@ paths: - 5 environments: type: array - items: &455 + items: &462 title: Environment description: Details of a deployment environment type: object @@ -69320,7 +69686,7 @@ paths: type: string examples: - wait_timer - wait_timer: &457 + wait_timer: &464 type: integer description: The amount of time to delay a job after the job is initially triggered. The time (in minutes) @@ -69362,11 +69728,11 @@ paths: items: type: object properties: - type: *454 + type: *461 reviewer: anyOf: - *4 - - *234 + - *246 required: - id - node_id @@ -69389,7 +69755,7 @@ paths: - id - node_id - type - deployment_branch_policy: &458 + deployment_branch_policy: &465 type: - object - 'null' @@ -69506,9 +69872,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#get-an-environment parameters: - - *312 - - *313 - - &456 + - *319 + - *320 + - &463 name: environment_name in: path required: true @@ -69521,9 +69887,9 @@ paths: description: Response content: application/json: - schema: *455 + schema: *462 examples: - default: &459 + default: &466 value: id: 161088068 node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4 @@ -69607,9 +69973,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#create-or-update-an-environment parameters: - - *312 - - *313 - - *456 + - *319 + - *320 + - *463 requestBody: required: false content: @@ -69619,7 +69985,7 @@ paths: - object - 'null' properties: - wait_timer: *457 + wait_timer: *464 prevent_self_review: type: boolean description: Whether or not a user who created the job is prevented @@ -69638,14 +70004,14 @@ paths: items: type: object properties: - type: *454 + type: *461 id: type: integer description: The id of the user or team who can review the deployment examples: - 4532992 - deployment_branch_policy: *458 + deployment_branch_policy: *465 additionalProperties: false examples: default: @@ -69665,9 +70031,9 @@ paths: description: Response content: application/json: - schema: *455 + schema: *462 examples: - default: *459 + default: *466 '422': description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` @@ -69691,9 +70057,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/environments#delete-an-environment parameters: - - *312 - - *313 - - *456 + - *319 + - *320 + - *463 responses: '204': description: Default response @@ -69718,9 +70084,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#list-deployment-branch-policies parameters: - - *312 - - *313 - - *456 + - *319 + - *320 + - *463 - *17 - *18 responses: @@ -69739,7 +70105,7 @@ paths: - 2 branch_policies: type: array - items: &460 + items: &467 title: Deployment branch policy description: Details of a deployment branch or tag policy. type: object @@ -69800,9 +70166,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#create-a-deployment-branch-policy parameters: - - *312 - - *313 - - *456 + - *319 + - *320 + - *463 requestBody: required: true content: @@ -69850,9 +70216,9 @@ paths: description: Response content: application/json: - schema: *460 + schema: *467 examples: - example-wildcard: &461 + example-wildcard: &468 value: id: 364662 node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI= @@ -69894,10 +70260,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#get-a-deployment-branch-policy parameters: - - *312 - - *313 - - *456 - - &462 + - *319 + - *320 + - *463 + - &469 name: branch_policy_id in: path required: true @@ -69909,9 +70275,9 @@ paths: description: Response content: application/json: - schema: *460 + schema: *467 examples: - default: *461 + default: *468 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69930,10 +70296,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#update-a-deployment-branch-policy parameters: - - *312 - - *313 - - *456 - - *462 + - *319 + - *320 + - *463 + - *469 requestBody: required: true content: @@ -69962,9 +70328,9 @@ paths: description: Response content: application/json: - schema: *460 + schema: *467 examples: - default: *461 + default: *468 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -69983,10 +70349,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deployments/branch-policies#delete-a-deployment-branch-policy parameters: - - *312 - - *313 - - *456 - - *462 + - *319 + - *320 + - *463 + - *469 responses: '204': description: Response @@ -70011,9 +70377,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: - - *456 - - *313 - - *312 + - *463 + - *320 + - *319 responses: '200': description: List of deployment protection rules @@ -70030,7 +70396,7 @@ paths: - 10 custom_deployment_protection_rules: type: array - items: &463 + items: &470 title: Deployment protection rule description: Deployment protection rule type: object @@ -70052,7 +70418,7 @@ paths: for the environment. examples: - true - app: &464 + app: &471 title: Custom deployment protection rule app description: A GitHub App that is providing a custom deployment protection rule. @@ -70155,9 +70521,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: - - *456 - - *313 - - *312 + - *463 + - *320 + - *319 requestBody: content: application/json: @@ -70178,9 +70544,9 @@ paths: description: The enabled custom deployment protection rule content: application/json: - schema: *463 + schema: *470 examples: - default: &465 + default: &472 value: id: 3 node_id: IEH37kRlcGxveW1lbnRTdGF0ddiv @@ -70215,9 +70581,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: - - *456 - - *313 - - *312 + - *463 + - *320 + - *319 - *18 - *17 responses: @@ -70237,7 +70603,7 @@ paths: - 35 available_custom_deployment_protection_rule_integrations: type: array - items: *464 + items: *471 examples: default: value: @@ -70272,10 +70638,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: - - *312 - - *313 - - *456 - - &466 + - *319 + - *320 + - *463 + - &473 name: protection_rule_id description: The unique identifier of the protection rule. in: path @@ -70287,9 +70653,9 @@ paths: description: Response content: application/json: - schema: *463 + schema: *470 examples: - default: *465 + default: *472 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70310,10 +70676,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: - - *456 - - *313 - - *312 - - *466 + - *463 + - *320 + - *319 + - *473 responses: '204': description: Response @@ -70339,9 +70705,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#list-environment-secrets parameters: - - *312 - - *313 - - *456 + - *319 + - *320 + - *463 - *17 - *18 responses: @@ -70359,9 +70725,9 @@ paths: type: integer secrets: type: array - items: *349 + items: *356 examples: - default: *350 + default: *357 headers: Link: *37 x-github: @@ -70386,17 +70752,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-public-key parameters: - - *312 - - *313 - - *456 + - *319 + - *320 + - *463 responses: '200': description: Response content: application/json: - schema: *351 + schema: *358 examples: - default: *352 + default: *359 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70418,18 +70784,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#get-an-environment-secret parameters: - - *312 - - *313 - - *456 - - *166 + - *319 + - *320 + - *463 + - *178 responses: '200': description: Response content: application/json: - schema: *349 + schema: *356 examples: - default: *467 + default: *474 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70451,10 +70817,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#create-or-update-an-environment-secret parameters: - - *312 - - *313 - - *456 - - *166 + - *319 + - *320 + - *463 + - *178 requestBody: required: true content: @@ -70485,7 +70851,7 @@ paths: description: Response when creating a secret content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -70511,10 +70877,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/secrets#delete-an-environment-secret parameters: - - *312 - - *313 - - *456 - - *166 + - *319 + - *320 + - *463 + - *178 responses: '204': description: Default response @@ -70539,10 +70905,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#list-environment-variables parameters: - - *312 - - *313 - - *456 - - *336 + - *319 + - *320 + - *463 + - *343 - *18 responses: '200': @@ -70559,9 +70925,9 @@ paths: type: integer variables: type: array - items: *353 + items: *360 examples: - default: *354 + default: *361 headers: Link: *37 x-github: @@ -70584,9 +70950,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#create-an-environment-variable parameters: - - *312 - - *313 - - *456 + - *319 + - *320 + - *463 requestBody: required: true content: @@ -70613,7 +70979,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -70638,18 +71004,18 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#get-an-environment-variable parameters: - - *312 - - *313 - - *456 - - *169 + - *319 + - *320 + - *463 + - *181 responses: '200': description: Response content: application/json: - schema: *353 + schema: *360 examples: - default: *468 + default: *475 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -70670,10 +71036,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#update-an-environment-variable parameters: - - *312 - - *313 - - *169 - - *456 + - *319 + - *320 + - *181 + - *463 requestBody: required: true content: @@ -70715,10 +71081,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/actions/variables#delete-an-environment-variable parameters: - - *312 - - *313 - - *169 - - *456 + - *319 + - *320 + - *181 + - *463 responses: '204': description: Response @@ -70740,8 +71106,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-repository-events parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -70751,7 +71117,7 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: 200-response: value: @@ -70818,8 +71184,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#list-forks parameters: - - *312 - - *313 + - *319 + - *320 - name: sort description: The sort order. `stargazers` will sort by star count. in: query @@ -70841,7 +71207,7 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: default: value: @@ -70978,8 +71344,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/forks#create-a-fork parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: false content: @@ -71012,9 +71378,9 @@ paths: description: Response content: application/json: - schema: *325 + schema: *332 examples: - default: *327 + default: *334 '400': *14 '422': *15 '403': *27 @@ -71035,8 +71401,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#create-a-blob parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -71087,7 +71453,7 @@ paths: schema: type: string '404': *6 - '409': *143 + '409': *155 '403': *27 '422': description: Validation failed @@ -71095,8 +71461,8 @@ paths: application/json: schema: oneOf: - - *141 - - *469 + - *153 + - *476 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71121,8 +71487,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/blobs#get-a-blob parameters: - - *312 - - *313 + - *319 + - *320 - name: file_sha in: path required: true @@ -71174,7 +71540,7 @@ paths: '404': *6 '422': *15 '403': *27 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71222,8 +71588,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#create-a-commit parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -71332,7 +71698,7 @@ paths: description: Response content: application/json: - schema: &470 + schema: &477 title: Git Commit description: Low-level Git commit operations within a repository type: object @@ -71508,7 +71874,7 @@ paths: type: string '422': *15 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71558,15 +71924,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/commits#get-a-commit-object parameters: - - *312 - - *313 - - *426 + - *319 + - *320 + - *433 responses: '200': description: Response content: application/json: - schema: *470 + schema: *477 examples: default: value: @@ -71597,7 +71963,7 @@ paths: payload: verified_at: '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71622,9 +71988,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#list-matching-references parameters: - - *312 - - *313 - - &471 + - *319 + - *320 + - &478 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. @@ -71641,7 +72007,7 @@ paths: application/json: schema: type: array - items: &472 + items: &479 title: Git Reference description: Git references within a repository type: object @@ -71696,7 +72062,7 @@ paths: url: https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac headers: Link: *37 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71717,17 +72083,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference parameters: - - *312 - - *313 - - *471 + - *319 + - *320 + - *478 responses: '200': description: Response content: application/json: - schema: *472 + schema: *479 examples: - default: &473 + default: &480 value: ref: refs/heads/featureA node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ== @@ -71737,7 +72103,7 @@ paths: sha: aa218f56b14c9653891f9e74264a383fa43fefbd url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71756,8 +72122,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#create-a-reference parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -71786,16 +72152,16 @@ paths: description: Response content: application/json: - schema: *472 + schema: *479 examples: - default: *473 + default: *480 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA schema: type: string '422': *15 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71814,9 +72180,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#update-a-reference parameters: - - *312 - - *313 - - *471 + - *319 + - *320 + - *478 requestBody: required: true content: @@ -71845,11 +72211,11 @@ paths: description: Response content: application/json: - schema: *472 + schema: *479 examples: - default: *473 + default: *480 '422': *15 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71865,14 +72231,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/refs#delete-a-reference parameters: - - *312 - - *313 - - *471 + - *319 + - *320 + - *478 responses: '204': description: Response '422': *15 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -71920,8 +72286,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#create-a-tag-object parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -71988,7 +72354,7 @@ paths: description: Response content: application/json: - schema: &475 + schema: &482 title: Git Tag description: Metadata for a Git tag type: object @@ -72044,7 +72410,7 @@ paths: - sha - type - url - verification: *474 + verification: *481 required: - sha - url @@ -72054,7 +72420,7 @@ paths: - tag - message examples: - default: &476 + default: &483 value: node_id: MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw== tag: v0.0.1 @@ -72081,7 +72447,7 @@ paths: schema: type: string '422': *15 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72127,8 +72493,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/tags#get-a-tag parameters: - - *312 - - *313 + - *319 + - *320 - name: tag_sha in: path required: true @@ -72139,11 +72505,11 @@ paths: description: Response content: application/json: - schema: *475 + schema: *482 examples: - default: *476 + default: *483 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72165,8 +72531,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#create-a-tree parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -72240,7 +72606,7 @@ paths: description: Response content: application/json: - schema: &477 + schema: &484 title: Git Tree description: The hierarchy between files in a Git repository. type: object @@ -72335,7 +72701,7 @@ paths: '422': *15 '404': *6 '403': *27 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72358,8 +72724,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/git/trees#get-a-tree parameters: - - *312 - - *313 + - *319 + - *320 - name: tree_sha description: The SHA1 value or ref (branch or tag) name of the tree. in: path @@ -72382,7 +72748,7 @@ paths: description: Response content: application/json: - schema: *477 + schema: *484 examples: default-response: summary: Default response @@ -72423,7 +72789,7 @@ paths: truncated: false '422': *15 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -72441,8 +72807,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-repository-webhooks parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -72452,7 +72818,7 @@ paths: application/json: schema: type: array - items: &478 + items: &485 title: Webhook description: Webhooks for repositories. type: object @@ -72515,7 +72881,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries - last_response: &716 + last_response: &723 title: Hook Response type: object properties: @@ -72592,8 +72958,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#create-a-repository-webhook parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: false content: @@ -72646,9 +73012,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *485 examples: - default: &479 + default: &486 value: type: Repository id: 12345678 @@ -72696,17 +73062,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#get-a-repository-webhook parameters: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 responses: '200': description: Response content: application/json: - schema: *478 + schema: *485 examples: - default: *479 + default: *486 '404': *6 x-github: githubCloudOnly: false @@ -72726,9 +73092,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#update-a-repository-webhook parameters: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 requestBody: required: true content: @@ -72773,9 +73139,9 @@ paths: description: Response content: application/json: - schema: *478 + schema: *485 examples: - default: *479 + default: *486 '422': *15 '404': *6 x-github: @@ -72796,9 +73162,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#delete-a-repository-webhook parameters: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 responses: '204': description: Response @@ -72822,9 +73188,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: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 responses: '200': description: Response @@ -72851,9 +73217,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: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 requestBody: required: false content: @@ -72897,11 +73263,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#list-deliveries-for-a-repository-webhook parameters: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 - *17 - - *212 + - *224 responses: '200': description: Response @@ -72909,9 +73275,9 @@ paths: application/json: schema: type: array - items: *213 + items: *225 examples: - default: *214 + default: *226 '400': *14 '422': *15 x-github: @@ -72930,18 +73296,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: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 - *16 responses: '200': description: Response content: application/json: - schema: *215 + schema: *227 examples: - default: *216 + default: *228 '400': *14 '422': *15 x-github: @@ -72960,12 +73326,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: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 - *16 responses: - '202': *144 + '202': *156 '400': *14 '422': *15 x-github: @@ -72985,9 +73351,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#ping-a-repository-webhook parameters: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 responses: '204': description: Response @@ -73012,9 +73378,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/webhooks#test-the-push-repository-webhook parameters: - - *312 - - *313 - - *211 + - *319 + - *320 + - *223 responses: '204': description: Response @@ -73072,14 +73438,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-an-import-status parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: &480 + schema: &487 title: Import description: A repository import from an external source. type: object @@ -73186,7 +73552,7 @@ paths: - html_url - authors_url examples: - default: &483 + default: &490 value: vcs: subversion use_lfs: true @@ -73202,7 +73568,7 @@ paths: authors_url: https://api.github.com/repos/octocat/socm/import/authors repository_url: https://api.github.com/repos/octocat/socm '404': *6 - '503': &481 + '503': &488 description: Unavailable due to service under maintenance. content: application/json: @@ -73231,8 +73597,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#start-an-import parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -73280,7 +73646,7 @@ paths: description: Response content: application/json: - schema: *480 + schema: *487 examples: default: value: @@ -73305,7 +73671,7 @@ paths: type: string '422': *15 '404': *6 - '503': *481 + '503': *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73333,8 +73699,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-an-import parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: false content: @@ -73386,7 +73752,7 @@ paths: description: Response content: application/json: - schema: *480 + schema: *487 examples: example-1: summary: Example 1 @@ -73434,7 +73800,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': *481 + '503': *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73457,12 +73823,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#cancel-an-import parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response - '503': *481 + '503': *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73488,9 +73854,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-commit-authors parameters: - - *312 - - *313 - - &665 + - *319 + - *320 + - &672 name: since description: A user ID. Only return users with an ID greater than this ID. in: query @@ -73504,7 +73870,7 @@ paths: application/json: schema: type: array - items: &482 + items: &489 title: Porter Author description: Porter Author type: object @@ -73558,7 +73924,7 @@ paths: url: https://api.github.com/repos/octocat/socm/import/authors/2268559 import_url: https://api.github.com/repos/octocat/socm/import '404': *6 - '503': *481 + '503': *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73583,8 +73949,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#map-a-commit-author parameters: - - *312 - - *313 + - *319 + - *320 - name: author_id in: path required: true @@ -73614,7 +73980,7 @@ paths: description: Response content: application/json: - schema: *482 + schema: *489 examples: default: value: @@ -73627,7 +73993,7 @@ paths: import_url: https://api.github.com/repos/octocat/socm/import '422': *15 '404': *6 - '503': *481 + '503': *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73651,8 +74017,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#get-large-files parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -73693,7 +74059,7 @@ paths: path: foo/bar/3 oid: c20ad4d76fe97759aa27a0c99bff6710 size: 12582912 - '503': *481 + '503': *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73721,8 +74087,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/source-imports#update-git-lfs-preference parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -73749,11 +74115,11 @@ paths: description: Response content: application/json: - schema: *480 + schema: *487 examples: - default: *483 + default: *490 '422': *15 - '503': *481 + '503': *488 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -73776,8 +74142,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -73785,8 +74151,8 @@ paths: application/json: schema: *20 examples: - default: *484 - '301': *326 + default: *491 + '301': *333 '404': *6 x-github: githubCloudOnly: false @@ -73806,8 +74172,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#get-interaction-restrictions-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -73815,12 +74181,12 @@ paths: application/json: schema: anyOf: - - *229 + - *241 - type: object properties: {} additionalProperties: false examples: - default: &486 + default: &493 value: limit: collaborators_only origin: repository @@ -73845,13 +74211,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#set-interaction-restrictions-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: application/json: - schema: *485 + schema: *492 examples: default: summary: Example request body @@ -73863,9 +74229,9 @@ paths: description: Response content: application/json: - schema: *229 + schema: *241 examples: - default: *486 + default: *493 '409': description: Response x-github: @@ -73887,8 +74253,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/interactions/repos#remove-interaction-restrictions-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -73911,8 +74277,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#list-repository-invitations parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -73922,9 +74288,9 @@ paths: application/json: schema: type: array - items: *487 + items: *494 examples: - default: &658 + default: &665 value: - id: 1 repository: @@ -74055,9 +74421,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#update-a-repository-invitation parameters: - - *312 - - *313 - - *233 + - *319 + - *320 + - *245 requestBody: required: false content: @@ -74086,7 +74452,7 @@ paths: description: Response content: application/json: - schema: *487 + schema: *494 examples: default: value: @@ -74217,9 +74583,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#delete-a-repository-invitation parameters: - - *312 - - *313 - - *233 + - *319 + - *320 + - *245 responses: '204': description: Response @@ -74250,8 +74616,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#list-repository-issues parameters: - - *312 - - *313 + - *319 + - *320 - 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 @@ -74291,7 +74657,7 @@ paths: required: false schema: type: string - - *235 + - *247 - name: sort description: What to sort results by. in: query @@ -74304,7 +74670,7 @@ paths: - comments default: created - *76 - - *106 + - *118 - *17 - *18 responses: @@ -74314,9 +74680,9 @@ paths: application/json: schema: type: array - items: *116 + items: *128 examples: - default: &496 + default: &503 value: - id: 1 node_id: MDU6SXNzdWUx @@ -74464,7 +74830,7 @@ paths: state_reason: completed headers: Link: *37 - '301': *326 + '301': *333 '422': *15 '404': *6 x-github: @@ -74493,8 +74859,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#create-an-issue parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -74575,9 +74941,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *128 examples: - default: &491 + default: &498 value: id: 1 node_id: MDU6SXNzdWUx @@ -74731,9 +75097,9 @@ paths: '400': *14 '403': *27 '422': *15 - '503': *96 + '503': *108 '404': *6 - '410': *323 + '410': *330 x-github: triggersNotification: true githubCloudOnly: false @@ -74761,9 +75127,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments-for-a-repository parameters: - - *312 - - *313 - - *125 + - *319 + - *320 + - *137 - name: direction description: Either `asc` or `desc`. Ignored without the `sort` parameter. in: query @@ -74773,7 +75139,7 @@ paths: enum: - asc - desc - - *106 + - *118 - *17 - *18 responses: @@ -74783,9 +75149,9 @@ paths: application/json: schema: type: array - items: *488 + items: *495 examples: - default: &493 + default: &500 value: - id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -74843,17 +75209,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 responses: '200': description: Response content: application/json: - schema: *488 + schema: *495 examples: - default: &489 + default: &496 value: id: 1 node_id: MDEyOklzc3VlQ29tbWVudDE= @@ -74907,9 +75273,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#update-an-issue-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 requestBody: required: true content: @@ -74931,9 +75297,9 @@ paths: description: Response content: application/json: - schema: *488 + schema: *495 examples: - default: *489 + default: *496 '422': *15 x-github: githubCloudOnly: false @@ -74951,9 +75317,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#delete-an-issue-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 responses: '204': description: Response @@ -74973,9 +75339,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 - 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. @@ -75001,9 +75367,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *303 + default: *310 headers: Link: *37 '404': *6 @@ -75024,9 +75390,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue-comment parameters: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 requestBody: required: true content: @@ -75058,16 +75424,16 @@ paths: description: Reaction exists content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '201': description: Reaction created content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '422': *15 x-github: githubCloudOnly: false @@ -75089,10 +75455,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-comment-reaction parameters: - - *312 - - *313 - - *115 - - *304 + - *319 + - *320 + - *127 + - *311 responses: '204': description: Response @@ -75112,8 +75478,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -75123,7 +75489,7 @@ paths: application/json: schema: type: array - items: &490 + items: &497 title: Issue Event description: Issue Event type: object @@ -75170,7 +75536,7 @@ paths: issue: anyOf: - type: 'null' - - *116 + - *128 label: title: Issue Event Label description: Issue Event Label @@ -75203,7 +75569,7 @@ paths: anyOf: - type: 'null' - *4 - requested_team: *234 + requested_team: *246 dismissed_review: title: Issue Event Dismissed Review type: object @@ -75270,7 +75636,7 @@ paths: required: - from - to - author_association: *103 + author_association: *115 lock_reason: type: - string @@ -75462,8 +75828,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#get-an-issue-event parameters: - - *312 - - *313 + - *319 + - *320 - name: event_id in: path required: true @@ -75474,7 +75840,7 @@ paths: description: Response content: application/json: - schema: *490 + schema: *497 examples: default: value: @@ -75667,7 +76033,7 @@ paths: author_association: COLLABORATOR state_reason: completed '404': *6 - '410': *323 + '410': *330 '403': *27 x-github: githubCloudOnly: false @@ -75701,9 +76067,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue parameters: - - *312 - - *313 - - &492 + - *319 + - *320 + - &499 name: issue_number description: The number that identifies the issue. in: path @@ -75715,12 +76081,12 @@ paths: description: Response content: application/json: - schema: *116 + schema: *128 examples: - default: *491 - '301': *326 + default: *498 + '301': *333 '404': *6 - '410': *323 + '410': *330 '304': *35 x-github: githubCloudOnly: false @@ -75745,9 +76111,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#update-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: false content: @@ -75855,15 +76221,15 @@ paths: description: Response content: application/json: - schema: *116 + schema: *128 examples: - default: *491 + default: *498 '422': *15 - '503': *96 + '503': *108 '403': *27 - '301': *326 + '301': *333 '404': *6 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75881,9 +76247,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#add-assignees-to-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: false content: @@ -75909,9 +76275,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *128 examples: - default: *491 + default: *498 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75927,9 +76293,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/assignees#remove-assignees-from-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: content: application/json: @@ -75954,9 +76320,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *128 examples: - default: *491 + default: *498 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -75978,9 +76344,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: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 - name: assignee in: path required: true @@ -76020,10 +76386,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#list-issue-comments parameters: - - *312 - - *313 - - *492 - - *106 + - *319 + - *320 + - *499 + - *118 - *17 - *18 responses: @@ -76033,13 +76399,13 @@ paths: application/json: schema: type: array - items: *488 + items: *495 examples: - default: *493 + default: *500 headers: Link: *37 '404': *6 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76068,9 +76434,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#create-an-issue-comment parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: true content: @@ -76092,16 +76458,16 @@ paths: description: Response content: application/json: - schema: *488 + schema: *495 examples: - default: *489 + default: *496 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/comments/1 schema: type: string '403': *27 - '410': *323 + '410': *330 '422': *15 '404': *6 x-github: @@ -76121,9 +76487,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/events#list-issue-events parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 - *17 - *18 responses: @@ -76137,7 +76503,7 @@ paths: title: Issue Event for Issue description: Issue Event for Issue anyOf: - - &497 + - &504 title: Labeled Issue Event description: Labeled Issue Event type: object @@ -76186,7 +76552,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &498 + - &505 title: Unlabeled Issue Event description: Unlabeled Issue Event type: object @@ -76314,7 +76680,7 @@ paths: - performed_via_github_app - assignee - assigner - - &499 + - &506 title: Milestoned Issue Event description: Milestoned Issue Event type: object @@ -76360,7 +76726,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &500 + - &507 title: Demilestoned Issue Event description: Demilestoned Issue Event type: object @@ -76406,7 +76772,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &501 + - &508 title: Renamed Issue Event description: Renamed Issue Event type: object @@ -76455,7 +76821,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &502 + - &509 title: Review Requested Issue Event description: Review Requested Issue Event type: object @@ -76484,7 +76850,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *234 + requested_team: *246 requested_reviewer: *4 required: - review_requester @@ -76497,7 +76863,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &503 + - &510 title: Review Request Removed Issue Event description: Review Request Removed Issue Event type: object @@ -76526,7 +76892,7 @@ paths: - type: 'null' - *5 review_requester: *4 - requested_team: *234 + requested_team: *246 requested_reviewer: *4 required: - review_requester @@ -76539,7 +76905,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &504 + - &511 title: Review Dismissed Issue Event description: Review Dismissed Issue Event type: object @@ -76595,7 +76961,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &505 + - &512 title: Locked Issue Event description: Locked Issue Event type: object @@ -76640,7 +77006,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &506 + - &513 title: Added to Project Issue Event description: Added to Project Issue Event type: object @@ -76701,7 +77067,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &507 + - &514 title: Moved Column in Project Issue Event description: Moved Column in Project Issue Event type: object @@ -76762,7 +77128,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &508 + - &515 title: Removed from Project Issue Event description: Removed from Project Issue Event type: object @@ -76823,7 +77189,7 @@ paths: - commit_url - created_at - performed_via_github_app - - &509 + - &516 title: Converted Note to Issue Issue Event description: Converted Note to Issue Issue Event type: object @@ -76916,7 +77282,7 @@ paths: color: red headers: Link: *37 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -76933,9 +77299,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 - *17 - *18 responses: @@ -76945,7 +77311,7 @@ paths: application/json: schema: type: array - items: &494 + items: &501 title: Label description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail). @@ -77000,7 +77366,7 @@ paths: - color - default examples: - default: &495 + default: &502 value: - id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -77018,9 +77384,9 @@ paths: default: false headers: Link: *37 - '301': *326 + '301': *333 '404': *6 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77037,9 +77403,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#add-labels-to-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: false content: @@ -77098,12 +77464,12 @@ paths: application/json: schema: type: array - items: *494 + items: *501 examples: - default: *495 - '301': *326 + default: *502 + '301': *333 '404': *6 - '410': *323 + '410': *330 '422': *15 x-github: githubCloudOnly: false @@ -77120,9 +77486,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#set-labels-for-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: false content: @@ -77182,12 +77548,12 @@ paths: application/json: schema: type: array - items: *494 + items: *501 examples: - default: *495 - '301': *326 + default: *502 + '301': *333 '404': *6 - '410': *323 + '410': *330 '422': *15 x-github: githubCloudOnly: false @@ -77204,15 +77570,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-all-labels-from-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 responses: '204': description: Response - '301': *326 + '301': *333 '404': *6 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77231,9 +77597,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#remove-a-label-from-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 - name: name in: path required: true @@ -77246,7 +77612,7 @@ paths: application/json: schema: type: array - items: *494 + items: *501 examples: default: value: @@ -77257,9 +77623,9 @@ paths: description: Something isn't working color: f29513 default: true - '301': *326 + '301': *333 '404': *6 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77279,9 +77645,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#lock-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: false content: @@ -77310,7 +77676,7 @@ paths: '204': description: Response '403': *27 - '410': *323 + '410': *330 '404': *6 '422': *15 x-github: @@ -77328,9 +77694,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#unlock-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 responses: '204': description: Response @@ -77352,9 +77718,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 - 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. @@ -77380,13 +77746,13 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *303 + default: *310 headers: Link: *37 '404': *6 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77404,9 +77770,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: true content: @@ -77438,16 +77804,16 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '201': description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '422': *15 x-github: githubCloudOnly: false @@ -77469,10 +77835,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-an-issue-reaction parameters: - - *312 - - *313 - - *492 - - *304 + - *319 + - *320 + - *499 + - *311 responses: '204': description: Response @@ -77501,9 +77867,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#remove-sub-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: true content: @@ -77525,9 +77891,9 @@ paths: description: Response content: application/json: - schema: *116 + schema: *128 examples: - default: *491 + default: *498 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/1/sub-issue @@ -77560,9 +77926,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#list-sub-issues parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 - *17 - *18 responses: @@ -77572,13 +77938,13 @@ paths: application/json: schema: type: array - items: *116 + items: *128 examples: - default: *496 + default: *503 headers: Link: *37 '404': *6 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -77606,9 +77972,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#add-sub-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: true content: @@ -77634,16 +78000,16 @@ paths: description: Response content: application/json: - schema: *116 + schema: *128 examples: - default: *491 + default: *498 headers: Location: example: https://api.github.com/repos/octocat/Hello-World/issues/sub-issues/1 schema: type: string '403': *27 - '410': *323 + '410': *330 '422': *15 '404': *6 x-github: @@ -77663,9 +78029,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/sub-issues#reprioritize-sub-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 requestBody: required: true content: @@ -77696,13 +78062,13 @@ paths: description: Response content: application/json: - schema: *116 + schema: *128 examples: - default: *491 + default: *498 '403': *27 '404': *6 '422': *7 - '503': *96 + '503': *108 x-github: triggersNotification: true githubCloudOnly: false @@ -77720,9 +78086,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/timeline#list-timeline-events-for-an-issue parameters: - - *312 - - *313 - - *492 + - *319 + - *320 + - *499 - *17 - *18 responses: @@ -77737,19 +78103,19 @@ paths: description: Timeline Event type: object anyOf: - - *497 - - *498 - - *499 - - *500 - - *501 - - *502 - - *503 - *504 - *505 - *506 - *507 - *508 - *509 + - *510 + - *511 + - *512 + - *513 + - *514 + - *515 + - *516 - title: Timeline Comment Event description: Timeline Comment Event type: object @@ -77797,12 +78163,12 @@ paths: issue_url: type: string format: uri - author_association: *103 + author_association: *115 performed_via_github_app: anyOf: - type: 'null' - *5 - reactions: *104 + reactions: *116 required: - event - actor @@ -77833,7 +78199,7 @@ paths: properties: type: type: string - issue: *116 + issue: *128 required: - event - created_at @@ -78049,7 +78415,7 @@ paths: type: string body_text: type: string - author_association: *103 + author_association: *115 required: - event - id @@ -78072,7 +78438,7 @@ paths: type: string comments: type: array - items: &529 + items: &536 title: Pull Request Review Comment description: Pull Request Review Comments are comments on a portion of the Pull Request's diff. @@ -78177,7 +78543,7 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *103 + author_association: *115 _links: type: object properties: @@ -78272,7 +78638,7 @@ paths: enum: - line - file - reactions: *104 + reactions: *116 body_html: type: string examples: @@ -78310,7 +78676,7 @@ paths: type: string comments: type: array - items: *424 + items: *431 - title: Timeline Assigned Issue Event description: Timeline Assigned Issue Event type: object @@ -78585,7 +78951,7 @@ paths: headers: Link: *37 '404': *6 - '410': *323 + '410': *330 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -78602,8 +78968,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#list-deploy-keys parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -78613,7 +78979,7 @@ paths: application/json: schema: type: array - items: &510 + items: &517 title: Deploy Key description: An SSH key granting access to a single repository. type: object @@ -78680,8 +79046,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#create-a-deploy-key parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -78717,9 +79083,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *517 examples: - default: &511 + default: &518 value: id: 1 key: ssh-rsa AAA... @@ -78753,9 +79119,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key parameters: - - *312 - - *313 - - &512 + - *319 + - *320 + - &519 name: key_id description: The unique identifier of the key. in: path @@ -78767,9 +79133,9 @@ paths: description: Response content: application/json: - schema: *510 + schema: *517 examples: - default: *511 + default: *518 '404': *6 x-github: githubCloudOnly: false @@ -78787,9 +79153,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#delete-a-deploy-key parameters: - - *312 - - *313 - - *512 + - *319 + - *320 + - *519 responses: '204': description: Response @@ -78809,8 +79175,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#list-labels-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -78820,9 +79186,9 @@ paths: application/json: schema: type: array - items: *494 + items: *501 examples: - default: *495 + default: *502 headers: Link: *37 '404': *6 @@ -78843,8 +79209,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#create-a-label parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -78880,9 +79246,9 @@ paths: description: Response content: application/json: - schema: *494 + schema: *501 examples: - default: &513 + default: &520 value: id: 208045946 node_id: MDU6TGFiZWwyMDgwNDU5NDY= @@ -78914,8 +79280,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#get-a-label parameters: - - *312 - - *313 + - *319 + - *320 - name: name in: path required: true @@ -78926,9 +79292,9 @@ paths: description: Response content: application/json: - schema: *494 + schema: *501 examples: - default: *513 + default: *520 '404': *6 x-github: githubCloudOnly: false @@ -78945,8 +79311,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#update-a-label parameters: - - *312 - - *313 + - *319 + - *320 - name: name in: path required: true @@ -78985,7 +79351,7 @@ paths: description: Response content: application/json: - schema: *494 + schema: *501 examples: default: value: @@ -79011,8 +79377,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/labels#delete-a-label parameters: - - *312 - - *313 + - *319 + - *320 - name: name in: path required: true @@ -79038,8 +79404,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-languages parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -79075,10 +79441,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#enable-git-lfs-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 responses: - '202': *144 + '202': *156 '403': description: |- We will return a 403 with one of the following messages: @@ -79104,8 +79470,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/lfs#disable-git-lfs-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -79131,9 +79497,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/licenses/licenses#get-the-license-for-a-repository parameters: - - *312 - - *313 - - *401 + - *319 + - *320 + - *408 responses: '200': description: Response @@ -79199,7 +79565,7 @@ paths: license: anyOf: - type: 'null' - - *117 + - *129 required: - _links - git_url @@ -79280,8 +79646,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -79346,8 +79712,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/branches/branches#merge-a-branch parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -79381,9 +79747,9 @@ paths: description: Successful Response (The resulting merge commit) content: application/json: - schema: *425 + schema: *432 examples: - default: *514 + default: *521 '204': description: Response when already merged '404': @@ -79408,8 +79774,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#list-milestones parameters: - - *312 - - *313 + - *319 + - *320 - name: state description: The state of the milestone. Either `open`, `closed`, or `all`. in: query @@ -79450,7 +79816,7 @@ paths: application/json: schema: type: array - items: *429 + items: *436 examples: default: value: @@ -79506,8 +79872,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#create-a-milestone parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -79547,9 +79913,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *436 examples: - default: &515 + default: &522 value: url: https://api.github.com/repos/octocat/Hello-World/milestones/1 html_url: https://github.com/octocat/Hello-World/milestones/v1.0 @@ -79608,9 +79974,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#get-a-milestone parameters: - - *312 - - *313 - - &516 + - *319 + - *320 + - &523 name: milestone_number description: The number that identifies the milestone. in: path @@ -79622,9 +79988,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *436 examples: - default: *515 + default: *522 '404': *6 x-github: githubCloudOnly: false @@ -79641,9 +80007,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#update-a-milestone parameters: - - *312 - - *313 - - *516 + - *319 + - *320 + - *523 requestBody: required: false content: @@ -79681,9 +80047,9 @@ paths: description: Response content: application/json: - schema: *429 + schema: *436 examples: - default: *515 + default: *522 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -79699,9 +80065,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/issues/milestones#delete-a-milestone parameters: - - *312 - - *313 - - *516 + - *319 + - *320 + - *523 responses: '204': description: Response @@ -79722,9 +80088,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: - - *312 - - *313 - - *516 + - *319 + - *320 + - *523 - *17 - *18 responses: @@ -79734,9 +80100,9 @@ paths: application/json: schema: type: array - items: *494 + items: *501 examples: - default: *495 + default: *502 headers: Link: *37 x-github: @@ -79755,12 +80121,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: - - *312 - - *313 - - *517 - - *518 - - *106 - - *519 + - *319 + - *320 + - *524 + - *525 + - *118 + - *526 - *17 - *18 responses: @@ -79770,9 +80136,9 @@ paths: application/json: schema: type: array - items: *128 + items: *140 examples: - default: *520 + default: *527 headers: Link: *37 x-github: @@ -79796,8 +80162,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/notifications#mark-repository-notifications-as-read parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: false content: @@ -79855,14 +80221,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-a-apiname-pages-site parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: &521 + schema: &528 title: GitHub Pages description: The configuration for GitHub Pages for a repository. type: object @@ -80006,7 +80372,7 @@ paths: - custom_404 - public examples: - default: &522 + default: &529 value: url: https://api.github.com/repos/github/developer.github.com/pages status: built @@ -80047,8 +80413,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-apiname-pages-site parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -80103,11 +80469,11 @@ paths: description: Response content: application/json: - schema: *521 + schema: *528 examples: - default: *522 + default: *529 '422': *15 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80128,8 +80494,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -80216,7 +80582,7 @@ paths: description: Response '422': *15 '400': *14 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80237,14 +80603,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#delete-a-apiname-pages-site parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response '422': *15 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80264,8 +80630,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#list-apiname-pages-builds parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -80275,7 +80641,7 @@ paths: application/json: schema: type: array - items: &523 + items: &530 title: Page Build description: Page Build type: object @@ -80367,8 +80733,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#request-a-apiname-pages-build parameters: - - *312 - - *313 + - *319 + - *320 responses: '201': description: Response @@ -80415,16 +80781,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-latest-pages-build parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: *523 + schema: *530 examples: - default: &524 + default: &531 value: url: https://api.github.com/repos/github/developer.github.com/pages/builds/5472601 status: built @@ -80472,8 +80838,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#get-apiname-pages-build parameters: - - *312 - - *313 + - *319 + - *320 - name: build_id in: path required: true @@ -80484,9 +80850,9 @@ paths: description: Response content: application/json: - schema: *523 + schema: *530 examples: - default: *524 + default: *531 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -80506,8 +80872,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#create-a-github-pages-deployment parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -80616,9 +80982,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: - - *312 - - *313 - - &525 + - *319 + - *320 + - &532 name: pages_deployment_id description: The ID of the Pages deployment. You can also give the commit SHA of the deployment. @@ -80676,11 +81042,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pages/pages#cancel-a-github-pages-deployment parameters: - - *312 - - *313 - - *525 + - *319 + - *320 + - *532 responses: - '204': *185 + '204': *197 '404': *6 x-github: githubCloudOnly: false @@ -80705,8 +81071,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -80974,7 +81340,7 @@ paths: description: Empty response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -81001,8 +81367,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Private vulnerability reporting status @@ -81039,10 +81405,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: - - *312 - - *313 + - *319 + - *320 responses: - '204': *185 + '204': *197 '422': *14 x-github: githubCloudOnly: false @@ -81061,10 +81427,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: - - *312 - - *313 + - *319 + - *320 responses: - '204': *185 + '204': *197 '422': *14 x-github: githubCloudOnly: false @@ -81085,8 +81451,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-repository-projects parameters: - - *312 - - *313 + - *319 + - *320 - name: state description: Indicates the state of the projects to return. in: query @@ -81107,7 +81473,7 @@ paths: application/json: schema: type: array - items: *262 + items: *274 examples: default: value: @@ -81147,7 +81513,7 @@ paths: '401': *23 '403': *27 '404': *6 - '410': *323 + '410': *330 '422': *7 x-github: githubCloudOnly: false @@ -81167,8 +81533,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#create-a-repository-project parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -81194,13 +81560,13 @@ paths: description: Response content: application/json: - schema: *262 + schema: *274 examples: - default: *322 + default: *329 '401': *23 '403': *27 '404': *6 - '410': *323 + '410': *330 '422': *7 x-github: githubCloudOnly: false @@ -81220,8 +81586,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -81229,7 +81595,7 @@ paths: application/json: schema: type: array - items: *263 + items: *276 examples: default: value: @@ -81260,8 +81626,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -81273,7 +81639,7 @@ paths: type: array description: A list of custom property names and associated values to apply to the repositories. - items: *263 + items: *276 required: - properties examples: @@ -81323,8 +81689,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests parameters: - - *312 - - *313 + - *319 + - *320 - name: state description: Either `open`, `closed`, or `all` to filter by state. in: query @@ -81384,9 +81750,9 @@ paths: application/json: schema: type: array - items: *526 + items: *533 examples: - default: *527 + default: *534 headers: Link: *37 '304': *35 @@ -81418,8 +81784,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#create-a-pull-request parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -81486,7 +81852,7 @@ paths: description: Response content: application/json: - schema: &531 + schema: &538 type: object title: Pull Request description: Pull requests let you tell others about changes you've @@ -81615,7 +81981,7 @@ paths: milestone: anyOf: - type: 'null' - - *429 + - *436 active_lock_reason: type: - string @@ -81670,7 +82036,7 @@ paths: type: - array - 'null' - items: *247 + items: *259 head: type: object properties: @@ -81708,14 +82074,14 @@ paths: _links: type: object properties: - comments: *430 - commits: *430 - statuses: *430 - html: *430 - issue: *430 - review_comments: *430 - review_comment: *430 - self: *430 + comments: *437 + commits: *437 + statuses: *437 + html: *437 + issue: *437 + review_comments: *437 + review_comment: *437 + self: *437 required: - comments - commits @@ -81725,8 +82091,8 @@ paths: - review_comments - review_comment - self - author_association: *103 - auto_merge: *528 + author_association: *115 + auto_merge: *535 draft: description: Indicates whether or not the pull request is a draft. type: boolean @@ -81828,7 +82194,7 @@ paths: - merged_by - review_comments examples: - default: &532 + default: &539 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: 1 @@ -82355,8 +82721,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/comments#list-review-comments-in-a-repository parameters: - - *312 - - *313 + - *319 + - *320 - name: sort in: query required: false @@ -82375,7 +82741,7 @@ paths: enum: - asc - desc - - *106 + - *118 - *17 - *18 responses: @@ -82385,9 +82751,9 @@ paths: application/json: schema: type: array - items: *529 + items: *536 examples: - default: &534 + default: &541 value: - url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -82464,17 +82830,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: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 responses: '200': description: Response content: application/json: - schema: *529 + schema: *536 examples: - default: &530 + default: &537 value: url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1 pull_request_review_id: 42 @@ -82549,9 +82915,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: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 requestBody: required: true content: @@ -82573,9 +82939,9 @@ paths: description: Response content: application/json: - schema: *529 + schema: *536 examples: - default: *530 + default: *537 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82591,9 +82957,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: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 responses: '204': description: Response @@ -82614,9 +82980,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: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 - 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. @@ -82642,9 +83008,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *303 + default: *310 headers: Link: *37 '404': *6 @@ -82665,9 +83031,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: - - *312 - - *313 - - *115 + - *319 + - *320 + - *127 requestBody: required: true content: @@ -82699,16 +83065,16 @@ paths: description: Reaction exists content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '201': description: Reaction created content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '422': *15 x-github: githubCloudOnly: false @@ -82730,10 +83096,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-pull-request-comment-reaction parameters: - - *312 - - *313 - - *115 - - *304 + - *319 + - *320 + - *127 + - *311 responses: '204': description: Response @@ -82776,9 +83142,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#get-a-pull-request parameters: - - *312 - - *313 - - &533 + - *319 + - *320 + - &540 name: pull_number description: The number that identifies the pull request. in: path @@ -82791,9 +83157,9 @@ paths: to fetch diff and patch formats. content: application/json: - schema: *531 + schema: *538 examples: - default: *532 + default: *539 '304': *35 '404': *6 '406': @@ -82802,7 +83168,7 @@ paths: application/json: schema: *3 '500': *80 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -82828,9 +83194,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request parameters: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 requestBody: required: false content: @@ -82872,9 +83238,9 @@ paths: description: Response content: application/json: - schema: *531 + schema: *538 examples: - default: *532 + default: *539 '422': *15 '403': *27 x-github: @@ -82896,9 +83262,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: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 requestBody: required: true content: @@ -82959,21 +83325,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '401': *23 '403': *27 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -82999,10 +83365,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: - - *312 - - *313 - - *533 - - *125 + - *319 + - *320 + - *540 + - *137 - name: direction description: The direction to sort results. Ignored without `sort` parameter. in: query @@ -83012,7 +83378,7 @@ paths: enum: - asc - desc - - *106 + - *118 - *17 - *18 responses: @@ -83022,9 +83388,9 @@ paths: application/json: schema: type: array - items: *529 + items: *536 examples: - default: *534 + default: *541 headers: Link: *37 x-github: @@ -83057,9 +83423,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: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 requestBody: required: true content: @@ -83165,7 +83531,7 @@ paths: description: Response content: application/json: - schema: *529 + schema: *536 examples: example-for-a-multi-line-comment: value: @@ -83253,10 +83619,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: - - *312 - - *313 - - *533 - - *115 + - *319 + - *320 + - *540 + - *127 requestBody: required: true content: @@ -83278,7 +83644,7 @@ paths: description: Response content: application/json: - schema: *529 + schema: *536 examples: default: value: @@ -83364,9 +83730,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-commits-on-a-pull-request parameters: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 - *17 - *18 responses: @@ -83376,9 +83742,9 @@ paths: application/json: schema: type: array - items: *425 + items: *432 examples: - default: *535 + default: *542 headers: Link: *37 x-github: @@ -83408,9 +83774,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#list-pull-requests-files parameters: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 - *17 - *18 responses: @@ -83420,7 +83786,7 @@ paths: application/json: schema: type: array - items: *437 + items: *444 examples: default: value: @@ -83439,7 +83805,7 @@ paths: Link: *37 '422': *15 '500': *80 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -83458,9 +83824,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: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 responses: '204': description: Response if pull request has been merged @@ -83483,9 +83849,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#merge-a-pull-request parameters: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 requestBody: required: false content: @@ -83597,9 +83963,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: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 responses: '200': description: Response @@ -83615,7 +83981,7 @@ paths: items: *4 teams: type: array - items: *234 + items: *246 required: - users - teams @@ -83674,9 +84040,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: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 requestBody: required: false content: @@ -83713,7 +84079,7 @@ paths: description: Response content: application/json: - schema: *526 + schema: *533 examples: default: value: @@ -84249,9 +84615,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: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 requestBody: required: true content: @@ -84285,7 +84651,7 @@ paths: description: Response content: application/json: - schema: *526 + schema: *533 examples: default: value: @@ -84790,9 +85156,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/reviews#list-reviews-for-a-pull-request parameters: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 - *17 - *18 responses: @@ -84802,7 +85168,7 @@ paths: application/json: schema: type: array - items: &536 + items: &543 title: Pull Request Review description: Pull Request Reviews are reviews on pull requests. type: object @@ -84876,7 +85242,7 @@ paths: type: string body_text: type: string - author_association: *103 + author_association: *115 required: - id - node_id @@ -84958,9 +85324,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: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 requestBody: required: false content: @@ -85050,9 +85416,9 @@ paths: description: Response content: application/json: - schema: *536 + schema: *543 examples: - default: &538 + default: &545 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -85115,10 +85481,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: - - *312 - - *313 - - *533 - - &537 + - *319 + - *320 + - *540 + - &544 name: review_id description: The unique identifier of the review. in: path @@ -85130,9 +85496,9 @@ paths: description: Response content: application/json: - schema: *536 + schema: *543 examples: - default: &539 + default: &546 value: id: 80 node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA= @@ -85191,10 +85557,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: - - *312 - - *313 - - *533 - - *537 + - *319 + - *320 + - *540 + - *544 requestBody: required: true content: @@ -85217,7 +85583,7 @@ paths: description: Response content: application/json: - schema: *536 + schema: *543 examples: default: value: @@ -85279,18 +85645,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: - - *312 - - *313 - - *533 - - *537 + - *319 + - *320 + - *540 + - *544 responses: '200': description: Response content: application/json: - schema: *536 + schema: *543 examples: - default: *538 + default: *545 '422': *7 '404': *6 x-github: @@ -85317,10 +85683,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: - - *312 - - *313 - - *533 - - *537 + - *319 + - *320 + - *540 + - *544 - *17 - *18 responses: @@ -85414,13 +85780,13 @@ paths: format: uri examples: - https://api.github.com/repos/octocat/Hello-World/pulls/1 - author_association: *103 + author_association: *115 _links: type: object properties: - self: *430 - html: *430 - pull_request: *430 + self: *437 + html: *437 + pull_request: *437 required: - self - html @@ -85429,7 +85795,7 @@ paths: type: string body_html: type: string - reactions: *104 + reactions: *116 side: description: The side of the first line of the range for a multi-line comment. @@ -85571,10 +85937,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: - - *312 - - *313 - - *533 - - *537 + - *319 + - *320 + - *540 + - *544 requestBody: required: true content: @@ -85603,7 +85969,7 @@ paths: description: Response content: application/json: - schema: *536 + schema: *543 examples: default: value: @@ -85666,10 +86032,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: - - *312 - - *313 - - *533 - - *537 + - *319 + - *320 + - *540 + - *544 requestBody: required: true content: @@ -85704,9 +86070,9 @@ paths: description: Response content: application/json: - schema: *536 + schema: *543 examples: - default: *539 + default: *546 '404': *6 '422': *7 '403': *27 @@ -85728,9 +86094,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/pulls/pulls#update-a-pull-request-branch parameters: - - *312 - - *313 - - *533 + - *319 + - *320 + - *540 requestBody: required: false content: @@ -85794,8 +86160,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#get-a-repository-readme parameters: - - *312 - - *313 + - *319 + - *320 - name: ref description: 'The name of the commit/branch/tag. Default: the repository’s default branch.' @@ -85808,9 +86174,9 @@ paths: description: Response content: application/json: - schema: *540 + schema: *547 examples: - default: &541 + default: &548 value: type: file encoding: base64 @@ -85852,8 +86218,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: - - *312 - - *313 + - *319 + - *320 - name: dir description: The alternate path to look for a README file in: path @@ -85873,9 +86239,9 @@ paths: description: Response content: application/json: - schema: *540 + schema: *547 examples: - default: *541 + default: *548 '404': *6 '422': *15 x-github: @@ -85897,8 +86263,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#list-releases parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -85908,7 +86274,7 @@ paths: application/json: schema: type: array - items: &542 + items: &549 title: Release description: A release. type: object @@ -85980,7 +86346,7 @@ paths: author: *4 assets: type: array - items: &543 + items: &550 title: Release Asset description: Data related to a release. type: object @@ -86050,7 +86416,7 @@ paths: description: The URL of the release discussion. type: string format: uri - reactions: *104 + reactions: *116 required: - assets_url - upload_url @@ -86160,8 +86526,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#create-a-release parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -86237,9 +86603,9 @@ paths: description: Response content: application/json: - schema: *542 + schema: *549 examples: - default: &546 + default: &553 value: url: https://api.github.com/repos/octocat/Hello-World/releases/1 html_url: https://github.com/octocat/Hello-World/releases/v1.0.0 @@ -86342,9 +86708,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#get-a-release-asset parameters: - - *312 - - *313 - - &544 + - *319 + - *320 + - &551 name: asset_id description: The unique identifier of the asset. in: path @@ -86356,9 +86722,9 @@ paths: description: Response content: application/json: - schema: *543 + schema: *550 examples: - default: &545 + default: &552 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 @@ -86392,7 +86758,7 @@ paths: type: User site_admin: false '404': *6 - '302': *439 + '302': *446 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86408,9 +86774,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#update-a-release-asset parameters: - - *312 - - *313 - - *544 + - *319 + - *320 + - *551 requestBody: required: false content: @@ -86439,9 +86805,9 @@ paths: description: Response content: application/json: - schema: *543 + schema: *550 examples: - default: *545 + default: *552 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86457,9 +86823,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#delete-a-release-asset parameters: - - *312 - - *313 - - *544 + - *319 + - *320 + - *551 responses: '204': description: Response @@ -86483,8 +86849,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -86570,16 +86936,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-the-latest-release parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response content: application/json: - schema: *542 + schema: *549 examples: - default: *546 + default: *553 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -86596,8 +86962,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release-by-tag-name parameters: - - *312 - - *313 + - *319 + - *320 - name: tag description: tag parameter in: path @@ -86610,9 +86976,9 @@ paths: description: Response content: application/json: - schema: *542 + schema: *549 examples: - default: *546 + default: *553 '404': *6 x-github: githubCloudOnly: false @@ -86634,9 +87000,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#get-a-release parameters: - - *312 - - *313 - - &547 + - *319 + - *320 + - &554 name: release_id description: The unique identifier of the release. in: path @@ -86650,9 +87016,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: *542 + schema: *549 examples: - default: *546 + default: *553 '401': description: Unauthorized x-github: @@ -86670,9 +87036,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#update-a-release parameters: - - *312 - - *313 - - *547 + - *319 + - *320 + - *554 requestBody: required: false content: @@ -86736,9 +87102,9 @@ paths: description: Response content: application/json: - schema: *542 + schema: *549 examples: - default: *546 + default: *553 '404': description: Not Found if the discussion category name is invalid content: @@ -86759,9 +87125,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/releases#delete-a-release parameters: - - *312 - - *313 - - *547 + - *319 + - *320 + - *554 responses: '204': description: Response @@ -86781,9 +87147,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/releases/assets#list-release-assets parameters: - - *312 - - *313 - - *547 + - *319 + - *320 + - *554 - *17 - *18 responses: @@ -86793,7 +87159,7 @@ paths: application/json: schema: type: array - items: *543 + items: *550 examples: default: value: @@ -86874,9 +87240,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: - - *312 - - *313 - - *547 + - *319 + - *320 + - *554 - name: name in: query required: true @@ -86902,7 +87268,7 @@ paths: description: Response for successful upload content: application/json: - schema: *543 + schema: *550 examples: response-for-successful-upload: value: @@ -86956,9 +87322,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#list-reactions-for-a-release parameters: - - *312 - - *313 - - *547 + - *319 + - *320 + - *554 - 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. @@ -86982,9 +87348,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *303 + default: *310 headers: Link: *37 '404': *6 @@ -87005,9 +87371,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#create-reaction-for-a-release parameters: - - *312 - - *313 - - *547 + - *319 + - *320 + - *554 requestBody: required: true content: @@ -87037,16 +87403,16 @@ paths: description: Reaction exists content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '201': description: Reaction created content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 '422': *15 x-github: githubCloudOnly: false @@ -87068,10 +87434,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/reactions/reactions#delete-a-release-reaction parameters: - - *312 - - *313 - - *547 - - *304 + - *319 + - *320 + - *554 + - *311 responses: '204': description: Response @@ -87095,9 +87461,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rules#get-rules-for-a-branch parameters: - - *312 - - *313 - - *371 + - *319 + - *320 + - *378 - *17 - *18 responses: @@ -87113,8 +87479,8 @@ paths: description: A repository rule with ruleset details. oneOf: - allOf: - - *548 - - &550 + - *555 + - &557 title: repository ruleset data for rule description: User-defined metadata to store domain-specific information limited to 8 keys with scalar values. @@ -87133,54 +87499,54 @@ paths: ruleset_id: type: integer description: The ID of the ruleset that includes this rule. - - allOf: - - *549 - - *550 - - allOf: - - *551 - - *550 - - allOf: - - *552 - - *550 - - allOf: - - *553 - - *550 - - allOf: - - *554 - - *550 - - allOf: - - *555 - - *550 - allOf: - *556 - - *550 - - allOf: - *557 - - *550 - allOf: - *558 - - *550 + - *557 - allOf: - *559 - - *550 + - *557 - allOf: - *560 - - *550 + - *557 - allOf: - *561 - - *550 + - *557 - allOf: - *562 - - *550 + - *557 - allOf: - *563 - - *550 + - *557 - allOf: - *564 - - *550 + - *557 - allOf: - *565 - - *550 + - *557 + - allOf: + - *566 + - *557 + - allOf: + - *567 + - *557 + - allOf: + - *568 + - *557 + - allOf: + - *569 + - *557 + - allOf: + - *570 + - *557 + - allOf: + - *571 + - *557 + - allOf: + - *572 + - *557 examples: default: value: @@ -87219,8 +87585,8 @@ paths: category: repos subcategory: rules parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 - name: includes_parents @@ -87231,7 +87597,7 @@ paths: schema: type: boolean default: true - - *566 + - *573 responses: '200': description: Response @@ -87239,7 +87605,7 @@ paths: application/json: schema: type: array - items: *273 + items: *105 examples: default: value: @@ -87286,8 +87652,8 @@ paths: category: repos subcategory: rules parameters: - - *312 - - *313 + - *319 + - *320 requestBody: description: Request body required: true @@ -87307,16 +87673,16 @@ paths: - tag - push default: branch - enforcement: *269 + enforcement: *102 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *270 - conditions: *267 + items: *103 + conditions: *98 rules: type: array description: An array of rules within the ruleset. - items: *272 + items: *104 required: - name - enforcement @@ -87347,9 +87713,9 @@ paths: description: Response content: application/json: - schema: *273 + schema: *105 examples: - default: &576 + default: &583 value: id: 42 name: super cool ruleset @@ -87396,12 +87762,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#list-repository-rule-suites parameters: - - *312 - - *313 - - *567 - - *568 - - *569 - - *570 + - *319 + - *320 + - *574 + - *575 + - *576 + - *577 - *17 - *18 responses: @@ -87409,9 +87775,9 @@ paths: description: Response content: application/json: - schema: *571 + schema: *578 examples: - default: *572 + default: *579 '404': *6 '500': *80 x-github: @@ -87432,17 +87798,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/rule-suites#get-a-repository-rule-suite parameters: - - *312 - - *313 - - *573 + - *319 + - *320 + - *580 responses: '200': description: Response content: application/json: - schema: *574 + schema: *581 examples: - default: *575 + default: *582 '404': *6 '500': *80 x-github: @@ -87470,8 +87836,8 @@ paths: category: repos subcategory: rules parameters: - - *312 - - *313 + - *319 + - *320 - name: ruleset_id description: The ID of the ruleset. in: path @@ -87491,9 +87857,9 @@ paths: description: Response content: application/json: - schema: *273 + schema: *105 examples: - default: *576 + default: *583 '404': *6 '500': *80 put: @@ -87511,8 +87877,8 @@ paths: category: repos subcategory: rules parameters: - - *312 - - *313 + - *319 + - *320 - name: ruleset_id description: The ID of the ruleset. in: path @@ -87537,16 +87903,16 @@ paths: - branch - tag - push - enforcement: *269 + enforcement: *102 bypass_actors: type: array description: The actors that can bypass the rules in this ruleset - items: *270 - conditions: *267 + items: *103 + conditions: *98 rules: description: An array of rules within the ruleset. type: array - items: *272 + items: *104 examples: default: value: @@ -87574,9 +87940,9 @@ paths: description: Response content: application/json: - schema: *273 + schema: *105 examples: - default: *576 + default: *583 '404': *6 '500': *80 delete: @@ -87594,8 +87960,8 @@ paths: category: repos subcategory: rules parameters: - - *312 - - *313 + - *319 + - *320 - name: ruleset_id description: The ID of the ruleset. in: path @@ -87623,20 +87989,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: - - *312 - - *313 - - *275 - - *276 - - *277 - - *278 + - *319 + - *320 + - *282 + - *283 + - *284 + - *285 - *76 - *18 - *17 - - *577 - - *578 - - *279 - - *280 - - *281 + - *584 + - *585 + - *286 + - *287 + - *288 responses: '200': description: Response @@ -87644,7 +88010,7 @@ paths: application/json: schema: type: array - items: &581 + items: &588 type: object properties: number: *81 @@ -87660,8 +88026,8 @@ paths: format: uri description: The REST API URL of the code locations for this alert. - state: *579 - resolution: *580 + state: *586 + resolution: *587 resolved_at: type: - string @@ -87710,6 +88076,12 @@ paths: anyOf: - type: 'null' - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. push_protection_bypass_request_comment: type: - string @@ -87813,6 +88185,7 @@ paths: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true + push_protection_bypass_request_reviewer_comment: Example response push_protection_bypass_request_comment: Example comment push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment @@ -87835,6 +88208,7 @@ paths: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -87844,7 +88218,7 @@ paths: '404': description: Repository is public or secret scanning is disabled for the repository - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87866,15 +88240,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: - - *312 - - *313 - - *399 + - *319 + - *320 + - *406 responses: '200': description: Response content: application/json: - schema: *581 + schema: *588 examples: default: value: @@ -87894,6 +88268,7 @@ paths: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -87904,7 +88279,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -87925,9 +88300,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: - - *312 - - *313 - - *399 + - *319 + - *320 + - *406 requestBody: required: true content: @@ -87935,8 +88310,8 @@ paths: schema: type: object properties: - state: *579 - resolution: *580 + state: *586 + resolution: *587 resolution_comment: description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`. @@ -87955,7 +88330,7 @@ paths: description: Response content: application/json: - schema: *581 + schema: *588 examples: default: value: @@ -87993,6 +88368,7 @@ paths: push_protection_bypassed_by: push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: Example comment @@ -88007,7 +88383,7 @@ paths: repository, or the resource is not found '422': description: State does not match the resolution or resolution comment - '503': *96 + '503': *108 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -88029,9 +88405,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: - - *312 - - *313 - - *399 + - *319 + - *320 + - *406 - *18 - *17 responses: @@ -88042,7 +88418,7 @@ paths: schema: type: array description: List of locations where the secret was detected - items: &737 + items: &744 type: object properties: type: @@ -88399,7 +88775,7 @@ paths: '404': description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -88421,8 +88797,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -88430,14 +88806,14 @@ paths: schema: type: object properties: - reason: &583 + reason: &590 description: The reason for bypassing push protection. type: string enum: - false_positive - used_in_tests - will_fix_later - placeholder_id: *582 + placeholder_id: *589 required: - reason - placeholder_id @@ -88454,7 +88830,7 @@ paths: schema: type: object properties: - reason: *583 + reason: *590 expire_at: type: - string @@ -88478,7 +88854,7 @@ paths: this repository. '422': description: Bad request, input data missing or incorrect. - '503': *96 + '503': *108 x-github: enabledForGitHubApps: true githubCloudOnly: false @@ -88498,13 +88874,13 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/secret-scanning/secret-scanning#get-secret-scanning-scan-history-for-a-repository parameters: - - *312 - - *313 + - *319 + - *320 responses: '404': description: Repository does not have GitHub Advanced Security or secret scanning enabled - '503': *96 + '503': *108 '200': description: Response content: @@ -88514,7 +88890,7 @@ paths: properties: incremental_scans: type: array - items: &584 + items: &591 description: Information on a single scan performed by secret scanning on the repository type: object @@ -88542,15 +88918,15 @@ paths: the scan is pending pattern_update_scans: type: array - items: *584 + items: *591 backfill_scans: type: array - items: *584 + items: *591 custom_pattern_backfill_scans: type: array items: allOf: - - *584 + - *591 - type: object properties: pattern_name: @@ -88620,8 +88996,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/security-advisories/repository-advisories#list-repository-security-advisories parameters: - - *312 - - *313 + - *319 + - *320 - *76 - name: sort description: The property to sort the results by. @@ -88665,9 +89041,9 @@ paths: application/json: schema: type: array - items: *585 + items: *592 examples: - default: *586 + default: *593 '400': *14 '404': *6 x-github: @@ -88690,8 +89066,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -88771,7 +89147,7 @@ paths: login: type: string description: The username of the user credited. - type: *284 + type: *291 required: - login - type @@ -88861,9 +89237,9 @@ paths: description: Response content: application/json: - schema: *585 + schema: *592 examples: - default: &588 + default: &595 value: ghsa_id: GHSA-abcd-1234-efgh cve_id: CVE-2050-00000 @@ -89096,8 +89472,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -89210,7 +89586,7 @@ paths: description: Response content: application/json: - schema: *585 + schema: *592 examples: default: value: @@ -89357,17 +89733,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: - - *312 - - *313 - - *587 + - *319 + - *320 + - *594 responses: '200': description: Response content: application/json: - schema: *585 + schema: *592 examples: - default: *588 + default: *595 '403': *27 '404': *6 x-github: @@ -89391,9 +89767,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: - - *312 - - *313 - - *587 + - *319 + - *320 + - *594 requestBody: required: true content: @@ -89473,7 +89849,7 @@ paths: login: type: string description: The username of the user credited. - type: *284 + type: *291 required: - login - type @@ -89564,17 +89940,17 @@ paths: description: Response content: application/json: - schema: *585 + schema: *592 examples: - default: *588 - add_credit: *588 + default: *595 + add_credit: *595 '403': *27 '404': *6 '422': description: Validation failed, or the endpoint has been spammed. content: application/json: - schema: *141 + schema: *153 examples: invalid_state_transition: value: @@ -89605,11 +89981,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: - - *312 - - *313 - - *587 + - *319 + - *320 + - *594 responses: - '202': *144 + '202': *156 '400': *14 '403': *27 '404': *6 @@ -89634,17 +90010,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: - - *312 - - *313 - - *587 + - *319 + - *320 + - *594 responses: '202': description: Response content: application/json: - schema: *325 + schema: *332 examples: - default: *327 + default: *334 '400': *14 '422': *15 '403': *27 @@ -89670,8 +90046,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-stargazers parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -89767,8 +90143,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-activity parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Returns a weekly aggregate of the number of additions and deletions @@ -89777,7 +90153,7 @@ paths: application/json: schema: type: array - items: &589 + items: &596 title: Code Frequency Stat description: Code Frequency Stat type: array @@ -89789,8 +90165,8 @@ paths: - - 1302998400 - 1124 - -435 - '202': *144 - '204': *185 + '202': *156 + '204': *197 '422': description: Repository contains more than 10,000 commits x-github: @@ -89810,8 +90186,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -89861,8 +90237,8 @@ paths: - 0 total: 89 week: 1336280400 - '202': *144 - '204': *185 + '202': *156 + '204': *197 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89889,8 +90265,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-all-contributor-commit-activity parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -89961,8 +90337,8 @@ paths: a: 6898 d: 77 c: 10 - '202': *144 - '204': *185 + '202': *156 + '204': *197 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -89984,8 +90360,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/statistics#get-the-weekly-commit-count parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: The array order is oldest week (index 0) to most recent week. @@ -90139,8 +90515,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: For example, `[2, 14, 25]` indicates that there were 25 total @@ -90150,7 +90526,7 @@ paths: application/json: schema: type: array - items: *589 + items: *596 examples: default: value: @@ -90163,7 +90539,7 @@ paths: - - 0 - 2 - 21 - '204': *185 + '204': *197 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -90183,8 +90559,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/commits/statuses#create-a-commit-status parameters: - - *312 - - *313 + - *319 + - *320 - name: sha in: path required: true @@ -90240,7 +90616,7 @@ paths: description: Response content: application/json: - schema: *590 + schema: *597 examples: default: value: @@ -90294,8 +90670,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-watchers parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -90307,7 +90683,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 x-github: @@ -90327,14 +90703,14 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#get-a-repository-subscription parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: if you subscribe to the repository content: application/json: - schema: &591 + schema: &598 title: Repository Invitation description: Repository invitations let you manage who you collaborate with. @@ -90407,8 +90783,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#set-a-repository-subscription parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: false content: @@ -90434,7 +90810,7 @@ paths: description: Response content: application/json: - schema: *591 + schema: *598 examples: default: value: @@ -90461,8 +90837,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#delete-a-repository-subscription parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -90482,8 +90858,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-tags parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -90565,8 +90941,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: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -90574,7 +90950,7 @@ paths: application/json: schema: type: array - items: &592 + items: &599 title: Tag protection description: Tag protection type: object @@ -90631,8 +91007,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: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -90655,7 +91031,7 @@ paths: description: Response content: application/json: - schema: *592 + schema: *599 examples: default: value: @@ -90686,8 +91062,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: - - *312 - - *313 + - *319 + - *320 - name: tag_protection_id description: The unique identifier of the tag protection. in: path @@ -90724,8 +91100,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-tar operationId: repos/download-tarball-archive parameters: - - *312 - - *313 + - *319 + - *320 - name: ref in: path required: true @@ -90761,8 +91137,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repository-teams parameters: - - *312 - - *313 + - *319 + - *320 - *17 - *18 responses: @@ -90772,9 +91148,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - default: *248 + default: *260 headers: Link: *37 '404': *6 @@ -90794,8 +91170,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-all-repository-topics parameters: - - *312 - - *313 + - *319 + - *320 - *18 - *17 responses: @@ -90803,7 +91179,7 @@ paths: description: Response content: application/json: - schema: &593 + schema: &600 title: Topic description: A topic aggregates entities that are related to a subject. type: object @@ -90815,7 +91191,7 @@ paths: required: - names examples: - default: &594 + default: &601 value: names: - octocat @@ -90838,8 +91214,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#replace-all-repository-topics parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -90870,9 +91246,9 @@ paths: description: Response content: application/json: - schema: *593 + schema: *600 examples: - default: *594 + default: *601 '404': *6 '422': *7 x-github: @@ -90893,9 +91269,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-repository-clones parameters: - - *312 - - *313 - - &595 + - *319 + - *320 + - &602 name: per description: The time frame to display results for. in: query @@ -90926,7 +91302,7 @@ paths: - 128 clones: type: array - items: &596 + items: &603 title: Traffic type: object properties: @@ -91013,8 +91389,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-paths parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -91108,8 +91484,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-top-referral-sources parameters: - - *312 - - *313 + - *319 + - *320 responses: '200': description: Response @@ -91172,9 +91548,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/metrics/traffic#get-page-views parameters: - - *312 - - *313 - - *595 + - *319 + - *320 + - *602 responses: '200': description: Response @@ -91195,7 +91571,7 @@ paths: - 3782 views: type: array - items: *596 + items: *603 required: - uniques - count @@ -91272,8 +91648,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#transfer-a-repository parameters: - - *312 - - *313 + - *319 + - *320 requestBody: required: true content: @@ -91309,7 +91685,7 @@ paths: description: Response content: application/json: - schema: *156 + schema: *168 examples: default: value: @@ -91547,8 +91923,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: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response if repository is enabled with vulnerability alerts @@ -91571,8 +91947,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#enable-vulnerability-alerts parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -91594,8 +91970,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#disable-vulnerability-alerts parameters: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -91621,8 +91997,8 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/repos/contents#download-a-repository-archive-zip operationId: repos/download-zipball-archive parameters: - - *312 - - *313 + - *319 + - *320 - name: ref in: path required: true @@ -91714,9 +92090,9 @@ paths: description: Response content: application/json: - schema: *325 + schema: *332 examples: - default: *327 + default: *334 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -91757,7 +92133,7 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: default: value: @@ -91867,7 +92243,7 @@ paths: value: Engineering externalId: value: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159 - - &604 + - &611 name: excludedAttributes description: Excludes the specified attribute from being returned in the results. Using this parameter can speed up response time. @@ -91877,7 +92253,7 @@ paths: type: string examples: - members - - &609 + - &616 name: startIndex description: 'Used for pagination: the starting index of the first result to return when paginating through values.' @@ -91889,7 +92265,7 @@ paths: format: int32 examples: - 1 - - &610 + - &617 name: count description: 'Used for pagination: the number of results to return per page.' in: query @@ -91933,7 +92309,7 @@ paths: Resources: type: array description: Information about each provisioned group. - items: &598 + items: &605 allOf: - type: object required: @@ -92015,7 +92391,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: &611 + meta: &618 type: object description: The metadata associated with the creation/updates to the user. @@ -92080,31 +92456,31 @@ paths: location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 startIndex: 1 itemsPerPage: 20 - '400': &599 + '400': &606 description: Bad request content: application/json: - schema: *597 + schema: *604 application/scim+json: - schema: *597 - '401': &600 + schema: *604 + '401': &607 description: Authorization failure - '403': &601 + '403': &608 description: Permission denied - '429': &602 + '429': &609 description: Too many requests content: application/json: - schema: *597 + schema: *604 application/scim+json: - schema: *597 - '500': &603 + schema: *604 + '500': &610 description: Internal server error content: application/json: - schema: *597 + schema: *604 application/scim+json: - schema: *597 + schema: *604 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92128,7 +92504,7 @@ paths: required: true content: application/json: - schema: &607 + schema: &614 type: object required: - schemas @@ -92188,9 +92564,9 @@ paths: description: Group has been created content: application/scim+json: - schema: *598 + schema: *605 examples: - group: &605 + group: &612 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:Group @@ -92209,13 +92585,13 @@ paths: created: '2012-03-27T19:59:26.000Z' lastModified: '2018-03-27T19:59:26.000Z' location: https://api.github.localhost/scim/v2/Groups/24b28bbb-5fc4-4686-a153-a020debb1155 - '400': *599 - '401': *600 - '403': *601 - '409': &608 + '400': *606 + '401': *607 + '403': *608 + '409': &615 description: Duplicate record detected - '429': *602 - '500': *603 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92232,7 +92608,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: - - &606 + - &613 name: scim_group_id description: A unique identifier of the SCIM group. in: path @@ -92241,22 +92617,22 @@ paths: type: string examples: - 7fce0092-d52e-4f76-b727-3955bd72c939 - - *604 + - *611 - *38 responses: '200': description: Success, a group was found content: application/scim+json: - schema: *598 + schema: *605 examples: - default: *605 - '400': *599 - '401': *600 - '403': *601 + default: *612 + '400': *606 + '401': *607 + '403': *608 '404': *6 - '429': *602 - '500': *603 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92275,13 +92651,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: - - *606 + - *613 - *38 requestBody: required: true content: application/json: - schema: *607 + schema: *614 examples: group: summary: Group @@ -92307,17 +92683,17 @@ paths: description: Group was updated content: application/scim+json: - schema: *598 + schema: *605 examples: - group: *605 - groupWithMembers: *605 - '400': *599 - '401': *600 - '403': *601 + group: *612 + groupWithMembers: *612 + '400': *606 + '401': *607 + '403': *608 '404': *6 - '409': *608 - '429': *602 - '500': *603 + '409': *615 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92341,13 +92717,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: - - *606 + - *613 - *38 requestBody: required: true content: application/json: - schema: &618 + schema: &625 type: object required: - Operations @@ -92407,17 +92783,17 @@ paths: description: Success, group was updated content: application/scim+json: - schema: *598 + schema: *605 examples: - updateGroup: *605 - addMembers: *605 - '400': *599 - '401': *600 - '403': *601 + updateGroup: *612 + addMembers: *612 + '400': *606 + '401': *607 + '403': *608 '404': *6 - '409': *608 - '429': *602 - '500': *603 + '409': *615 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92433,17 +92809,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: - - *606 + - *613 - *38 responses: '204': description: Group was deleted, no content - '400': *599 - '401': *600 - '403': *601 + '400': *606 + '401': *607 + '403': *608 '404': *6 - '429': *602 - '500': *603 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92477,8 +92853,8 @@ paths: value: userName eq 'E012345' externalId: value: externalId eq 'E012345' - - *609 - - *610 + - *616 + - *617 - *38 responses: '200': @@ -92512,7 +92888,7 @@ paths: Resources: type: array description: Information about each provisioned account. - items: &613 + items: &620 allOf: - type: object required: @@ -92604,7 +92980,7 @@ paths: address. examples: - true - roles: &612 + roles: &619 type: array description: The roles assigned to the user. items: @@ -92663,7 +93039,7 @@ paths: type: string description: Provisioned SCIM groups that the user is a member of. - meta: *611 + meta: *618 startIndex: type: integer description: A starting index for the returned page @@ -92702,11 +93078,11 @@ paths: primary: false startIndex: 1 itemsPerPage: 20 - '400': *599 - '401': *600 - '403': *601 - '429': *602 - '500': *603 + '400': *606 + '401': *607 + '403': *608 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92730,7 +93106,7 @@ paths: required: true content: application/json: - schema: &616 + schema: &623 type: object required: - schemas @@ -92823,9 +93199,9 @@ paths: description: Whether this email address is the primary address. examples: - true - roles: *612 + roles: *619 examples: - user: &617 + user: &624 summary: User value: schemas: @@ -92872,9 +93248,9 @@ paths: description: User has been created content: application/scim+json: - schema: *613 + schema: *620 examples: - user: &614 + user: &621 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -92900,13 +93276,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: *614 - '400': *599 - '401': *600 - '403': *601 - '409': *608 - '429': *602 - '500': *603 + enterpriseOwner: *621 + '400': *606 + '401': *607 + '403': *608 + '409': *615 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92923,7 +93299,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: - - &615 + - &622 name: scim_user_id description: The unique identifier of the SCIM user. in: path @@ -92936,15 +93312,15 @@ paths: description: Success, a user was found content: application/scim+json: - schema: *613 + schema: *620 examples: - default: *614 - '400': *599 - '401': *600 - '403': *601 + default: *621 + '400': *606 + '401': *607 + '403': *608 '404': *6 - '429': *602 - '500': *603 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -92966,30 +93342,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: - - *615 + - *622 - *38 requestBody: required: true content: application/json: - schema: *616 + schema: *623 examples: - user: *617 + user: *624 responses: '200': description: User was updated content: application/scim+json: - schema: *613 + schema: *620 examples: - user: *614 - '400': *599 - '401': *600 - '403': *601 + user: *621 + '400': *606 + '401': *607 + '403': *608 '404': *6 - '409': *608 - '429': *602 - '500': *603 + '409': *615 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -93024,13 +93400,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: - - *615 + - *622 - *38 requestBody: required: true content: application/json: - schema: *618 + schema: *625 examples: userMultiValuedProperties: summary: Multi Valued Property @@ -93070,18 +93446,18 @@ paths: description: Success, user was updated content: application/scim+json: - schema: *613 - examples: - userMultiValuedProperties: *614 - userSingleValuedProperties: *614 - disableUser: *614 - '400': *599 - '401': *600 - '403': *601 + schema: *620 + examples: + userMultiValuedProperties: *621 + userSingleValuedProperties: *621 + disableUser: *621 + '400': *606 + '401': *607 + '403': *608 '404': *6 - '409': *608 - '429': *602 - '500': *603 + '409': *615 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -93101,17 +93477,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: - - *615 + - *622 - *38 responses: '204': description: User was deleted, no content - '400': *599 - '401': *600 - '403': *601 + '400': *606 + '401': *607 + '403': *608 '404': *6 - '429': *602 - '500': *603 + '429': *609 + '500': *610 x-github: enabledForGitHubApps: true githubCloudOnly: true @@ -93144,7 +93520,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#list-scim-provisioned-identities parameters: - - *138 + - *150 - name: startIndex description: 'Used for pagination: the index of the first result to return.' in: query @@ -93202,7 +93578,7 @@ paths: - 1 Resources: type: array - items: &619 + items: &626 title: SCIM /Users description: SCIM /Users provisioning endpoints type: object @@ -93449,22 +93825,22 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/77563764-eb6-24-0598234-958243 '304': *35 - '404': &620 + '404': &627 description: Resource not found content: application/json: - schema: *597 + schema: *604 application/scim+json: - schema: *597 - '403': &621 + schema: *604 + '403': &628 description: Forbidden content: application/json: - schema: *597 + schema: *604 application/scim+json: - schema: *597 - '400': *599 - '429': *602 + schema: *604 + '400': *606 + '429': *609 x-github: githubCloudOnly: true enabledForGitHubApps: true @@ -93484,15 +93860,15 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#provision-and-invite-a-scim-user parameters: - - *138 + - *150 responses: '201': description: Response content: application/scim+json: - schema: *619 + schema: *626 examples: - default: &622 + default: &629 value: schemas: - urn:ietf:params:scim:schemas:core:2.0:User @@ -93515,17 +93891,17 @@ paths: lastModified: '2017-03-09T16:11:13-05:00' location: https://api.github.com/scim/v2/organizations/octo-org/Users/edefdfedf-050c-11e7-8d32 '304': *35 - '404': *620 - '403': *621 - '500': *603 + '404': *627 + '403': *628 + '500': *610 '409': description: Conflict content: application/json: - schema: *597 + schema: *604 application/scim+json: - schema: *597 - '400': *599 + schema: *604 + '400': *606 requestBody: required: true content: @@ -93619,18 +93995,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: - - *138 - - *615 + - *150 + - *622 responses: '200': description: Response content: application/scim+json: - schema: *619 + schema: *626 examples: - default: *622 - '404': *620 - '403': *621 + default: *629 + '404': *627 + '403': *628 '304': *35 x-github: githubCloudOnly: true @@ -93653,19 +94029,19 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/scim/scim#update-a-provisioned-organization-membership parameters: - - *138 - - *615 + - *150 + - *622 responses: '200': description: Response content: application/scim+json: - schema: *619 + schema: *626 examples: - default: *622 + default: *629 '304': *35 - '404': *620 - '403': *621 + '404': *627 + '403': *628 requestBody: required: true content: @@ -93775,20 +94151,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: - - *138 - - *615 + - *150 + - *622 responses: '200': description: Response content: application/scim+json: - schema: *619 + schema: *626 examples: - default: *622 + default: *629 '304': *35 - '404': *620 - '403': *621 - '400': *599 + '404': *627 + '403': *628 + '400': *606 '429': description: Response content: @@ -93883,13 +94259,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: - - *138 - - *615 + - *150 + - *622 responses: '204': description: Response - '404': *620 - '403': *621 + '404': *627 + '403': *628 '304': *35 x-github: githubCloudOnly: true @@ -94004,7 +94380,7 @@ paths: html_url: type: string format: uri - repository: *156 + repository: *168 score: type: number file_size: @@ -94023,7 +94399,7 @@ paths: examples: - 73..77 - 77..78 - text_matches: &623 + text_matches: &630 title: Search Result Text Matches type: array items: @@ -94138,7 +94514,7 @@ paths: releases_url: http://api.github.com/repos/octocat/Hello-World/releases{/id} score: 1 '304': *35 - '503': *96 + '503': *108 '422': *15 '403': *27 x-github: @@ -94187,7 +94563,7 @@ paths: enum: - author-date - committer-date - - &624 + - &631 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 @@ -94256,7 +94632,7 @@ paths: committer: anyOf: - type: 'null' - - *369 + - *376 comment_count: type: integer message: @@ -94275,7 +94651,7 @@ paths: url: type: string format: uri - verification: *474 + verification: *481 required: - author - committer @@ -94290,7 +94666,7 @@ paths: committer: anyOf: - type: 'null' - - *369 + - *376 parents: type: array items: @@ -94302,12 +94678,12 @@ paths: type: string sha: type: string - repository: *156 + repository: *168 score: type: number node_id: type: string - text_matches: *623 + text_matches: *630 required: - sha - node_id @@ -94500,7 +94876,7 @@ paths: - interactions - created - updated - - *624 + - *631 - *17 - *18 responses: @@ -94616,7 +94992,7 @@ paths: milestone: anyOf: - type: 'null' - - *429 + - *436 comments: type: integer created_at: @@ -94630,7 +95006,7 @@ paths: - string - 'null' format: date-time - text_matches: *623 + text_matches: *630 pull_request: type: object properties: @@ -94668,7 +95044,7 @@ paths: type: string score: type: number - author_association: *103 + author_association: *115 draft: type: boolean repository: *55 @@ -94683,7 +95059,7 @@ paths: anyOf: - type: 'null' - *5 - reactions: *104 + reactions: *116 required: - assignee - closed_at @@ -94799,7 +95175,7 @@ paths: locked: true author_association: COLLABORATOR state_reason: completed - '503': *96 + '503': *108 '422': *15 '304': *35 '403': *27 @@ -94852,7 +95228,7 @@ paths: enum: - created - updated - - *624 + - *631 - *17 - *18 responses: @@ -94897,7 +95273,7 @@ paths: - 'null' score: type: number - text_matches: *623 + text_matches: *630 required: - id - node_id @@ -94983,7 +95359,7 @@ paths: - forks - help-wanted-issues - updated - - *624 + - *631 - *17 - *18 responses: @@ -95202,7 +95578,7 @@ paths: license: anyOf: - type: 'null' - - *117 + - *129 permissions: type: object properties: @@ -95220,7 +95596,7 @@ paths: - admin - pull - push - text_matches: *623 + text_matches: *630 temp_clone_token: type: string allow_merge_commit: @@ -95423,7 +95799,7 @@ paths: spdx_id: MIT node_id: MDc6TGljZW5zZW1pdA== html_url: https://api.github.com/licenses/mit - '503': *96 + '503': *108 '422': *15 '304': *35 x-github: @@ -95529,7 +95905,7 @@ paths: - string - 'null' format: uri - text_matches: *623 + text_matches: *630 related: type: - array @@ -95724,7 +96100,7 @@ paths: - followers - repositories - joined - - *624 + - *631 - *17 - *18 responses: @@ -95834,7 +96210,7 @@ paths: type: - boolean - 'null' - text_matches: *623 + text_matches: *630 blog: type: - string @@ -95896,7 +96272,7 @@ paths: events_url: https://api.github.com/users/mojombo/events{/privacy} site_admin: true '304': *35 - '503': *96 + '503': *108 '422': *15 x-github: githubCloudOnly: false @@ -95916,7 +96292,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#get-a-team-legacy parameters: - - &625 + - &632 name: team_id description: The unique identifier of the team. in: path @@ -95928,9 +96304,9 @@ paths: description: Response content: application/json: - schema: *293 + schema: *300 examples: - default: *294 + default: *301 '404': *6 x-github: githubCloudOnly: false @@ -95957,7 +96333,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#update-a-team-legacy parameters: - - *625 + - *632 requestBody: required: true content: @@ -96021,16 +96397,16 @@ paths: description: Response when the updated information already exists content: application/json: - schema: *293 + schema: *300 examples: - default: *294 + default: *301 '201': description: Response content: application/json: - schema: *293 + schema: *300 examples: - default: *294 + default: *301 '404': *6 '422': *15 '403': *27 @@ -96058,7 +96434,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#delete-a-team-legacy parameters: - - *625 + - *632 responses: '204': description: Response @@ -96089,7 +96465,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#list-discussions-legacy parameters: - - *625 + - *632 - *76 - *17 - *18 @@ -96100,9 +96476,9 @@ paths: application/json: schema: type: array - items: *295 + items: *302 examples: - default: *626 + default: *633 headers: Link: *37 x-github: @@ -96131,7 +96507,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#create-a-discussion-legacy parameters: - - *625 + - *632 requestBody: required: true content: @@ -96165,9 +96541,9 @@ paths: description: Response content: application/json: - schema: *295 + schema: *302 examples: - default: *296 + default: *303 x-github: triggersNotification: true githubCloudOnly: false @@ -96194,16 +96570,16 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#get-a-discussion-legacy parameters: - - *625 - - *297 + - *632 + - *304 responses: '200': description: Response content: application/json: - schema: *295 + schema: *302 examples: - default: *296 + default: *303 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96228,8 +96604,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#update-a-discussion-legacy parameters: - - *625 - - *297 + - *632 + - *304 requestBody: required: false content: @@ -96252,9 +96628,9 @@ paths: description: Response content: application/json: - schema: *295 + schema: *302 examples: - default: *627 + default: *634 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96279,8 +96655,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussions#delete-a-discussion-legacy parameters: - - *625 - - *297 + - *632 + - *304 responses: '204': description: Response @@ -96309,8 +96685,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#list-discussion-comments-legacy parameters: - - *625 - - *297 + - *632 + - *304 - *76 - *17 - *18 @@ -96321,9 +96697,9 @@ paths: application/json: schema: type: array - items: *298 + items: *305 examples: - default: *628 + default: *635 headers: Link: *37 x-github: @@ -96352,8 +96728,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#create-a-discussion-comment-legacy parameters: - - *625 - - *297 + - *632 + - *304 requestBody: required: true content: @@ -96375,9 +96751,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 x-github: triggersNotification: true githubCloudOnly: false @@ -96404,17 +96780,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#get-a-discussion-comment-legacy parameters: - - *625 - - *297 - - *300 + - *632 + - *304 + - *307 responses: '200': description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *299 + default: *306 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96439,9 +96815,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#update-a-discussion-comment-legacy parameters: - - *625 - - *297 - - *300 + - *632 + - *304 + - *307 requestBody: required: true content: @@ -96463,9 +96839,9 @@ paths: description: Response content: application/json: - schema: *298 + schema: *305 examples: - default: *629 + default: *636 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96490,9 +96866,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/discussion-comments#delete-a-discussion-comment-legacy parameters: - - *625 - - *297 - - *300 + - *632 + - *304 + - *307 responses: '204': description: Response @@ -96521,9 +96897,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: - - *625 - - *297 - - *300 + - *632 + - *304 + - *307 - 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. @@ -96549,9 +96925,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *303 + default: *310 headers: Link: *37 x-github: @@ -96580,9 +96956,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: - - *625 - - *297 - - *300 + - *632 + - *304 + - *307 requestBody: required: true content: @@ -96614,9 +96990,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 x-github: githubCloudOnly: false enabledForGitHubApps: true @@ -96642,8 +97018,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: - - *625 - - *297 + - *632 + - *304 - 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. @@ -96669,9 +97045,9 @@ paths: application/json: schema: type: array - items: *301 + items: *308 examples: - default: *303 + default: *310 headers: Link: *37 x-github: @@ -96700,8 +97076,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: - - *625 - - *297 + - *632 + - *304 requestBody: required: true content: @@ -96733,9 +97109,9 @@ paths: description: Response content: application/json: - schema: *301 + schema: *308 examples: - default: *302 + default: *309 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -96759,7 +97135,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-pending-team-invitations-legacy parameters: - - *625 + - *632 - *17 - *18 responses: @@ -96769,9 +97145,9 @@ paths: application/json: schema: type: array - items: *231 + items: *243 examples: - default: *232 + default: *244 headers: Link: *37 x-github: @@ -96797,7 +97173,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#list-team-members-legacy parameters: - - *625 + - *632 - name: role description: Filters members returned by their role in the team. in: query @@ -96820,7 +97196,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 '404': *6 @@ -96848,8 +97224,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#get-team-member-legacy parameters: - - *625 - - *178 + - *632 + - *190 responses: '204': description: if user is a member @@ -96885,8 +97261,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#add-team-member-legacy parameters: - - *625 - - *178 + - *632 + - *190 responses: '204': description: Response @@ -96925,8 +97301,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/members#remove-team-member-legacy parameters: - - *625 - - *178 + - *632 + - *190 responses: '204': description: Response @@ -96962,16 +97338,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: - - *625 - - *178 + - *632 + - *190 responses: '200': description: Response content: application/json: - schema: *309 + schema: *316 examples: - response-if-user-is-a-team-maintainer: *630 + response-if-user-is-a-team-maintainer: *637 '404': *6 x-github: githubCloudOnly: false @@ -97004,8 +97380,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: - - *625 - - *178 + - *632 + - *190 requestBody: required: false content: @@ -97030,9 +97406,9 @@ paths: description: Response content: application/json: - schema: *309 + schema: *316 examples: - response-if-users-membership-with-team-is-now-pending: *631 + response-if-users-membership-with-team-is-now-pending: *638 '403': description: Forbidden if team synchronization is set up '422': @@ -97066,8 +97442,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: - - *625 - - *178 + - *632 + - *190 responses: '204': description: Response @@ -97096,7 +97472,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-projects-legacy parameters: - - *625 + - *632 - *17 - *18 responses: @@ -97106,9 +97482,9 @@ paths: application/json: schema: type: array - items: *310 + items: *317 examples: - default: *632 + default: *639 headers: Link: *37 '404': *6 @@ -97135,16 +97511,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: - - *625 - - *311 + - *632 + - *318 responses: '200': description: Response content: application/json: - schema: *310 + schema: *317 examples: - default: *633 + default: *640 '404': description: Not Found if project is not managed by this team x-github: @@ -97169,8 +97545,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: - - *625 - - *311 + - *632 + - *318 requestBody: required: false content: @@ -97238,8 +97614,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: - - *625 - - *311 + - *632 + - *318 responses: '204': description: Response @@ -97266,7 +97642,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-team-repositories-legacy parameters: - - *625 + - *632 - *17 - *18 responses: @@ -97276,9 +97652,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 '404': *6 @@ -97308,15 +97684,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: - - *625 - - *312 - - *313 + - *632 + - *319 + - *320 responses: '200': description: Alternative response with extra repository information content: application/json: - schema: *634 + schema: *641 examples: alternative-response-with-extra-repository-information: value: @@ -97467,9 +97843,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: - - *625 - - *312 - - *313 + - *632 + - *319 + - *320 requestBody: required: false content: @@ -97519,9 +97895,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: - - *625 - - *312 - - *313 + - *632 + - *319 + - *320 responses: '204': description: Response @@ -97550,15 +97926,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: - - *625 + - *632 responses: '200': description: Response content: application/json: - schema: *314 + schema: *321 examples: - default: *315 + default: *322 '403': *27 '404': *6 x-github: @@ -97585,7 +97961,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: - - *625 + - *632 requestBody: required: true content: @@ -97646,7 +98022,7 @@ paths: description: Response content: application/json: - schema: *314 + schema: *321 examples: default: value: @@ -97677,7 +98053,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/teams/teams#list-child-teams-legacy parameters: - - *625 + - *632 - *17 - *18 responses: @@ -97687,9 +98063,9 @@ paths: application/json: schema: type: array - items: *234 + items: *246 examples: - response-if-child-teams-exist: *635 + response-if-child-teams-exist: *642 headers: Link: *37 '404': *6 @@ -97722,7 +98098,7 @@ paths: application/json: schema: oneOf: - - &637 + - &644 title: Private User description: Private User type: object @@ -97972,7 +98348,7 @@ paths: - private_gists - total_private_repos - two_factor_authentication - - *636 + - *643 examples: response-with-public-and-private-profile-information: summary: Response with public and private profile information @@ -98132,7 +98508,7 @@ paths: description: Response content: application/json: - schema: *637 + schema: *644 examples: default: value: @@ -98211,7 +98587,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 '304': *35 '404': *6 '403': *27 @@ -98234,7 +98610,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: - - *178 + - *190 responses: '204': description: If the user is blocked @@ -98262,7 +98638,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#block-a-user parameters: - - *178 + - *190 responses: '204': description: Response @@ -98286,7 +98662,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/blocking#unblock-a-user parameters: - - *178 + - *190 responses: '204': description: Response @@ -98335,9 +98711,9 @@ paths: type: integer codespaces: type: array - items: *238 + items: *250 examples: - default: *239 + default: *251 '304': *35 '500': *80 '401': *23 @@ -98476,21 +98852,21 @@ paths: description: Response when the codespace was successfully created content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '202': description: Response when the codespace creation partially failed but is being retried in the background content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '401': *23 '403': *27 '404': *6 - '503': *96 + '503': *108 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -98530,7 +98906,7 @@ paths: type: integer secrets: type: array - items: &638 + items: &645 title: Codespaces Secret description: Secrets for a GitHub Codespace. type: object @@ -98572,7 +98948,7 @@ paths: - visibility - selected_repositories_url examples: - default: *418 + default: *425 headers: Link: *37 x-github: @@ -98644,13 +99020,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: - - *166 + - *178 responses: '200': description: Response content: application/json: - schema: *638 + schema: *645 examples: default: value: @@ -98680,7 +99056,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: - - *166 + - *178 requestBody: required: true content: @@ -98725,7 +99101,7 @@ paths: description: Response after successfully creating a secret content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -98753,7 +99129,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: - - *166 + - *178 responses: '204': description: Response @@ -98778,7 +99154,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: - - *166 + - *178 responses: '200': description: Response @@ -98794,9 +99170,9 @@ paths: type: integer repositories: type: array - items: *156 + items: *168 examples: - default: *639 + default: *646 '401': *23 '403': *27 '404': *6 @@ -98821,7 +99197,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: - - *166 + - *178 requestBody: required: true content: @@ -98875,7 +99251,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: - - *166 + - *178 - name: repository_id in: path required: true @@ -98908,7 +99284,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: - - *166 + - *178 - name: repository_id in: path required: true @@ -98940,15 +99316,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: - - *240 + - *252 responses: '200': description: Response content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '304': *35 '500': *80 '401': *23 @@ -98974,7 +99350,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: - - *240 + - *252 requestBody: required: false content: @@ -99004,9 +99380,9 @@ paths: description: Response content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '401': *23 '403': *27 '404': *6 @@ -99028,9 +99404,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: - - *240 + - *252 responses: - '202': *144 + '202': *156 '304': *35 '500': *80 '401': *23 @@ -99057,13 +99433,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: - - *240 + - *252 responses: '202': description: Response content: application/json: - schema: &640 + schema: &647 type: object title: Fetches information about an export of a codespace. description: An export of a codespace. Also, latest export details @@ -99116,7 +99492,7 @@ paths: examples: - https://github.com/octocat/hello-world/tree/:branch examples: - default: &641 + default: &648 value: state: succeeded completed_at: '2022-01-01T14:59:22Z' @@ -99148,7 +99524,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/codespaces#get-details-about-a-codespace-export parameters: - - *240 + - *252 - name: export_id in: path required: true @@ -99161,9 +99537,9 @@ paths: description: Response content: application/json: - schema: *640 + schema: *647 examples: - default: *641 + default: *648 '404': *6 x-github: githubCloudOnly: false @@ -99184,7 +99560,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/codespaces/machines#list-machine-types-for-a-codespace parameters: - - *240 + - *252 responses: '200': description: Response @@ -99200,9 +99576,9 @@ paths: type: integer machines: type: array - items: *417 + items: *424 examples: - default: *642 + default: *649 '304': *35 '500': *80 '401': *23 @@ -99231,7 +99607,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: - - *240 + - *252 requestBody: required: true content: @@ -99287,11 +99663,11 @@ paths: - 26a7c758-7299-4a73-b978-5a92a7ae98a0 owner: *4 billable_owner: *4 - repository: *325 + repository: *332 machine: anyOf: - type: 'null' - - *417 + - *424 devcontainer_path: description: Path to devcontainer.json from repo root used to create Codespace. @@ -100088,15 +100464,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: - - *240 + - *252 responses: '200': description: Response content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '304': *35 '500': *80 '400': *14 @@ -100108,7 +100484,7 @@ paths: schema: *3 '403': *27 '404': *6 - '409': *143 + '409': *155 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -100128,15 +100504,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: - - *240 + - *252 responses: '200': description: Response content: application/json: - schema: *238 + schema: *250 examples: - default: *416 + default: *423 '500': *80 '401': *23 '403': *27 @@ -100166,9 +100542,9 @@ paths: application/json: schema: type: array - items: *249 + items: *261 examples: - default: &655 + default: &662 value: - id: 197 name: hello_docker @@ -100269,7 +100645,7 @@ paths: application/json: schema: type: array - items: &643 + items: &650 title: Email description: Email type: object @@ -100339,9 +100715,9 @@ paths: application/json: schema: type: array - items: *643 + items: *650 examples: - default: &657 + default: &664 value: - email: octocat@github.com verified: true @@ -100418,7 +100794,7 @@ paths: application/json: schema: type: array - items: *643 + items: *650 examples: default: value: @@ -100530,7 +100906,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 '304': *35 @@ -100563,7 +100939,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 '304': *35 @@ -100585,7 +100961,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: - - *178 + - *190 responses: '204': description: if the person is followed by the authenticated user @@ -100615,7 +100991,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#follow-a-user parameters: - - *178 + - *190 responses: '204': description: Response @@ -100640,7 +101016,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#unfollow-a-user parameters: - - *178 + - *190 responses: '204': description: Response @@ -100676,7 +101052,7 @@ paths: application/json: schema: type: array - items: &644 + items: &651 title: GPG Key description: A unique encryption key type: object @@ -100821,7 +101197,7 @@ paths: - subkeys - revoked examples: - default: &668 + default: &675 value: - id: 3 name: Octocat's GPG Key @@ -100906,9 +101282,9 @@ paths: description: Response content: application/json: - schema: *644 + schema: *651 examples: - default: &645 + default: &652 value: id: 3 name: Octocat's GPG Key @@ -100965,7 +101341,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: - - &646 + - &653 name: gpg_key_id description: The unique identifier of the GPG key. in: path @@ -100977,9 +101353,9 @@ paths: description: Response content: application/json: - schema: *644 + schema: *651 examples: - default: *645 + default: *652 '404': *6 '304': *35 '403': *27 @@ -101002,7 +101378,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: - - *646 + - *653 responses: '204': description: Response @@ -101193,7 +101569,7 @@ paths: type: array items: *55 examples: - default: *647 + default: *654 headers: Link: *37 '404': *6 @@ -101218,7 +101594,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#add-a-repository-to-an-app-installation parameters: - *21 - - *151 + - *163 responses: '204': description: Response @@ -101244,7 +101620,7 @@ paths: url: https://docs.github.com/enterprise-cloud@latest//rest/apps/installations#remove-a-repository-from-an-app-installation parameters: - *21 - - *151 + - *163 responses: '204': description: Response @@ -101278,12 +101654,12 @@ paths: application/json: schema: anyOf: - - *229 + - *241 - type: object properties: {} additionalProperties: false examples: - default: *230 + default: *242 '204': description: Response when there are no restrictions x-github: @@ -101307,7 +101683,7 @@ paths: required: true content: application/json: - schema: *485 + schema: *492 examples: default: value: @@ -101318,7 +101694,7 @@ paths: description: Response content: application/json: - schema: *229 + schema: *241 examples: default: value: @@ -101399,7 +101775,7 @@ paths: - closed - all default: open - - *235 + - *247 - name: sort description: What to sort results by. in: query @@ -101412,7 +101788,7 @@ paths: - comments default: created - *76 - - *106 + - *118 - *17 - *18 responses: @@ -101422,9 +101798,9 @@ paths: application/json: schema: type: array - items: *116 + items: *128 examples: - default: *236 + default: *248 headers: Link: *37 '404': *6 @@ -101457,7 +101833,7 @@ paths: application/json: schema: type: array - items: &648 + items: &655 title: Key description: Key type: object @@ -101555,9 +101931,9 @@ paths: description: Response content: application/json: - schema: *648 + schema: *655 examples: - default: &649 + default: &656 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -101590,15 +101966,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: - - *512 + - *519 responses: '200': description: Response content: application/json: - schema: *648 + schema: *655 examples: - default: *649 + default: *656 '404': *6 '304': *35 '403': *27 @@ -101621,7 +101997,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: - - *512 + - *519 responses: '204': description: Response @@ -101654,7 +102030,7 @@ paths: application/json: schema: type: array - items: &650 + items: &657 title: User Marketplace Purchase description: User Marketplace Purchase type: object @@ -101722,7 +102098,7 @@ paths: - id - type - login - plan: *119 + plan: *131 required: - billing_cycle - next_billing_date @@ -101733,7 +102109,7 @@ paths: - account - plan examples: - default: &651 + default: &658 value: - billing_cycle: monthly next_billing_date: '2017-11-11T00:00:00Z' @@ -101795,9 +102171,9 @@ paths: application/json: schema: type: array - items: *650 + items: *657 examples: - default: *651 + default: *658 headers: Link: *37 '304': *35 @@ -101837,7 +102213,7 @@ paths: application/json: schema: type: array - items: *241 + items: *253 examples: default: value: @@ -101939,13 +102315,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: - - *138 + - *150 responses: '200': description: Response content: application/json: - schema: *241 + schema: *253 examples: default: value: @@ -102003,7 +102379,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: - - *138 + - *150 requestBody: required: true content: @@ -102028,7 +102404,7 @@ paths: description: Response content: application/json: - schema: *241 + schema: *253 examples: default: value: @@ -102096,7 +102472,7 @@ paths: application/json: schema: type: array - items: *243 + items: *255 examples: default: value: @@ -102358,7 +102734,7 @@ paths: description: Response content: application/json: - schema: *243 + schema: *255 examples: default: value: @@ -102538,7 +102914,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#get-a-user-migration-status parameters: - - *244 + - *256 - name: exclude in: query required: false @@ -102551,7 +102927,7 @@ paths: description: Response content: application/json: - schema: *243 + schema: *255 examples: default: value: @@ -102745,7 +103121,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#download-a-user-migration-archive parameters: - - *244 + - *256 responses: '302': description: Response @@ -102771,7 +103147,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#delete-a-user-migration-archive parameters: - - *244 + - *256 responses: '204': description: Response @@ -102800,8 +103176,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#unlock-a-user-repository parameters: - - *244 - - *652 + - *256 + - *659 responses: '204': description: Response @@ -102825,7 +103201,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/migrations/users#list-repositories-for-a-user-migration parameters: - - *244 + - *256 - *17 - *18 responses: @@ -102835,9 +103211,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 '404': *6 @@ -102874,7 +103250,7 @@ paths: type: array items: *50 examples: - default: *653 + default: *660 headers: Link: *37 '304': *35 @@ -102916,7 +103292,7 @@ paths: - docker - nuget - container - - *654 + - *661 - *18 - *17 responses: @@ -102926,10 +103302,10 @@ paths: application/json: schema: type: array - items: *249 + items: *261 examples: - default: *655 - '400': *656 + default: *662 + '400': *663 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -102949,16 +103325,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: - - *251 - - *252 + - *263 + - *264 responses: '200': description: Response content: application/json: - schema: *249 + schema: *261 examples: - default: &669 + default: &676 value: id: 40201 name: octo-name @@ -103071,8 +103447,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: - - *251 - - *252 + - *263 + - *264 responses: '204': description: Response @@ -103102,8 +103478,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: - - *251 - - *252 + - *263 + - *264 - name: token description: package token schema: @@ -103135,8 +103511,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: - - *251 - - *252 + - *263 + - *264 - *18 - *17 - name: state @@ -103156,7 +103532,7 @@ paths: application/json: schema: type: array - items: *253 + items: *265 examples: default: value: @@ -103205,15 +103581,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: - - *251 - - *252 - - *254 + - *263 + - *264 + - *266 responses: '200': description: Response content: application/json: - schema: *253 + schema: *265 examples: default: value: @@ -103249,9 +103625,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: - - *251 - - *252 - - *254 + - *263 + - *264 + - *266 responses: '204': description: Response @@ -103281,9 +103657,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: - - *251 - - *252 - - *254 + - *263 + - *264 + - *266 responses: '204': description: Response @@ -103341,7 +103717,7 @@ paths: description: Response content: application/json: - schema: *262 + schema: *274 examples: default: value: @@ -103410,9 +103786,9 @@ paths: application/json: schema: type: array - items: *643 + items: *650 examples: - default: *657 + default: *664 headers: Link: *37 '304': *35 @@ -103525,7 +103901,7 @@ paths: type: array items: *55 examples: - default: &664 + default: &671 summary: Default response value: - id: 1296269 @@ -103841,9 +104217,9 @@ paths: description: Response content: application/json: - schema: *325 + schema: *332 examples: - default: *327 + default: *334 headers: Location: example: https://api.github.com/repos/octocat/Hello-World @@ -103881,9 +104257,9 @@ paths: application/json: schema: type: array - items: *487 + items: *494 examples: - default: *658 + default: *665 headers: Link: *37 '304': *35 @@ -103906,12 +104282,12 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#accept-a-repository-invitation parameters: - - *233 + - *245 responses: '204': description: Response '403': *27 - '409': *143 + '409': *155 '404': *6 '304': *35 x-github: @@ -103929,11 +104305,11 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/collaborators/invitations#decline-a-repository-invitation parameters: - - *233 + - *245 responses: '204': description: Response - '409': *143 + '409': *155 '304': *35 '404': *6 '403': *27 @@ -103962,7 +104338,7 @@ paths: application/json: schema: type: array - items: &659 + items: &666 title: Social account description: Social media account type: object @@ -103979,7 +104355,7 @@ paths: - provider - url examples: - default: &660 + default: &667 value: - provider: twitter url: https://twitter.com/github @@ -104042,9 +104418,9 @@ paths: application/json: schema: type: array - items: *659 + items: *666 examples: - default: *660 + default: *667 '422': *15 '304': *35 '404': *6 @@ -104132,7 +104508,7 @@ paths: application/json: schema: type: array - items: &661 + items: &668 title: SSH Signing Key description: A public SSH key used to sign Git commits type: object @@ -104152,7 +104528,7 @@ paths: - title - created_at examples: - default: &670 + default: &677 value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -104219,9 +104595,9 @@ paths: description: Response content: application/json: - schema: *661 + schema: *668 examples: - default: &662 + default: &669 value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 @@ -104252,7 +104628,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: - - &663 + - &670 name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path @@ -104264,9 +104640,9 @@ paths: description: Response content: application/json: - schema: *661 + schema: *668 examples: - default: *662 + default: *669 '404': *6 '304': *35 '403': *27 @@ -104289,7 +104665,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: - - *663 + - *670 responses: '204': description: Response @@ -104318,7 +104694,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: - - &671 + - &678 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 @@ -104343,11 +104719,11 @@ paths: type: array items: *55 examples: - default-response: *664 + default-response: *671 application/vnd.github.v3.star+json: schema: type: array - items: &672 + items: &679 title: Starred Repository description: Starred Repository type: object @@ -104503,8 +104879,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: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response if this repository is starred by you @@ -104532,8 +104908,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: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -104557,8 +104933,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: - - *312 - - *313 + - *319 + - *320 responses: '204': description: Response @@ -104591,9 +104967,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 '304': *35 @@ -104630,7 +105006,7 @@ paths: application/json: schema: type: array - items: *293 + items: *300 examples: default: value: @@ -104706,7 +105082,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user-using-their-id parameters: - - *121 + - *133 responses: '200': description: Response @@ -104714,10 +105090,10 @@ paths: application/json: schema: oneOf: - - *637 - - *636 + - *644 + - *643 examples: - default-response: &666 + default-response: &673 summary: Default response value: login: octocat @@ -104752,7 +105128,7 @@ paths: following: 0 created_at: '2008-01-14T04:33:35Z' updated_at: '2008-01-14T04:33:35Z' - response-with-git-hub-plan-information: &667 + response-with-git-hub-plan-information: &674 summary: Response with GitHub plan information value: login: octocat @@ -104812,7 +105188,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#list-users parameters: - - *665 + - *672 - *17 responses: '200': @@ -104823,7 +105199,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: example: ; rel="next" @@ -104851,7 +105227,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-a-user parameters: - - *178 + - *190 responses: '200': description: Response @@ -104859,11 +105235,11 @@ paths: application/json: schema: oneOf: - - *637 - - *636 + - *644 + - *643 examples: - default-response: *666 - response-with-git-hub-plan-information: *667 + default-response: *673 + response-with-git-hub-plan-information: *674 '404': *6 x-github: githubCloudOnly: false @@ -104889,7 +105265,7 @@ paths: - *17 - *74 - *75 - - *178 + - *190 - name: subject_digest description: Subject Digest in: path @@ -104984,6 +105360,8 @@ paths: type: string repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -104991,7 +105369,7 @@ paths: description: Response content: application/json: - schema: *167 + schema: *179 examples: default: value: @@ -105017,7 +105395,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: - - *178 + - *190 responses: '200': description: Response @@ -105025,9 +105403,9 @@ paths: application/json: schema: type: array - items: *249 + items: *261 examples: - default: *655 + default: *662 '403': *27 '401': *23 x-github: @@ -105050,7 +105428,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-events-for-the-authenticated-user parameters: - - *178 + - *190 - *17 - *18 responses: @@ -105060,7 +105438,7 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: default: value: @@ -105131,8 +105509,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: - - *178 - - *138 + - *190 + - *150 - *17 - *18 responses: @@ -105142,7 +105520,7 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: default: value: @@ -105221,7 +105599,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/events#list-public-events-for-a-user parameters: - - *178 + - *190 - *17 - *18 responses: @@ -105231,7 +105609,7 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: default: value: @@ -105298,7 +105676,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-followers-of-a-user parameters: - - *178 + - *190 - *17 - *18 responses: @@ -105310,7 +105688,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 x-github: @@ -105329,7 +105707,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/followers#list-the-people-a-user-follows parameters: - - *178 + - *190 - *17 - *18 responses: @@ -105341,7 +105719,7 @@ paths: type: array items: *4 examples: - default: *237 + default: *249 headers: Link: *37 x-github: @@ -105360,7 +105738,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: - - *178 + - *190 - name: target_user in: path required: true @@ -105387,8 +105765,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/gists/gists#list-gists-for-a-user parameters: - - *178 - - *106 + - *190 + - *118 - *17 - *18 responses: @@ -105398,9 +105776,9 @@ paths: application/json: schema: type: array - items: *107 + items: *119 examples: - default: *108 + default: *120 headers: Link: *37 '422': *15 @@ -105421,7 +105799,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: - - *178 + - *190 - *17 - *18 responses: @@ -105431,9 +105809,9 @@ paths: application/json: schema: type: array - items: *644 + items: *651 examples: - default: *668 + default: *675 headers: Link: *37 x-github: @@ -105457,7 +105835,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/users#get-contextual-information-for-a-user parameters: - - *178 + - *190 - name: subject_type description: Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, @@ -105529,7 +105907,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: - - *178 + - *190 responses: '200': description: Response @@ -105537,7 +105915,7 @@ paths: application/json: schema: *20 examples: - default: *484 + default: *491 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105555,7 +105933,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/users/keys#list-public-keys-for-a-user parameters: - - *178 + - *190 - *17 - *18 responses: @@ -105603,7 +105981,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/orgs/orgs#list-organizations-for-a-user parameters: - - *178 + - *190 - *17 - *18 responses: @@ -105615,7 +105993,7 @@ paths: type: array items: *50 examples: - default: *653 + default: *660 headers: Link: *37 x-github: @@ -105654,8 +106032,8 @@ paths: - docker - nuget - container - - *654 - - *178 + - *661 + - *190 - *18 - *17 responses: @@ -105665,12 +106043,12 @@ paths: application/json: schema: type: array - items: *249 + items: *261 examples: - default: *655 + default: *662 '403': *27 '401': *23 - '400': *656 + '400': *663 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105690,17 +106068,17 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#get-a-package-for-a-user parameters: - - *251 - - *252 - - *178 + - *263 + - *264 + - *190 responses: '200': description: Response content: application/json: - schema: *249 + schema: *261 examples: - default: *669 + default: *676 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -105721,9 +106099,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-a-package-for-a-user parameters: - - *251 - - *252 - - *178 + - *263 + - *264 + - *190 responses: '204': description: Response @@ -105755,9 +106133,9 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-a-package-for-a-user parameters: - - *251 - - *252 - - *178 + - *263 + - *264 + - *190 - name: token description: package token schema: @@ -105789,9 +106167,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: - - *251 - - *252 - - *178 + - *263 + - *264 + - *190 responses: '200': description: Response @@ -105799,7 +106177,7 @@ paths: application/json: schema: type: array - items: *253 + items: *265 examples: default: value: @@ -105857,16 +106235,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: - - *251 - - *252 - - *254 - - *178 + - *263 + - *264 + - *266 + - *190 responses: '200': description: Response content: application/json: - schema: *253 + schema: *265 examples: default: value: @@ -105901,10 +106279,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#delete-package-version-for-a-user parameters: - - *251 - - *252 - - *178 - - *254 + - *263 + - *264 + - *190 + - *266 responses: '204': description: Response @@ -105936,10 +106314,10 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/packages/packages#restore-package-version-for-a-user parameters: - - *251 - - *252 - - *178 - - *254 + - *263 + - *264 + - *190 + - *266 responses: '204': description: Response @@ -105962,7 +106340,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/projects/projects#list-user-projects parameters: - - *178 + - *190 - name: state description: Indicates the state of the projects to return. in: query @@ -105983,7 +106361,7 @@ paths: application/json: schema: type: array - items: *262 + items: *274 examples: default: value: @@ -106042,7 +106420,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: - - *178 + - *190 - *17 - *18 responses: @@ -106052,7 +106430,7 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: default: value: @@ -106131,7 +106509,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: - - *178 + - *190 - *17 - *18 responses: @@ -106141,7 +106519,7 @@ paths: application/json: schema: type: array - items: *127 + items: *139 examples: default: value: @@ -106218,7 +106596,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#list-repositories-for-a-user parameters: - - *178 + - *190 - name: type description: Limit results to repositories of the specified type. in: query @@ -106261,9 +106639,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 x-github: @@ -106287,15 +106665,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: - - *178 + - *190 responses: '200': description: Response content: application/json: - schema: *285 + schema: *292 examples: - default: *286 + default: *293 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106317,15 +106695,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: - - *178 + - *190 responses: '200': description: Response content: application/json: - schema: *289 + schema: *296 examples: - default: *290 + default: *297 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106347,15 +106725,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: - - *178 + - *190 responses: '200': description: Response content: application/json: - schema: *291 + schema: *298 examples: - default: *292 + default: *299 x-github: githubCloudOnly: false enabledForGitHubApps: false @@ -106373,7 +106751,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: - - *178 + - *190 - *17 - *18 responses: @@ -106383,9 +106761,9 @@ paths: application/json: schema: type: array - items: *659 + items: *666 examples: - default: *660 + default: *667 headers: Link: *37 x-github: @@ -106405,7 +106783,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: - - *178 + - *190 - *17 - *18 responses: @@ -106415,9 +106793,9 @@ paths: application/json: schema: type: array - items: *661 + items: *668 examples: - default: *670 + default: *677 headers: Link: *37 x-github: @@ -106441,8 +106819,8 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/starring#list-repositories-starred-by-a-user parameters: - - *178 - - *671 + - *190 + - *678 - *76 - *17 - *18 @@ -106454,11 +106832,11 @@ paths: schema: anyOf: - type: array - items: *672 + items: *679 - type: array items: *55 examples: - default-response: *664 + default-response: *671 headers: Link: *37 x-github: @@ -106477,7 +106855,7 @@ paths: description: API method documentation url: https://docs.github.com/enterprise-cloud@latest//rest/activity/watching#list-repositories-watched-by-a-user parameters: - - *178 + - *190 - *17 - *18 responses: @@ -106487,9 +106865,9 @@ paths: application/json: schema: type: array - items: *156 + items: *168 examples: - default: *255 + default: *267 headers: Link: *37 x-github: @@ -106618,7 +106996,7 @@ webhooks: type: string enum: - disabled - enterprise: &673 + enterprise: &680 title: Enterprise description: |- An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured @@ -106687,7 +107065,7 @@ webhooks: - created_at - updated_at - avatar_url - installation: &674 + installation: &681 title: Simple Installation description: |- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured @@ -106708,7 +107086,7 @@ webhooks: required: - id - node_id - organization: &675 + organization: &682 title: Organization Simple description: |- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an @@ -106781,7 +107159,7 @@ webhooks: - public_members_url - avatar_url - description - repository: &676 + repository: &683 title: Repository description: |- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property @@ -106810,7 +107188,7 @@ webhooks: license: anyOf: - type: 'null' - - *117 + - *129 organization: anyOf: - type: 'null' @@ -107694,10 +108072,10 @@ webhooks: type: string enum: - enabled - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -107773,11 +108151,11 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - rule: &677 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + rule: &684 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) @@ -108000,11 +108378,11 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - rule: *677 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + rule: *684 sender: *4 required: - action @@ -108192,11 +108570,11 @@ webhooks: - everyone required: - from - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - rule: *677 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + rule: *684 sender: *4 required: - action @@ -108269,7 +108647,7 @@ webhooks: required: true content: application/json: - schema: &680 + schema: &687 title: Exemption request cancellation event type: object properties: @@ -108277,11 +108655,11 @@ webhooks: type: string enum: - cancelled - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - exemption_request: &678 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + exemption_request: &685 title: Exemption Request description: A request from a user to be exempted from a set of rules. @@ -108435,7 +108813,7 @@ webhooks: - array - 'null' description: The responses to the exemption request. - items: &679 + items: &686 title: Exemption response description: A response to an exemption request by a delegated bypasser. @@ -108459,6 +108837,12 @@ webhooks: - approved - rejected - dismissed + reviewer_comment: + type: + - string + - 'null' + description: The comment the reviewer provided when responding + to the exemption request. created_at: type: string format: date-time @@ -108541,7 +108925,7 @@ webhooks: required: true content: application/json: - schema: &681 + schema: &688 title: Exemption request completed event type: object properties: @@ -108549,11 +108933,11 @@ webhooks: type: string enum: - completed - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - exemption_request: *678 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + exemption_request: *685 sender: *4 required: - action @@ -108625,7 +109009,7 @@ webhooks: required: true content: application/json: - schema: &682 + schema: &689 title: Exemption request created event type: object properties: @@ -108633,11 +109017,11 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - exemption_request: *678 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + exemption_request: *685 sender: *4 required: - action @@ -108709,7 +109093,7 @@ webhooks: required: true content: application/json: - schema: &683 + schema: &690 title: Exemption response dismissed event type: object properties: @@ -108717,12 +109101,12 @@ webhooks: type: string enum: - response_dismissed - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - exemption_request: *678 - exemption_response: *679 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + exemption_request: *685 + exemption_response: *686 sender: *4 required: - action @@ -108796,7 +109180,7 @@ webhooks: required: true content: application/json: - schema: &684 + schema: &691 title: Exemption response submitted event type: object properties: @@ -108804,12 +109188,12 @@ webhooks: type: string enum: - response_submitted - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - exemption_request: *678 - exemption_response: *679 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + exemption_request: *685 + exemption_response: *686 sender: *4 required: - action @@ -108882,7 +109266,7 @@ webhooks: required: true content: application/json: - schema: *680 + schema: *687 responses: '200': description: Return a 200 status to indicate that the data was received @@ -108949,7 +109333,7 @@ webhooks: required: true content: application/json: - schema: *681 + schema: *688 responses: '200': description: Return a 200 status to indicate that the data was received @@ -109016,7 +109400,7 @@ webhooks: required: true content: application/json: - schema: *682 + schema: *689 responses: '200': description: Return a 200 status to indicate that the data was received @@ -109083,7 +109467,7 @@ webhooks: required: true content: application/json: - schema: *683 + schema: *690 responses: '200': description: Return a 200 status to indicate that the data was received @@ -109151,7 +109535,7 @@ webhooks: required: true content: application/json: - schema: *684 + schema: *691 responses: '200': description: Return a 200 status to indicate that the data was received @@ -109229,7 +109613,7 @@ webhooks: type: string enum: - completed - check_run: &686 + check_run: &693 title: CheckRun description: A check performed on the code of a given code change type: object @@ -109297,8 +109681,8 @@ webhooks: - MDEwOkNoZWNrU3VpdGU1 pull_requests: type: array - items: *382 - repository: *156 + items: *389 + repository: *168 status: type: string enum: @@ -109342,7 +109726,7 @@ webhooks: - examples: - neutral - deployment: *685 + deployment: *692 details_url: type: string examples: @@ -109402,7 +109786,7 @@ webhooks: - annotations_url pull_requests: type: array - items: *382 + items: *389 started_at: type: string format: date-time @@ -109440,9 +109824,9 @@ webhooks: - output - app - pull_requests - installation: *674 - organization: *675 - repository: *676 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - check_run @@ -109835,10 +110219,10 @@ webhooks: type: string enum: - created - check_run: *686 - installation: *674 - organization: *675 - repository: *676 + check_run: *693 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - check_run @@ -110234,10 +110618,10 @@ webhooks: type: string enum: - requested_action - check_run: *686 - installation: *674 - organization: *675 - repository: *676 + check_run: *693 + installation: *681 + organization: *682 + repository: *683 requested_action: description: The action requested by the user. type: object @@ -110642,10 +111026,10 @@ webhooks: type: string enum: - rerequested - check_run: *686 - installation: *674 - organization: *675 - repository: *676 + check_run: *693 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - check_run @@ -111637,10 +112021,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -112325,10 +112709,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -113007,10 +113391,10 @@ webhooks: - latest_check_runs_count - check_runs_url - head_commit - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -113317,20 +113701,20 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: &687 + commit_oid: &694 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: *673 - installation: *674 - organization: *675 - ref: &688 + enterprise: *680 + installation: *681 + organization: *682 + ref: &695 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: *676 + repository: *683 sender: *4 required: - action @@ -113658,12 +114042,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *687 - enterprise: *673 - installation: *674 - organization: *675 - ref: *688 - repository: *676 + commit_oid: *694 + enterprise: *680 + installation: *681 + organization: *682 + ref: *695 + repository: *683 sender: *4 required: - action @@ -113761,7 +114145,7 @@ webhooks: dismissed_by: type: - 'null' - dismissed_comment: *394 + dismissed_comment: *401 dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be one of: `false positive`, `won''t fix`, and `used in @@ -113936,12 +114320,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *687 - enterprise: *673 - installation: *674 - organization: *675 - ref: *688 - repository: *676 + commit_oid: *694 + enterprise: *680 + installation: *681 + organization: *682 + ref: *695 + repository: *683 sender: *4 required: - action @@ -114273,12 +114657,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *687 - enterprise: *673 - installation: *674 - organization: *675 - ref: *688 - repository: *676 + commit_oid: *694 + enterprise: *680 + installation: *681 + organization: *682 + ref: *695 + repository: *683 sender: *4 required: - action @@ -114547,9 +114931,9 @@ webhooks: type: - string - 'null' - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 ref: description: The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event @@ -114557,7 +114941,7 @@ webhooks: type: - string - 'null' - repository: *676 + repository: *683 sender: *4 required: - action @@ -114789,12 +115173,12 @@ webhooks: - dismissed_reason - rule - tool - commit_oid: *687 - enterprise: *673 - installation: *674 - organization: *675 - ref: *688 - repository: *676 + commit_oid: *694 + enterprise: *680 + installation: *681 + organization: *682 + ref: *695 + repository: *683 sender: *4 required: - action @@ -115056,10 +115440,10 @@ webhooks: - updated_at - author_association - body - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -115140,18 +115524,18 @@ webhooks: type: - string - 'null' - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 master_branch: description: The name of the repository's default branch (usually `main`). type: string - organization: *675 - pusher_type: &689 + organization: *682 + pusher_type: &696 description: The pusher type for the event. Can be either `user` or a deploy key. type: string - ref: &690 + ref: &697 description: The [`git ref`](https://docs.github.com/enterprise-cloud@latest//rest/git/refs#get-a-reference) resource. type: string @@ -115161,7 +115545,7 @@ webhooks: enum: - tag - branch - repository: *676 + repository: *683 sender: *4 required: - ref @@ -115244,9 +115628,9 @@ webhooks: enum: - created definition: *92 - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 sender: *4 required: - action @@ -115331,9 +115715,9 @@ webhooks: description: The name of the property that was deleted. required: - property_name - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 sender: *4 required: - action @@ -115411,9 +115795,9 @@ webhooks: enum: - updated definition: *92 - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 sender: *4 required: - action @@ -115490,19 +115874,19 @@ webhooks: type: string enum: - updated - enterprise: *673 - installation: *674 - repository: *676 - organization: *675 + enterprise: *680 + installation: *681 + repository: *683 + organization: *682 sender: *4 new_property_values: type: array description: The new custom property values for the repository. - items: *263 + items: *276 old_property_values: type: array description: The old custom property values for the repository. - items: *263 + items: *276 required: - action - repository @@ -115578,18 +115962,18 @@ webhooks: title: delete event type: object properties: - enterprise: *673 - installation: *674 - organization: *675 - pusher_type: *689 - ref: *690 + enterprise: *680 + installation: *681 + organization: *682 + pusher_type: *696 + ref: *697 ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch - repository: *676 + repository: *683 sender: *4 required: - ref @@ -115673,11 +116057,11 @@ webhooks: type: string enum: - auto_dismissed - alert: *443 - installation: *674 - organization: *675 - enterprise: *673 - repository: *676 + alert: *450 + installation: *681 + organization: *682 + enterprise: *680 + repository: *683 sender: *4 required: - action @@ -115761,11 +116145,11 @@ webhooks: type: string enum: - auto_reopened - alert: *443 - installation: *674 - organization: *675 - enterprise: *673 - repository: *676 + alert: *450 + installation: *681 + organization: *682 + enterprise: *680 + repository: *683 sender: *4 required: - action @@ -115849,11 +116233,11 @@ webhooks: type: string enum: - created - alert: *443 - installation: *674 - organization: *675 - enterprise: *673 - repository: *676 + alert: *450 + installation: *681 + organization: *682 + enterprise: *680 + repository: *683 sender: *4 required: - action @@ -115935,11 +116319,11 @@ webhooks: type: string enum: - dismissed - alert: *443 - installation: *674 - organization: *675 - enterprise: *673 - repository: *676 + alert: *450 + installation: *681 + organization: *682 + enterprise: *680 + repository: *683 sender: *4 required: - action @@ -116021,11 +116405,11 @@ webhooks: type: string enum: - fixed - alert: *443 - installation: *674 - organization: *675 - enterprise: *673 - repository: *676 + alert: *450 + installation: *681 + organization: *682 + enterprise: *680 + repository: *683 sender: *4 required: - action @@ -116108,11 +116492,11 @@ webhooks: type: string enum: - reintroduced - alert: *443 - installation: *674 - organization: *675 - enterprise: *673 - repository: *676 + alert: *450 + installation: *681 + organization: *682 + enterprise: *680 + repository: *683 sender: *4 required: - action @@ -116194,11 +116578,11 @@ webhooks: type: string enum: - reopened - alert: *443 - installation: *674 - organization: *675 - enterprise: *673 - repository: *676 + alert: *450 + installation: *681 + organization: *682 + enterprise: *680 + repository: *683 sender: *4 required: - action @@ -116275,9 +116659,9 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - key: &691 + enterprise: *680 + installation: *681 + key: &698 description: The [`deploy key`](https://docs.github.com/enterprise-cloud@latest//rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object @@ -116315,8 +116699,8 @@ webhooks: - verified - created_at - read_only - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -116393,11 +116777,11 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - key: *691 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + key: *698 + organization: *682 + repository: *683 sender: *4 required: - action @@ -116969,12 +117353,12 @@ webhooks: - updated_at - statuses_url - repository_url - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - workflow: &695 + workflow: &702 title: Workflow type: - object @@ -117712,13 +118096,13 @@ webhooks: description: The URL to review the deployment protection rule. type: string format: uri - deployment: *449 + deployment: *456 pull_requests: type: array - items: *531 - repository: *676 - organization: *675 - installation: *674 + items: *538 + repository: *683 + organization: *682 + installation: *681 sender: *4 responses: '200': @@ -117789,7 +118173,7 @@ webhooks: type: string enum: - approved - approver: &692 + approver: &699 type: object properties: avatar_url: @@ -117832,11 +118216,11 @@ webhooks: type: string comment: type: string - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - reviewers: &693 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + reviewers: &700 type: array items: type: object @@ -117917,7 +118301,7 @@ webhooks: sender: *4 since: type: string - workflow_job_run: &694 + workflow_job_run: &701 type: object properties: conclusion: @@ -118663,18 +119047,18 @@ webhooks: type: string enum: - rejected - approver: *692 + approver: *699 comment: type: string - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - reviewers: *693 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + reviewers: *700 sender: *4 since: type: string - workflow_job_run: *694 + workflow_job_run: *701 workflow_job_runs: type: array items: @@ -119391,13 +119775,13 @@ webhooks: type: string enum: - requested - enterprise: *673 + enterprise: *680 environment: type: string - installation: *674 - organization: *675 - repository: *676 - requestor: &700 + installation: *681 + organization: *682 + repository: *683 + requestor: &707 title: User type: - object @@ -121340,12 +121724,12 @@ webhooks: - updated_at - deployment_url - repository_url - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - workflow: *695 + workflow: *702 workflow_run: title: Deployment Workflow Run type: @@ -122036,7 +122420,7 @@ webhooks: type: string enum: - answered - answer: &698 + answer: &705 type: object properties: author_association: @@ -122196,7 +122580,7 @@ webhooks: - created_at - updated_at - body - discussion: &696 + discussion: &703 title: Discussion description: A Discussion in a repository. type: object @@ -122492,7 +122876,7 @@ webhooks: - id labels: type: array - items: *494 + items: *501 required: - repository_url - category @@ -122514,10 +122898,10 @@ webhooks: - author_association - active_lock_reason - body - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -122644,11 +123028,11 @@ webhooks: - from required: - category - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -122731,11 +123115,11 @@ webhooks: type: string enum: - closed - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -122817,7 +123201,7 @@ webhooks: type: string enum: - created - comment: &697 + comment: &704 type: object properties: author_association: @@ -122977,11 +123361,11 @@ webhooks: - updated_at - body - reactions - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123064,12 +123448,12 @@ webhooks: type: string enum: - deleted - comment: *697 - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + comment: *704 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123164,12 +123548,12 @@ webhooks: - from required: - body - comment: *697 - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + comment: *704 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123253,11 +123637,11 @@ webhooks: type: string enum: - created - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123339,11 +123723,11 @@ webhooks: type: string enum: - deleted - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123443,11 +123827,11 @@ webhooks: type: string required: - from - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123529,10 +123913,10 @@ webhooks: type: string enum: - labeled - discussion: *696 - enterprise: *673 - installation: *674 - label: &699 + discussion: *703 + enterprise: *680 + installation: *681 + label: &706 title: Label type: object properties: @@ -123565,8 +123949,8 @@ webhooks: - color - default - description - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123649,11 +124033,11 @@ webhooks: type: string enum: - locked - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123735,11 +124119,11 @@ webhooks: type: string enum: - pinned - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123821,11 +124205,11 @@ webhooks: type: string enum: - reopened - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -123910,16 +124294,16 @@ webhooks: changes: type: object properties: - new_discussion: *696 - new_repository: *676 + new_discussion: *703 + new_repository: *683 required: - new_discussion - new_repository - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -124002,10 +124386,10 @@ webhooks: type: string enum: - unanswered - discussion: *696 - old_answer: *698 - organization: *675 - repository: *676 + discussion: *703 + old_answer: *705 + organization: *682 + repository: *683 sender: *4 required: - action @@ -124087,12 +124471,12 @@ webhooks: type: string enum: - unlabeled - discussion: *696 - enterprise: *673 - installation: *674 - label: *699 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + label: *706 + organization: *682 + repository: *683 sender: *4 required: - action @@ -124175,11 +124559,11 @@ webhooks: type: string enum: - unlocked - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -124261,11 +124645,11 @@ webhooks: type: string enum: - unpinned - discussion: *696 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + discussion: *703 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -124338,7 +124722,7 @@ webhooks: description: A user forks a repository. type: object properties: - enterprise: *673 + enterprise: *680 forkee: description: The created [`repository`](https://docs.github.com/enterprise-cloud@latest//rest/repos/repos#get-a-repository) resource. @@ -125016,9 +125400,9 @@ webhooks: type: integer watchers_count: type: integer - installation: *674 - organization: *675 - repository: *676 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - forkee @@ -125164,9 +125548,9 @@ webhooks: title: gollum event type: object properties: - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 pages: description: The pages that were updated. type: array @@ -125204,7 +125588,7 @@ webhooks: - action - sha - html_url - repository: *676 + repository: *683 sender: *4 required: - pages @@ -125280,10 +125664,10 @@ webhooks: type: string enum: - created - enterprise: *673 + enterprise: *680 installation: *20 - organization: *675 - repositories: &701 + organization: *682 + repositories: &708 description: An array of repository objects that the installation can access. type: array @@ -125309,8 +125693,8 @@ webhooks: - name - full_name - private - repository: *676 - requester: *700 + repository: *683 + requester: *707 sender: *4 required: - action @@ -125385,11 +125769,11 @@ webhooks: type: string enum: - deleted - enterprise: *673 + enterprise: *680 installation: *20 - organization: *675 - repositories: *701 - repository: *676 + organization: *682 + repositories: *708 + repository: *683 requester: type: - 'null' @@ -125466,11 +125850,11 @@ webhooks: type: string enum: - new_permissions_accepted - enterprise: *673 + enterprise: *680 installation: *20 - organization: *675 - repositories: *701 - repository: *676 + organization: *682 + repositories: *708 + repository: *683 requester: type: - 'null' @@ -125547,10 +125931,10 @@ webhooks: type: string enum: - added - enterprise: *673 + enterprise: *680 installation: *20 - organization: *675 - repositories_added: &702 + organization: *682 + repositories_added: &709 description: An array of repository objects, which were added to the installation. type: array @@ -125596,15 +125980,15 @@ webhooks: private: description: Whether the repository is private or public. type: boolean - repository: *676 - repository_selection: &703 + repository: *683 + repository_selection: &710 description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected - requester: *700 + requester: *707 sender: *4 required: - action @@ -125683,10 +126067,10 @@ webhooks: type: string enum: - removed - enterprise: *673 + enterprise: *680 installation: *20 - organization: *675 - repositories_added: *702 + organization: *682 + repositories_added: *709 repositories_removed: description: An array of repository objects, which were removed from the installation. @@ -125713,9 +126097,9 @@ webhooks: - name - full_name - private - repository: *676 - repository_selection: *703 - requester: *700 + repository: *683 + repository_selection: *710 + requester: *707 sender: *4 required: - action @@ -125794,11 +126178,11 @@ webhooks: type: string enum: - suspend - enterprise: *673 + enterprise: *680 installation: *20 - organization: *675 - repositories: *701 - repository: *676 + organization: *682 + repositories: *708 + repository: *683 requester: type: - 'null' @@ -125981,10 +126365,10 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 target_type: type: string @@ -126063,11 +126447,11 @@ webhooks: type: string enum: - unsuspend - enterprise: *673 + enterprise: *680 installation: *20 - organization: *675 - repositories: *701 - repository: *676 + organization: *682 + repositories: *708 + repository: *683 requester: type: - 'null' @@ -126315,8 +126699,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -127506,8 +127890,8 @@ webhooks: - state - locked - assignee - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -127587,7 +127971,7 @@ webhooks: type: string enum: - deleted - comment: &704 + comment: &711 title: issue comment description: The [comment](https://docs.github.com/enterprise-cloud@latest//rest/issues/comments#get-an-issue-comment) itself. @@ -127754,8 +128138,8 @@ webhooks: - performed_via_github_app - body - reactions - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -128943,8 +129327,8 @@ webhooks: - state - locked - assignee - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -129024,7 +129408,7 @@ webhooks: type: string enum: - edited - changes: &729 + changes: &736 description: The changes to the comment. type: object properties: @@ -129036,9 +129420,9 @@ webhooks: type: string required: - from - comment: *704 - enterprise: *673 - installation: *674 + comment: *711 + enterprise: *680 + installation: *681 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) the comment belongs to. @@ -130227,8 +130611,8 @@ webhooks: - state - locked - assignee - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -130310,10 +130694,10 @@ webhooks: type: string enum: - assigned - assignee: *700 - enterprise: *673 - installation: *674 - issue: &707 + assignee: *707 + enterprise: *680 + installation: *681 + issue: &714 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -131257,8 +131641,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -131338,8 +131722,8 @@ webhooks: type: string enum: - closed - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -132431,8 +132815,8 @@ webhooks: required: - state - closed_at - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -132511,8 +132895,8 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -133449,8 +133833,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -133529,8 +133913,8 @@ webhooks: type: string enum: - demilestoned - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -134471,7 +134855,7 @@ webhooks: format: uri user_view_type: type: string - milestone: &705 + milestone: &712 title: Milestone description: A collection of related issues and pull requests. type: object @@ -134614,8 +134998,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -134714,8 +135098,8 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -135659,9 +136043,9 @@ webhooks: - active_lock_reason - body - reactions - label: *699 - organization: *675 - repository: *676 + label: *706 + organization: *682 + repository: *683 sender: *4 required: - action @@ -135741,8 +136125,8 @@ webhooks: type: string enum: - labeled - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -136685,9 +137069,9 @@ webhooks: - active_lock_reason - body - reactions - label: *699 - organization: *675 - repository: *676 + label: *706 + organization: *682 + repository: *683 sender: *4 required: - action @@ -136767,8 +137151,8 @@ webhooks: type: string enum: - locked - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -137713,8 +138097,8 @@ webhooks: format: uri user_view_type: type: string - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -137793,8 +138177,8 @@ webhooks: type: string enum: - milestoned - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -138733,9 +139117,9 @@ webhooks: format: uri user_view_type: type: string - milestone: *705 - organization: *675 - repository: *676 + milestone: *712 + organization: *682 + repository: *683 sender: *4 required: - action @@ -140235,8 +140619,8 @@ webhooks: required: - old_issue - old_repository - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -141179,8 +141563,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -141260,9 +141644,9 @@ webhooks: type: string enum: - pinned - enterprise: *673 - installation: *674 - issue: &706 + enterprise: *680 + installation: *681 + issue: &713 title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) itself. @@ -142199,8 +142583,8 @@ webhooks: - active_lock_reason - body - reactions - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -142279,8 +142663,8 @@ webhooks: type: string enum: - reopened - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -143224,8 +143608,8 @@ webhooks: format: uri user_view_type: type: string - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -144725,11 +145109,11 @@ webhooks: required: - new_issue - new_repository - enterprise: *673 - installation: *674 - issue: *706 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + issue: *713 + organization: *682 + repository: *683 sender: *4 required: - action @@ -144810,7 +145194,7 @@ webhooks: type: string enum: - unassigned - assignee: &732 + assignee: &739 title: User type: - object @@ -144882,11 +145266,11 @@ webhooks: required: - login - id - enterprise: *673 - installation: *674 - issue: *707 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + issue: *714 + organization: *682 + repository: *683 sender: *4 required: - action @@ -144965,12 +145349,12 @@ webhooks: type: string enum: - unlabeled - enterprise: *673 - installation: *674 - issue: *707 - label: *699 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + issue: *714 + label: *706 + organization: *682 + repository: *683 sender: *4 required: - action @@ -145050,8 +145434,8 @@ webhooks: type: string enum: - unlocked - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 issue: title: Issue description: The [issue](https://docs.github.com/enterprise-cloud@latest//rest/issues/issues#get-an-issue) @@ -145994,8 +146378,8 @@ webhooks: format: uri user_view_type: type: string - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -146075,11 +146459,11 @@ webhooks: type: string enum: - unpinned - enterprise: *673 - installation: *674 - issue: *706 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + issue: *713 + organization: *682 + repository: *683 sender: *4 required: - action @@ -146158,11 +146542,11 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - label: *699 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + label: *706 + organization: *682 + repository: *683 sender: *4 required: - action @@ -146240,11 +146624,11 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - label: *699 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + label: *706 + organization: *682 + repository: *683 sender: *4 required: - action @@ -146354,11 +146738,11 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 - label: *699 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + label: *706 + organization: *682 + repository: *683 sender: *4 required: - action @@ -146440,9 +146824,9 @@ webhooks: - cancelled effective_date: type: string - enterprise: *673 - installation: *674 - marketplace_purchase: &708 + enterprise: *680 + installation: *681 + marketplace_purchase: &715 title: Marketplace Purchase type: object required: @@ -146530,8 +146914,8 @@ webhooks: type: integer unit_count: type: integer - organization: *675 - previous_marketplace_purchase: &709 + organization: *682 + previous_marketplace_purchase: &716 title: Marketplace Purchase type: object properties: @@ -146615,7 +146999,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *676 + repository: *683 sender: *4 required: - action @@ -146695,10 +147079,10 @@ webhooks: - changed effective_date: type: string - enterprise: *673 - installation: *674 - marketplace_purchase: *708 - organization: *675 + enterprise: *680 + installation: *681 + marketplace_purchase: *715 + organization: *682 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -146786,7 +147170,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *676 + repository: *683 sender: *4 required: - action @@ -146868,10 +147252,10 @@ webhooks: - pending_change effective_date: type: string - enterprise: *673 - installation: *674 - marketplace_purchase: *708 - organization: *675 + enterprise: *680 + installation: *681 + marketplace_purchase: *715 + organization: *682 previous_marketplace_purchase: title: Marketplace Purchase type: object @@ -146957,7 +147341,7 @@ webhooks: - on_free_trial - free_trial_ends_on - plan - repository: *676 + repository: *683 sender: *4 required: - action @@ -147038,8 +147422,8 @@ webhooks: - pending_change_cancelled effective_date: type: string - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 marketplace_purchase: title: Marketplace Purchase type: object @@ -147125,9 +147509,9 @@ webhooks: type: integer unit_count: type: integer - organization: *675 - previous_marketplace_purchase: *709 - repository: *676 + organization: *682 + previous_marketplace_purchase: *716 + repository: *683 sender: *4 required: - action @@ -147207,12 +147591,12 @@ webhooks: - purchased effective_date: type: string - enterprise: *673 - installation: *674 - marketplace_purchase: *708 - organization: *675 - previous_marketplace_purchase: *709 - repository: *676 + enterprise: *680 + installation: *681 + marketplace_purchase: *715 + organization: *682 + previous_marketplace_purchase: *716 + repository: *683 sender: *4 required: - action @@ -147314,11 +147698,11 @@ webhooks: type: string required: - to - enterprise: *673 - installation: *674 - member: *700 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + member: *707 + organization: *682 + repository: *683 sender: *4 required: - action @@ -147420,11 +147804,11 @@ webhooks: type: - string - 'null' - enterprise: *673 - installation: *674 - member: *700 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + member: *707 + organization: *682 + repository: *683 sender: *4 required: - action @@ -147503,11 +147887,11 @@ webhooks: type: string enum: - removed - enterprise: *673 - installation: *674 - member: *700 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + member: *707 + organization: *682 + repository: *683 sender: *4 required: - action @@ -147585,11 +147969,11 @@ webhooks: type: string enum: - added - enterprise: *673 - installation: *674 - member: *700 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + member: *707 + organization: *682 + repository: *683 scope: description: The scope of the membership. Currently, can only be `team`. @@ -147667,7 +148051,7 @@ webhooks: required: - login - id - team: &710 + team: &717 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -147860,11 +148244,11 @@ webhooks: type: string enum: - removed - enterprise: *673 - installation: *674 - member: *700 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + member: *707 + organization: *682 + repository: *683 scope: description: The scope of the membership. Currently, can only be `team`. @@ -147943,7 +148327,7 @@ webhooks: required: - login - id - team: *710 + team: *717 required: - action - scope @@ -148025,8 +148409,8 @@ webhooks: type: string enum: - checks_requested - installation: *674 - merge_group: &711 + installation: *681 + merge_group: &718 type: object title: Merge Group description: A group of pull requests that the merge queue has grouped @@ -148045,15 +148429,15 @@ webhooks: description: The full ref of the branch the merge group will be merged into. type: string - head_commit: *386 + head_commit: *393 required: - head_sha - head_ref - base_sha - base_ref - head_commit - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -148139,10 +148523,10 @@ webhooks: - merged - invalidated - dequeued - installation: *674 - merge_group: *711 - organization: *675 - repository: *676 + installation: *681 + merge_group: *718 + organization: *682 + repository: *683 sender: *4 required: - action @@ -148215,7 +148599,7 @@ webhooks: type: string enum: - deleted - enterprise: *673 + enterprise: *680 hook: description: 'The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, @@ -148323,12 +148707,12 @@ webhooks: hook_id: description: The id of the modified webhook. type: integer - installation: *674 - organization: *675 + installation: *681 + organization: *682 repository: anyOf: - type: 'null' - - *676 + - *683 sender: *4 required: - action @@ -148408,11 +148792,11 @@ webhooks: type: string enum: - closed - enterprise: *673 - installation: *674 - milestone: *705 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + milestone: *712 + organization: *682 + repository: *683 sender: *4 required: - action @@ -148491,9 +148875,9 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - milestone: &712 + enterprise: *680 + installation: *681 + milestone: &719 title: Milestone description: A collection of related issues and pull requests. type: object @@ -148635,8 +149019,8 @@ webhooks: - updated_at - due_on - closed_at - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -148715,11 +149099,11 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - milestone: *705 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + milestone: *712 + organization: *682 + repository: *683 sender: *4 required: - action @@ -148829,11 +149213,11 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 - milestone: *705 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + milestone: *712 + organization: *682 + repository: *683 sender: *4 required: - action @@ -148913,11 +149297,11 @@ webhooks: type: string enum: - opened - enterprise: *673 - installation: *674 - milestone: *712 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + milestone: *719 + organization: *682 + repository: *683 sender: *4 required: - action @@ -148996,11 +149380,11 @@ webhooks: type: string enum: - blocked - blocked_user: *700 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + blocked_user: *707 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -149079,11 +149463,11 @@ webhooks: type: string enum: - unblocked - blocked_user: *700 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + blocked_user: *707 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -149162,9 +149546,9 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - membership: &713 + enterprise: *680 + installation: *681 + membership: &720 title: Membership description: The membership between the user and the organization. Not present when the action is `member_invited`. @@ -149258,8 +149642,8 @@ webhooks: - role - organization_url - user - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 required: - action @@ -149337,11 +149721,11 @@ webhooks: type: string enum: - member_added - enterprise: *673 - installation: *674 - membership: *713 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + membership: *720 + organization: *682 + repository: *683 sender: *4 required: - action @@ -149420,8 +149804,8 @@ webhooks: type: string enum: - member_invited - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 invitation: description: The invitation for the user or email if the action is `member_invited`. @@ -149543,10 +149927,10 @@ webhooks: - inviter - team_count - invitation_teams_url - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 - user: *700 + user: *707 required: - action - invitation @@ -149624,11 +150008,11 @@ webhooks: type: string enum: - member_removed - enterprise: *673 - installation: *674 - membership: *713 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + membership: *720 + organization: *682 + repository: *683 sender: *4 required: - action @@ -149715,11 +150099,11 @@ webhooks: properties: from: type: string - enterprise: *673 - installation: *674 - membership: *713 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + membership: *720 + organization: *682 + repository: *683 sender: *4 required: - action @@ -149795,9 +150179,9 @@ webhooks: type: string enum: - published - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 package: description: Information about the package. type: object @@ -150320,7 +150704,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: &714 + items: &721 title: Ruby Gems metadata type: object properties: @@ -150417,7 +150801,7 @@ webhooks: - owner - package_version - registry - repository: *676 + repository: *683 sender: *4 required: - action @@ -150493,9 +150877,9 @@ webhooks: type: string enum: - updated - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 package: description: Information about the package. type: object @@ -150857,7 +151241,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *714 + items: *721 source_url: type: string format: uri @@ -150928,7 +151312,7 @@ webhooks: - owner - package_version - registry - repository: *676 + repository: *683 sender: *4 required: - action @@ -151109,12 +151493,12 @@ webhooks: - duration - created_at - updated_at - enterprise: *673 + enterprise: *680 id: type: integer - installation: *674 - organization: *675 - repository: *676 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - id @@ -151194,7 +151578,7 @@ webhooks: type: string enum: - approved - personal_access_token_request: &715 + personal_access_token_request: &722 title: Personal Access Token Request description: Details of a Personal Access Token Request. type: object @@ -151344,10 +151728,10 @@ webhooks: - token_expired - token_expires_at - token_last_used_at - enterprise: *673 - organization: *675 + enterprise: *680 + organization: *682 sender: *4 - installation: *674 + installation: *681 required: - action - personal_access_token_request @@ -151426,11 +151810,11 @@ webhooks: type: string enum: - cancelled - personal_access_token_request: *715 - enterprise: *673 - organization: *675 + personal_access_token_request: *722 + enterprise: *680 + organization: *682 sender: *4 - installation: *674 + installation: *681 required: - action - personal_access_token_request @@ -151508,11 +151892,11 @@ webhooks: type: string enum: - created - personal_access_token_request: *715 - enterprise: *673 - organization: *675 + personal_access_token_request: *722 + enterprise: *680 + organization: *682 sender: *4 - installation: *674 + installation: *681 required: - action - personal_access_token_request @@ -151589,11 +151973,11 @@ webhooks: type: string enum: - denied - personal_access_token_request: *715 - organization: *675 - enterprise: *673 + personal_access_token_request: *722 + organization: *682 + enterprise: *680 sender: *4 - installation: *674 + installation: *681 required: - action - personal_access_token_request @@ -151697,7 +152081,7 @@ webhooks: id: description: Unique identifier of the webhook. type: integer - last_response: *716 + last_response: *723 name: description: The type of webhook. The only valid value is 'web'. type: string @@ -151729,8 +152113,8 @@ webhooks: hook_id: description: The ID of the webhook that triggered the ping. type: integer - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 zen: description: Random string of GitHub zen. @@ -151975,10 +152359,10 @@ webhooks: - from required: - note - enterprise: *673 - installation: *674 - organization: *675 - project_card: &717 + enterprise: *680 + installation: *681 + organization: *682 + project_card: &724 title: Project Card type: object properties: @@ -152101,7 +152485,7 @@ webhooks: - creator - created_at - updated_at - repository: *676 + repository: *683 sender: *4 required: - action @@ -152182,11 +152566,11 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - project_card: *717 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + project_card: *724 + repository: *683 sender: *4 required: - action @@ -152266,9 +152650,9 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 project_card: title: Project Card type: object @@ -152398,7 +152782,7 @@ webhooks: repository: anyOf: - type: 'null' - - *676 + - *683 sender: *4 required: - action @@ -152492,11 +152876,11 @@ webhooks: - from required: - note - enterprise: *673 - installation: *674 - organization: *675 - project_card: *717 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + project_card: *724 + repository: *683 sender: *4 required: - action @@ -152590,9 +152974,9 @@ webhooks: - from required: - column_id - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 project_card: allOf: - title: Project Card @@ -152789,7 +153173,7 @@ webhooks: type: string required: - after_id - repository: *676 + repository: *683 sender: *4 required: - action @@ -152869,10 +153253,10 @@ webhooks: type: string enum: - closed - enterprise: *673 - installation: *674 - organization: *675 - project: &719 + enterprise: *680 + installation: *681 + organization: *682 + project: &726 title: Project type: object properties: @@ -152999,7 +153383,7 @@ webhooks: - creator - created_at - updated_at - repository: *676 + repository: *683 sender: *4 required: - action @@ -153079,10 +153463,10 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - project_column: &718 + enterprise: *680 + installation: *681 + organization: *682 + project_column: &725 title: Project Column type: object properties: @@ -153122,7 +153506,7 @@ webhooks: - name - created_at - updated_at - repository: *676 + repository: *683 sender: *4 required: - action @@ -153201,14 +153585,14 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 - project_column: *718 + enterprise: *680 + installation: *681 + organization: *682 + project_column: *725 repository: anyOf: - type: 'null' - - *676 + - *683 sender: *4 required: - action @@ -153297,11 +153681,11 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 - organization: *675 - project_column: *718 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + project_column: *725 + repository: *683 sender: *4 required: - action @@ -153381,11 +153765,11 @@ webhooks: type: string enum: - moved - enterprise: *673 - installation: *674 - organization: *675 - project_column: *718 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + project_column: *725 + repository: *683 sender: *4 required: - action @@ -153465,11 +153849,11 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - project: *719 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + project: *726 + repository: *683 sender: *4 required: - action @@ -153549,14 +153933,14 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 - project: *719 + enterprise: *680 + installation: *681 + organization: *682 + project: *726 repository: anyOf: - type: 'null' - - *676 + - *683 sender: *4 required: - action @@ -153657,11 +154041,11 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 - organization: *675 - project: *719 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + project: *726 + repository: *683 sender: *4 required: - action @@ -153740,11 +154124,11 @@ webhooks: type: string enum: - reopened - enterprise: *673 - installation: *674 - organization: *675 - project: *719 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + project: *726 + repository: *683 sender: *4 required: - action @@ -153825,9 +154209,9 @@ webhooks: type: string enum: - closed - installation: *674 - organization: *675 - projects_v2: &720 + installation: *681 + organization: *682 + projects_v2: &727 title: Projects v2 Project description: A projects v2 project type: object @@ -153975,9 +154359,9 @@ webhooks: type: string enum: - created - installation: *674 - organization: *675 - projects_v2: *720 + installation: *681 + organization: *682 + projects_v2: *727 sender: *4 required: - action @@ -154058,9 +154442,9 @@ webhooks: type: string enum: - deleted - installation: *674 - organization: *675 - projects_v2: *720 + installation: *681 + organization: *682 + projects_v2: *727 sender: *4 required: - action @@ -154181,9 +154565,9 @@ webhooks: type: string to: type: string - installation: *674 - organization: *675 - projects_v2: *720 + installation: *681 + organization: *682 + projects_v2: *727 sender: *4 required: - action @@ -154266,7 +154650,7 @@ webhooks: type: string enum: - archived - changes: &724 + changes: &731 type: object properties: archived_at: @@ -154282,9 +154666,9 @@ webhooks: - string - 'null' format: date-time - installation: *674 - organization: *675 - projects_v2_item: &721 + installation: *681 + organization: *682 + projects_v2_item: &728 title: Projects v2 Item description: An item belonging to a project type: object @@ -154423,9 +154807,9 @@ webhooks: - 'null' to: type: string - installation: *674 - organization: *675 - projects_v2_item: *721 + installation: *681 + organization: *682 + projects_v2_item: *728 sender: *4 required: - action @@ -154507,9 +154891,9 @@ webhooks: type: string enum: - created - installation: *674 - organization: *675 - projects_v2_item: *721 + installation: *681 + organization: *682 + projects_v2_item: *728 sender: *4 required: - action @@ -154590,9 +154974,9 @@ webhooks: type: string enum: - deleted - installation: *674 - organization: *675 - projects_v2_item: *721 + installation: *681 + organization: *682 + projects_v2_item: *728 sender: *4 required: - action @@ -154697,7 +155081,7 @@ webhooks: oneOf: - type: string - type: integer - - &722 + - &729 title: Projects v2 Single Select Option description: An option for a single select field type: object @@ -154717,7 +155101,7 @@ webhooks: required: - id - name - - &723 + - &730 title: Projects v2 Iteration Setting description: An iteration setting for an iteration field type: object @@ -154746,8 +155130,8 @@ webhooks: oneOf: - type: string - type: integer - - *722 - - *723 + - *729 + - *730 type: - 'null' - string @@ -154770,9 +155154,9 @@ webhooks: - 'null' required: - body - installation: *674 - organization: *675 - projects_v2_item: *721 + installation: *681 + organization: *682 + projects_v2_item: *728 sender: *4 required: - action @@ -154869,9 +155253,9 @@ webhooks: type: - string - 'null' - installation: *674 - organization: *675 - projects_v2_item: *721 + installation: *681 + organization: *682 + projects_v2_item: *728 sender: *4 required: - action @@ -154954,10 +155338,10 @@ webhooks: type: string enum: - restored - changes: *724 - installation: *674 - organization: *675 - projects_v2_item: *721 + changes: *731 + installation: *681 + organization: *682 + projects_v2_item: *728 sender: *4 required: - action @@ -155039,9 +155423,9 @@ webhooks: type: string enum: - reopened - installation: *674 - organization: *675 - projects_v2: *720 + installation: *681 + organization: *682 + projects_v2: *727 sender: *4 required: - action @@ -155122,9 +155506,9 @@ webhooks: type: string enum: - created - installation: *674 - organization: *675 - projects_v2_status_update: &725 + installation: *681 + organization: *682 + projects_v2_status_update: &732 title: Projects v2 Status Update description: An status update belonging to a project type: object @@ -155259,9 +155643,9 @@ webhooks: type: string enum: - deleted - installation: *674 - organization: *675 - projects_v2_status_update: *725 + installation: *681 + organization: *682 + projects_v2_status_update: *732 sender: *4 required: - action @@ -155407,9 +155791,9 @@ webhooks: - string - 'null' format: date - installation: *674 - organization: *675 - projects_v2_status_update: *725 + installation: *681 + organization: *682 + projects_v2_status_update: *732 sender: *4 required: - action @@ -155480,10 +155864,10 @@ webhooks: title: public event type: object properties: - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - repository @@ -155560,13 +155944,13 @@ webhooks: type: string enum: - assigned - assignee: *700 - enterprise: *673 - installation: *674 - number: &726 + assignee: *707 + enterprise: *680 + installation: *681 + number: &733 description: The pull request number. type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -157915,7 +158299,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -157997,11 +158381,11 @@ webhooks: type: string enum: - auto_merge_disabled - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 number: type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -160343,7 +160727,7 @@ webhooks: - draft reason: type: string - repository: *676 + repository: *683 sender: *4 required: - action @@ -160425,11 +160809,11 @@ webhooks: type: string enum: - auto_merge_enabled - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 number: type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -162771,7 +163155,7 @@ webhooks: - draft reason: type: string - repository: *676 + repository: *683 sender: *4 required: - action @@ -162853,13 +163237,13 @@ webhooks: type: string enum: - closed - enterprise: *673 - installation: *674 - number: *726 - organization: *675 - pull_request: &727 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 + pull_request: &734 allOf: - - *531 + - *538 - type: object properties: allow_auto_merge: @@ -162921,7 +163305,7 @@ webhooks: Please use `squash_merge_commit_title` instead.** type: boolean default: false - repository: *676 + repository: *683 sender: *4 required: - action @@ -163002,12 +163386,12 @@ webhooks: type: string enum: - converted_to_draft - enterprise: *673 - installation: *674 - number: *726 - organization: *675 - pull_request: *727 - repository: *676 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 + pull_request: *734 + repository: *683 sender: *4 required: - action @@ -163087,11 +163471,11 @@ webhooks: type: string enum: - demilestoned - enterprise: *673 - milestone: *429 - number: *726 - organization: *675 - pull_request: &728 + enterprise: *680 + milestone: *436 + number: *733 + organization: *682 + pull_request: &735 title: Pull Request type: object properties: @@ -165418,7 +165802,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -165497,11 +165881,11 @@ webhooks: type: string enum: - dequeued - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 number: type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -167847,7 +168231,7 @@ webhooks: - BRANCH_PROTECTIONS - GIT_TREE_INVALID - INVALID_MERGE_COMMIT - repository: *676 + repository: *683 sender: *4 required: - action @@ -167971,12 +168355,12 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 - number: *726 - organization: *675 - pull_request: *727 - repository: *676 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 + pull_request: *734 + repository: *683 sender: *4 required: - action @@ -168056,11 +168440,11 @@ webhooks: type: string enum: - enqueued - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 number: type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -170391,7 +170775,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -170471,11 +170855,11 @@ webhooks: type: string enum: - labeled - enterprise: *673 - installation: *674 - label: *699 - number: *726 - organization: *675 + enterprise: *680 + installation: *681 + label: *706 + number: *733 + organization: *682 pull_request: title: Pull Request type: object @@ -172823,7 +173207,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -172904,10 +173288,10 @@ webhooks: type: string enum: - locked - enterprise: *673 - installation: *674 - number: *726 - organization: *675 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 pull_request: title: Pull Request type: object @@ -175253,7 +175637,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -175333,12 +175717,12 @@ webhooks: type: string enum: - milestoned - enterprise: *673 - milestone: *429 - number: *726 - organization: *675 - pull_request: *728 - repository: *676 + enterprise: *680 + milestone: *436 + number: *733 + organization: *682 + pull_request: *735 + repository: *683 sender: *4 required: - action @@ -175417,12 +175801,12 @@ webhooks: type: string enum: - opened - enterprise: *673 - installation: *674 - number: *726 - organization: *675 - pull_request: *727 - repository: *676 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 + pull_request: *734 + repository: *683 sender: *4 required: - action @@ -175503,12 +175887,12 @@ webhooks: type: string enum: - ready_for_review - enterprise: *673 - installation: *674 - number: *726 - organization: *675 - pull_request: *727 - repository: *676 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 + pull_request: *734 + repository: *683 sender: *4 required: - action @@ -175588,12 +175972,12 @@ webhooks: type: string enum: - reopened - enterprise: *673 - installation: *674 - number: *726 - organization: *675 - pull_request: *727 - repository: *676 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 + pull_request: *734 + repository: *683 sender: *4 required: - action @@ -175968,9 +176352,9 @@ webhooks: - start_side - side - reactions - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 pull_request: type: object properties: @@ -178200,7 +178584,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *676 + repository: *683 sender: *4 required: - action @@ -178280,7 +178664,7 @@ webhooks: type: string enum: - deleted - comment: &730 + comment: &737 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. @@ -178573,9 +178957,9 @@ webhooks: - start_side - side - reactions - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 pull_request: type: object properties: @@ -180793,7 +181177,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *676 + repository: *683 sender: *4 required: - action @@ -180873,11 +181257,11 @@ webhooks: type: string enum: - edited - changes: *729 - comment: *730 - enterprise: *673 - installation: *674 - organization: *675 + changes: *736 + comment: *737 + enterprise: *680 + installation: *681 + organization: *682 pull_request: type: object properties: @@ -183098,7 +183482,7 @@ webhooks: - _links - author_association - active_lock_reason - repository: *676 + repository: *683 sender: *4 required: - action @@ -183179,9 +183563,9 @@ webhooks: type: string enum: - dismissed - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 pull_request: title: Simple Pull Request type: object @@ -185414,7 +185798,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *676 + repository: *683 review: description: The review that was affected. type: object @@ -185660,9 +186044,9 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 pull_request: title: Simple Pull Request type: object @@ -187776,8 +188160,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *676 - review: &731 + repository: *683 + review: &738 description: The review that was affected. type: object properties: @@ -188010,12 +188394,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 number: description: The pull request number. type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -190362,7 +190746,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 requested_reviewer: title: User type: @@ -190448,12 +190832,12 @@ webhooks: type: string enum: - review_request_removed - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 number: description: The pull request number. type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -192807,7 +193191,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 requested_team: title: Team description: Groups of organization members that gives permissions @@ -193002,12 +193386,12 @@ webhooks: type: string enum: - review_requested - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 number: description: The pull request number. type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -195356,7 +195740,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 requested_reviewer: title: User type: @@ -195443,12 +195827,12 @@ webhooks: type: string enum: - review_requested - enterprise: *673 - installation: *674 + enterprise: *680 + installation: *681 number: description: The pull request number. type: integer - organization: *675 + organization: *682 pull_request: title: Pull Request type: object @@ -197788,7 +198172,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 requested_team: title: Team description: Groups of organization members that gives permissions @@ -197972,9 +198356,9 @@ webhooks: type: string enum: - submitted - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 pull_request: title: Simple Pull Request type: object @@ -200210,8 +200594,8 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *676 - review: *731 + repository: *683 + review: *738 sender: *4 required: - action @@ -200291,9 +200675,9 @@ webhooks: type: string enum: - resolved - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 pull_request: title: Simple Pull Request type: object @@ -202424,7 +202808,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *676 + repository: *683 sender: *4 thread: type: object @@ -202816,9 +203200,9 @@ webhooks: type: string enum: - unresolved - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 pull_request: title: Simple Pull Request type: object @@ -204932,7 +205316,7 @@ webhooks: - author_association - auto_merge - active_lock_reason - repository: *676 + repository: *683 sender: *4 thread: type: object @@ -205326,10 +205710,10 @@ webhooks: type: string before: type: string - enterprise: *673 - installation: *674 - number: *726 - organization: *675 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 pull_request: title: Pull Request type: object @@ -207664,7 +208048,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -207746,11 +208130,11 @@ webhooks: type: string enum: - unassigned - assignee: *732 - enterprise: *673 - installation: *674 - number: *726 - organization: *675 + assignee: *739 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 pull_request: title: Pull Request type: object @@ -210100,7 +210484,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -210179,11 +210563,11 @@ webhooks: type: string enum: - unlabeled - enterprise: *673 - installation: *674 - label: *699 - number: *726 - organization: *675 + enterprise: *680 + installation: *681 + label: *706 + number: *733 + organization: *682 pull_request: title: Pull Request type: object @@ -212522,7 +212906,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -212603,10 +212987,10 @@ webhooks: type: string enum: - unlocked - enterprise: *673 - installation: *674 - number: *726 - organization: *675 + enterprise: *680 + installation: *681 + number: *733 + organization: *682 pull_request: title: Pull Request type: object @@ -214935,7 +215319,7 @@ webhooks: - auto_merge - active_lock_reason - draft - repository: *676 + repository: *683 sender: *4 required: - action @@ -215138,7 +215522,7 @@ webhooks: deleted: description: Whether this push deleted the `ref`. type: boolean - enterprise: *673 + enterprise: *680 forced: description: Whether this push was a force push of the `ref`. type: boolean @@ -215233,8 +215617,8 @@ webhooks: - url - author - committer - installation: *674 - organization: *675 + installation: *681 + organization: *682 pusher: title: Committer description: Metaproperties for Git author/committer information. @@ -215822,9 +216206,9 @@ webhooks: type: string enum: - published - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 registry_package: type: object properties: @@ -216301,7 +216685,7 @@ webhooks: type: string rubygems_metadata: type: array - items: *714 + items: *721 summary: type: string tag_name: @@ -216357,7 +216741,7 @@ webhooks: - owner - package_version - registry - repository: *676 + repository: *683 sender: *4 required: - action @@ -216435,9 +216819,9 @@ webhooks: type: string enum: - updated - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 registry_package: type: object properties: @@ -216749,7 +217133,7 @@ webhooks: - published_at rubygems_metadata: type: array - items: *714 + items: *721 summary: type: string tag_name: @@ -216799,7 +217183,7 @@ webhooks: - owner - package_version - registry - repository: *676 + repository: *683 sender: *4 required: - action @@ -216876,10 +217260,10 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - release: &733 + enterprise: *680 + installation: *681 + organization: *682 + release: &740 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -217195,7 +217579,7 @@ webhooks: - tarball_url - zipball_url - body - repository: *676 + repository: *683 sender: *4 required: - action @@ -217272,11 +217656,11 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 - release: *733 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + release: *740 + repository: *683 sender: *4 required: - action @@ -217384,11 +217768,11 @@ webhooks: type: boolean required: - to - enterprise: *673 - installation: *674 - organization: *675 - release: *733 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + release: *740 + repository: *683 sender: *4 required: - action @@ -217466,9 +217850,9 @@ webhooks: type: string enum: - prereleased - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 release: title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) @@ -217789,7 +218173,7 @@ webhooks: - string - 'null' format: uri - repository: *676 + repository: *683 sender: *4 required: - action @@ -217865,10 +218249,10 @@ webhooks: type: string enum: - published - enterprise: *673 - installation: *674 - organization: *675 - release: &734 + enterprise: *680 + installation: *681 + organization: *682 + release: &741 title: Release description: The [release](https://docs.github.com/enterprise-cloud@latest//rest/releases/releases/#get-a-release) object. @@ -218186,7 +218570,7 @@ webhooks: - string - 'null' format: uri - repository: *676 + repository: *683 sender: *4 required: - action @@ -218262,11 +218646,11 @@ webhooks: type: string enum: - released - enterprise: *673 - installation: *674 - organization: *675 - release: *733 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + release: *740 + repository: *683 sender: *4 required: - action @@ -218342,11 +218726,11 @@ webhooks: type: string enum: - unpublished - enterprise: *673 - installation: *674 - organization: *675 - release: *734 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + release: *741 + repository: *683 sender: *4 required: - action @@ -218422,11 +218806,11 @@ webhooks: type: string enum: - published - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - repository_advisory: *585 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + repository_advisory: *592 sender: *4 required: - action @@ -218502,11 +218886,11 @@ webhooks: type: string enum: - reported - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - repository_advisory: *585 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + repository_advisory: *592 sender: *4 required: - action @@ -218582,10 +218966,10 @@ webhooks: type: string enum: - archived - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -218662,10 +219046,10 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -218743,10 +219127,10 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -218831,10 +219215,10 @@ webhooks: additionalProperties: true description: The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body. - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -218949,10 +219333,10 @@ webhooks: - 'null' items: type: string - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -219024,10 +219408,10 @@ webhooks: title: repository_import event type: object properties: - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 status: type: string @@ -219108,10 +219492,10 @@ webhooks: type: string enum: - privatized - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -219188,10 +219572,10 @@ webhooks: type: string enum: - publicized - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -219285,10 +219669,10 @@ webhooks: - name required: - repository - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -219368,11 +219752,11 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - repository_ruleset: *273 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + repository_ruleset: *105 sender: *4 required: - action @@ -219450,11 +219834,11 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - repository_ruleset: *273 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + repository_ruleset: *105 sender: *4 required: - action @@ -219532,11 +219916,11 @@ webhooks: type: string enum: - edited - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - repository_ruleset: *273 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + repository_ruleset: *105 changes: type: object properties: @@ -219555,16 +219939,16 @@ webhooks: properties: added: type: array - items: *267 + items: *98 deleted: type: array - items: *267 + items: *98 updated: type: array items: type: object properties: - condition: *267 + condition: *98 changes: type: object properties: @@ -219597,16 +219981,16 @@ webhooks: properties: added: type: array - items: *272 + items: *104 deleted: type: array - items: *272 + items: *104 updated: type: array items: type: object properties: - rule: *272 + rule: *104 changes: type: object properties: @@ -219843,10 +220227,10 @@ webhooks: - from required: - owner - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -219924,10 +220308,10 @@ webhooks: type: string enum: - unarchived - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -220005,7 +220389,7 @@ webhooks: type: string enum: - create - alert: &735 + alert: &742 title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object @@ -220129,10 +220513,10 @@ webhooks: type: string enum: - open - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -220342,10 +220726,10 @@ webhooks: type: string enum: - dismissed - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -220423,11 +220807,11 @@ webhooks: type: string enum: - reopen - alert: *735 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + alert: *742 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -220629,10 +221013,10 @@ webhooks: enum: - fixed - open - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -220710,7 +221094,7 @@ webhooks: type: string enum: - created - alert: &736 + alert: &743 type: object properties: number: *81 @@ -220791,6 +221175,12 @@ webhooks: anyOf: - type: 'null' - *4 + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection + bypass. push_protection_bypass_request_comment: type: - string @@ -220814,10 +221204,10 @@ webhooks: - 'null' description: Whether the detected secret was found in multiple repositories in the same organization or business. - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -220898,11 +221288,11 @@ webhooks: type: string enum: - created - alert: *736 - installation: *674 - location: *737 - organization: *675 - repository: *676 + alert: *743 + installation: *681 + location: *744 + organization: *682 + repository: *683 sender: *4 required: - location @@ -221140,11 +221530,11 @@ webhooks: type: string enum: - publicly_leaked - alert: *736 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + alert: *743 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -221222,11 +221612,11 @@ webhooks: type: string enum: - reopened - alert: *736 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + alert: *743 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -221304,11 +221694,11 @@ webhooks: type: string enum: - resolved - alert: *736 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + alert: *743 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -221386,11 +221776,11 @@ webhooks: type: string enum: - validated - alert: *736 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + alert: *743 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -221466,11 +221856,11 @@ webhooks: type: string enum: - published - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - security_advisory: &738 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + security_advisory: &745 description: The details of the security advisory, including summary, description, and severity. type: object @@ -221656,11 +222046,11 @@ webhooks: type: string enum: - updated - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 - security_advisory: *738 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 + security_advisory: *745 sender: *4 required: - action @@ -221733,10 +222123,10 @@ webhooks: type: string enum: - withdrawn - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 security_advisory: description: The details of the security advisory, including summary, description, and severity. @@ -221922,11 +222312,11 @@ webhooks: from: type: object properties: - security_and_analysis: *264 - enterprise: *673 - installation: *674 - organization: *675 - repository: *325 + security_and_analysis: *277 + enterprise: *680 + installation: *681 + organization: *682 + repository: *332 sender: *4 required: - changes @@ -222004,12 +222394,12 @@ webhooks: type: string enum: - cancelled - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - sponsorship: &739 + sponsorship: &746 type: object properties: created_at: @@ -222314,12 +222704,12 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - sponsorship: *739 + sponsorship: *746 required: - action - sponsorship @@ -222407,12 +222797,12 @@ webhooks: type: string required: - from - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - sponsorship: *739 + sponsorship: *746 required: - action - changes @@ -222489,17 +222879,17 @@ webhooks: type: string enum: - pending_cancellation - effective_date: &740 + effective_date: &747 description: The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - sponsorship: *739 + sponsorship: *746 required: - action - sponsorship @@ -222573,7 +222963,7 @@ webhooks: type: string enum: - pending_tier_change - changes: &741 + changes: &748 type: object properties: tier: @@ -222617,13 +223007,13 @@ webhooks: - from required: - tier - effective_date: *740 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + effective_date: *747 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - sponsorship: *739 + sponsorship: *746 required: - action - changes @@ -222700,13 +223090,13 @@ webhooks: type: string enum: - tier_changed - changes: *741 - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + changes: *748 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - sponsorship: *739 + sponsorship: *746 required: - action - changes @@ -222780,10 +223170,10 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -222867,10 +223257,10 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 starred_at: description: 'The time the star was created. This is a timestamp @@ -223303,15 +223693,15 @@ webhooks: type: - string - 'null' - enterprise: *673 + enterprise: *680 id: description: The unique identifier of the status. type: integer - installation: *674 + installation: *681 name: type: string - organization: *675 - repository: *676 + organization: *682 + repository: *683 sender: *4 sha: description: The Commit SHA. @@ -223421,15 +223811,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *116 + parent_issue: *128 parent_issue_repo: *55 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *116 - installation: *674 - organization: *675 - repository: *676 + sub_issue: *128 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -223513,15 +223903,15 @@ webhooks: parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *116 + parent_issue: *128 parent_issue_repo: *55 sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *116 - installation: *674 - organization: *675 - repository: *676 + sub_issue: *128 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -223605,15 +223995,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *116 + sub_issue: *128 sub_issue_repo: *55 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *116 - installation: *674 - organization: *675 - repository: *676 + parent_issue: *128 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -223697,15 +224087,15 @@ webhooks: sub_issue_id: description: The ID of the sub-issue. type: number - sub_issue: *116 + sub_issue: *128 sub_issue_repo: *55 parent_issue_id: description: The ID of the parent issue. type: number - parent_issue: *116 - installation: *674 - organization: *675 - repository: *676 + parent_issue: *128 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -223782,12 +224172,12 @@ webhooks: title: team_add event type: object properties: - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - team: &742 + team: &749 title: Team description: Groups of organization members that gives permissions on specified repositories. @@ -223980,9 +224370,9 @@ webhooks: type: string enum: - added_to_repository - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 repository: title: Repository description: A git repository @@ -224452,7 +224842,7 @@ webhooks: - topics - visibility sender: *4 - team: *742 + team: *749 required: - action - team @@ -224528,9 +224918,9 @@ webhooks: type: string enum: - created - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 repository: title: Repository description: A git repository @@ -225000,7 +225390,7 @@ webhooks: - topics - visibility sender: *4 - team: *742 + team: *749 required: - action - team @@ -225077,9 +225467,9 @@ webhooks: type: string enum: - deleted - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 repository: title: Repository description: A git repository @@ -225549,7 +225939,7 @@ webhooks: - topics - visibility sender: *4 - team: *742 + team: *749 required: - action - team @@ -225693,9 +226083,9 @@ webhooks: - from required: - permissions - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 repository: title: Repository description: A git repository @@ -226165,7 +226555,7 @@ webhooks: - topics - visibility sender: *4 - team: *742 + team: *749 required: - action - changes @@ -226243,9 +226633,9 @@ webhooks: type: string enum: - removed_from_repository - enterprise: *673 - installation: *674 - organization: *675 + enterprise: *680 + installation: *681 + organization: *682 repository: title: Repository description: A git repository @@ -226715,7 +227105,7 @@ webhooks: - topics - visibility sender: *4 - team: *742 + team: *749 required: - action - team @@ -226791,10 +227181,10 @@ webhooks: type: string enum: - started - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 required: - action @@ -226867,17 +227257,17 @@ webhooks: title: workflow_dispatch event type: object properties: - enterprise: *673 + enterprise: *680 inputs: type: - object - 'null' additionalProperties: true - installation: *674 - organization: *675 + installation: *681 + organization: *682 ref: type: string - repository: *676 + repository: *683 sender: *4 workflow: type: string @@ -226959,10 +227349,10 @@ webhooks: type: string enum: - completed - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 workflow_job: allOf: @@ -227218,7 +227608,7 @@ webhooks: type: string required: - conclusion - deployment: *449 + deployment: *456 required: - action - repository @@ -227297,10 +227687,10 @@ webhooks: type: string enum: - in_progress - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 workflow_job: allOf: @@ -227582,7 +227972,7 @@ webhooks: required: - status - steps - deployment: *449 + deployment: *456 required: - action - repository @@ -227661,10 +228051,10 @@ webhooks: type: string enum: - queued - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 workflow_job: type: object @@ -227810,7 +228200,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *449 + deployment: *456 required: - action - repository @@ -227889,10 +228279,10 @@ webhooks: type: string enum: - waiting - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 workflow_job: type: object @@ -228039,7 +228429,7 @@ webhooks: - workflow_name - head_branch - created_at - deployment: *449 + deployment: *456 required: - action - repository @@ -228119,12 +228509,12 @@ webhooks: type: string enum: - completed - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - workflow: *695 + workflow: *702 workflow_run: title: Workflow Run type: object @@ -229143,12 +229533,12 @@ webhooks: type: string enum: - in_progress - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - workflow: *695 + workflow: *702 workflow_run: title: Workflow Run type: object @@ -230152,12 +230542,12 @@ webhooks: type: string enum: - requested - enterprise: *673 - installation: *674 - organization: *675 - repository: *676 + enterprise: *680 + installation: *681 + organization: *682 + repository: *683 sender: *4 - workflow: *695 + workflow: *702 workflow_run: title: Workflow Run type: object diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index 781f25879..95223dab9 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -5061,7 +5061,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-user-management" @@ -5148,7 +5148,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-metrics" @@ -5235,7 +5235,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-usage" @@ -5605,6 +5605,30 @@ "$ref": "#/components/parameters/custom-property-name" } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/custom-property-set-payload" + }, + "examples": { + "default": { + "value": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, "responses": { "200": { "description": "Response", @@ -5673,6 +5697,370 @@ } } }, + "/enterprises/{enterprise}/rulesets": { + "post": { + "summary": "Create an enterprise repository ruleset", + "description": "Create a repository ruleset for an enterprise.", + "tags": [ + "repos" + ], + "operationId": "repos/create-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "description": "Request body", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ], + "default": "branch" + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/enterprise-ruleset-conditions" + }, + "rules": { + "type": "array", + "description": "An array of rules within the ruleset.", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + } + }, + "required": [ + "name", + "enforcement" + ] + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "repository", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "org_name": { + "include": [ + "important_org" + ], + "exclude": [ + "unimportant_org" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "rules" + } + } + }, + "/enterprises/{enterprise}/rulesets/{ruleset_id}": { + "get": { + "summary": "Get an enterprise repository ruleset", + "description": "Get a repository ruleset for an enterprise.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", + "tags": [ + "repos" + ], + "operationId": "repos/get-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "rules" + } + }, + "put": { + "summary": "Update an enterprise repository ruleset", + "description": "Update a ruleset for an enterprise.", + "tags": [ + "repos" + ], + "operationId": "repos/update-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "description": "Request body", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/enterprise-ruleset-conditions" + }, + "rules": { + "description": "An array of rules within the ruleset.", + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "repository", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "org_name": { + "include": [ + "important_org" + ], + "exclude": [ + "unimportant_org" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "rules" + } + }, + "delete": { + "summary": "Delete an enterprise repository ruleset", + "description": "Delete a ruleset for an enterprise.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "rules" + } + } + }, "/enterprises/{enterprise}/secret-scanning/alerts": { "get": { "summary": "List secret scanning alerts for an enterprise", @@ -6277,7 +6665,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-metrics" @@ -6367,7 +6755,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-usage" @@ -13206,6 +13594,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -23112,67 +23503,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - } - }, - "required": [ - "value_type" - ] + "$ref": "#/components/schemas/custom-property-set-payload" }, "examples": { "default": { @@ -24030,7 +24361,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ], "default": "branch" }, @@ -24359,7 +24691,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "enforcement": { @@ -34395,6 +34728,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -73599,6 +73935,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -107301,663 +107640,2131 @@ "value_type" ] }, - "secret-scanning-alert-state": { - "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" - ] - }, - "secret-scanning-alert-resolution": { - "type": [ - "string", - "null" - ], - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - null - ] - }, - "organization-secret-scanning-alert": { + "custom-property-set-payload": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", "type": "object", "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" - }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" - }, - "updated_at": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/alert-updated-at" - } - ] - }, - "url": { - "$ref": "#/components/schemas/alert-url" - }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" - }, - "locations_url": { + "value_type": { "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "$ref": "#/components/schemas/secret-scanning-alert-state" - }, - "resolution": { - "$ref": "#/components/schemas/secret-scanning-alert-resolution" - }, - "resolved_at": { - "type": [ + "enum": [ "string", - "null" + "single_select", + "multi_select", + "true_false" ], - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "resolved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } + "description": "The type of the value for the property", + "examples": [ + "single_select" ] }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret_type_display_name": { - "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." - }, - "repository": { - "$ref": "#/components/schemas/simple-repository" - }, - "push_protection_bypassed": { - "type": [ - "boolean", - "null" - ], - "description": "Whether push protection was bypassed for the detected secret." + "required": { + "type": "boolean", + "description": "Whether the property is required." }, - "push_protection_bypassed_by": { - "anyOf": [ + "default_value": { + "oneOf": [ { - "type": "null" + "type": "string" }, { - "$ref": "#/components/schemas/simple-user" + "type": "array", + "items": { + "type": "string" + } } - ] - }, - "push_protection_bypassed_at": { + ], + "description": "Default value of the property", "type": [ + "null", "string", - "null" - ], - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "push_protection_bypass_request_reviewer": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } + "array" ] }, - "push_protection_bypass_request_comment": { + "description": { "type": [ "string", "null" ], - "description": "An optional comment when requesting a push protection bypass." + "description": "Short description of the property" }, - "push_protection_bypass_request_html_url": { + "allowed_values": { "type": [ - "string", + "array", "null" ], - "format": "uri", - "description": "The URL to a push protection bypass request." - }, - "resolution_comment": { + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + }, + "required": [ + "value_type" + ] + }, + "repository-rule-enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "repository-ruleset-bypass-actor": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { "type": [ - "string", + "integer", "null" ], - "description": "The comment that was optionally added when this alert was closed" + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, - "validity": { + "actor_type": { "type": "string", - "description": "The token status as of the latest validity check.", "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": [ - "boolean", - "null" + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "EnterpriseOwner" ], - "description": "Whether the secret was publicly leaked." + "description": "The type of actor that can bypass a ruleset" }, - "multi_repo": { - "type": [ - "boolean", - "null" + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" ], - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise." + "default": "always" } } }, - "actions-billing-usage": { + "enterprise-ruleset-conditions-organization-name-target": { + "title": "Repository ruleset conditions for organization names", "type": "object", + "description": "Parameters for an organization name condition", "properties": { - "total_minutes_used": { - "type": "integer", - "description": "The sum of the free and paid GitHub Actions minutes used." - }, - "total_paid_minutes_used": { - "type": "integer", - "description": "The total paid GitHub Actions minutes used." - }, - "included_minutes": { - "type": "integer", - "description": "The amount of free GitHub Actions minutes available." - }, - "minutes_used_breakdown": { + "organization_name": { "type": "object", "properties": { - "UBUNTU": { - "type": "integer", - "description": "Total minutes used on Ubuntu runner machines." - }, - "MACOS": { - "type": "integer", - "description": "Total minutes used on macOS runner machines." - }, - "WINDOWS": { - "type": "integer", - "description": "Total minutes used on Windows runner machines." - }, - "ubuntu_4_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 4 core runner machines." - }, - "ubuntu_8_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 8 core runner machines." - }, - "ubuntu_16_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 16 core runner machines." - }, - "ubuntu_32_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 32 core runner machines." - }, - "ubuntu_64_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 64 core runner machines." - }, - "windows_4_core": { - "type": "integer", - "description": "Total minutes used on Windows 4 core runner machines." - }, - "windows_8_core": { - "type": "integer", - "description": "Total minutes used on Windows 8 core runner machines." - }, - "windows_16_core": { - "type": "integer", - "description": "Total minutes used on Windows 16 core runner machines." - }, - "windows_32_core": { - "type": "integer", - "description": "Total minutes used on Windows 32 core runner machines." - }, - "windows_64_core": { - "type": "integer", - "description": "Total minutes used on Windows 64 core runner machines." - }, - "macos_12_core": { - "type": "integer", - "description": "Total minutes used on macOS 12 core runner machines." + "include": { + "type": "array", + "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", + "items": { + "type": "string" + } }, - "total": { - "type": "integer", - "description": "Total minutes used on all runner machines." + "exclude": { + "type": "array", + "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } } } } }, "required": [ - "total_minutes_used", - "total_paid_minutes_used", - "included_minutes", - "minutes_used_breakdown" + "organization_name" ] }, - "advanced-security-active-committers-user": { + "repository-ruleset-conditions-repository-name-target": { + "title": "Repository ruleset conditions for repository names", "type": "object", + "description": "Parameters for a repository name condition", "properties": { - "user_login": { - "type": "string" - }, - "last_pushed_date": { - "type": "string", - "examples": [ - "2021-11-03" - ] - }, - "last_pushed_email": { - "type": "string", - "examples": [ - "monalisa@github.com" - ] + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } } }, "required": [ - "user_login", - "last_pushed_date", - "last_pushed_email" + "repository_name" ] }, - "advanced-security-active-committers-repository": { + "repository-ruleset-conditions": { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + "repository-ruleset-conditions-repository-property-spec": { + "title": "Repository ruleset property targeting definition", "type": "object", + "description": "Parameters for a targeting a repository property", "properties": { "name": { "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "advanced_security_committers": { - "type": "integer", - "examples": [ - 25 - ] + "description": "The name of the repository property to target" }, - "advanced_security_committers_breakdown": { + "property_values": { "type": "array", + "description": "The values to match for the repository property", "items": { - "$ref": "#/components/schemas/advanced-security-active-committers-user" + "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ "name", - "advanced_security_committers", - "advanced_security_committers_breakdown" + "property_values" ] }, - "advanced-security-active-committers": { + "repository-ruleset-conditions-repository-property-target": { + "title": "Repository ruleset conditions for repository properties", "type": "object", + "description": "Parameters for a repository property condition", "properties": { - "total_advanced_security_committers": { - "type": "integer", - "examples": [ - 25 - ] - }, - "total_count": { - "type": "integer", - "examples": [ - 2 - ] - }, - "maximum_advanced_security_committers": { - "type": "integer", - "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security", - "examples": [ - 4 - ] - }, - "purchased_advanced_security_committers": { - "type": "integer", - "description": "The total number of GitHub Advanced Security licences purchased", - "examples": [ - 4 - ] - }, - "repositories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/advanced-security-active-committers-repository" + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + } + } } } }, "required": [ - "repositories" + "repository_property" ] }, - "get-all-cost-centers": { + "enterprise-ruleset-conditions-organization-id-target": { + "title": "Repository ruleset conditions for organization IDs", "type": "object", + "description": "Parameters for an organization ID condition", "properties": { - "costCenters": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID of the cost center." - }, - "name": { - "type": "string", - "description": "Name of the cost center." - }, - "resources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type of the resource." - }, - "name": { - "type": "string", - "description": "Name of the resource." - } - }, - "required": [ - "type", - "name" - ] - } + "organization_id": { + "type": "object", + "properties": { + "organization_ids": { + "type": "array", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" } - }, - "required": [ - "id", - "name", - "resources" - ] + } } } - } - }, - "packages-billing-usage": { - "type": "object", - "properties": { - "total_gigabytes_bandwidth_used": { - "type": "integer", - "description": "Sum of the free and paid storage space (GB) for GitHuub Packages." - }, - "total_paid_gigabytes_bandwidth_used": { - "type": "integer", - "description": "Total paid storage space (GB) for GitHuub Packages." - }, - "included_gigabytes_bandwidth": { - "type": "integer", - "description": "Free storage space (GB) for GitHub Packages." - } }, "required": [ - "total_gigabytes_bandwidth_used", - "total_paid_gigabytes_bandwidth_used", - "included_gigabytes_bandwidth" + "organization_id" ] }, - "combined-billing-usage": { + "enterprise-ruleset-conditions": { + "title": "Enterprise ruleset conditions", "type": "object", - "properties": { - "days_left_in_billing_cycle": { - "type": "integer", - "description": "Numbers of days left in billing cycle." + "description": "Conditions for an enterprise ruleset. The conditions object should contain either the `organization_id` or `organization_name` property and the `repository_name` or `repository_property` property. For branch and tag rulesets, the conditions object should also contain the `ref_name` property.", + "oneOf": [ + { + "type": "object", + "title": "organization_name_and_repository_name", + "description": "Conditions to target organizations by name and all repositories", + "allOf": [ + { + "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-name-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + ] }, - "estimated_paid_storage_for_month": { - "type": "integer", - "description": "Estimated storage space (GB) used in billing cycle." + { + "type": "object", + "title": "organization_name_and_repository_property", + "description": "Conditions to target organizations by name and repositories by property", + "allOf": [ + { + "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-name-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + ] }, - "estimated_storage_for_month": { - "type": "integer", - "description": "Estimated sum of free and paid storage space (GB) used in billing cycle." + { + "type": "object", + "title": "organization_id_and_repository_name", + "description": "Conditions to target organizations by id and all repositories", + "allOf": [ + { + "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-id-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_property", + "description": "Conditions to target organization by id and repositories by property", + "allOf": [ + { + "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-id-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + ] } - }, - "required": [ - "days_left_in_billing_cycle", - "estimated_paid_storage_for_month", - "estimated_storage_for_month" ] }, - "billing-usage-report": { + "repository-rule-creation": { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", + "required": [ + "type" + ], "properties": { - "usageItems": { - "type": "array", - "items": { - "type": "object", - "properties": { - "date": { - "type": "string", - "description": "Date of the usage line item." - }, - "product": { - "type": "string", - "description": "Product name." - }, - "sku": { - "type": "string", - "description": "SKU name." - }, - "quantity": { - "type": "integer", - "description": "Quantity of the usage line item." - }, - "unitType": { - "type": "string", - "description": "Unit type of the usage line item." - }, - "pricePerUnit": { - "type": "number", - "description": "Price per unit of the usage line item." - }, - "grossAmount": { - "type": "number", - "description": "Gross amount of the usage line item." - }, - "discountAmount": { - "type": "number", - "description": "Discount amount of the usage line item." - }, - "netAmount": { - "type": "number", - "description": "Net amount of the usage line item." - }, - "organizationName": { - "type": "string", - "description": "Name of the organization." - }, - "repositoryName": { - "type": "string", - "description": "Name of the repository." - } - }, - "required": [ - "date", - "product", - "sku", - "quantity", - "unitType", - "pricePerUnit", - "grossAmount", - "discountAmount", - "netAmount", - "organizationName" - ] - } + "type": { + "type": "string", + "enum": [ + "creation" + ] } } }, - "actor": { - "title": "Actor", - "description": "Actor", + "repository-rule-update": { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", + "required": [ + "type" + ], "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { + "type": { "type": "string", - "format": "uri" + "enum": [ + "update" + ] }, - "avatar_url": { - "type": "string", - "format": "uri" + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] + } }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "repository-rule-deletion": { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", + "required": [ + "type" + ], "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" + "enum": [ + "deletion" ] - }, - "labels_url": { + } + } + }, + "repository-rule-required-linear-history": { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 + "enum": [ + "required_linear_history" ] - }, - "node_id": { + } + } + }, + "repository-rule-merge-queue": { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" + "enum": [ + "merge_queue" ] }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" ] - }, - "state": { - "description": "The state of the milestone.", + } + } + }, + "repository-rule-required-deployments": { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" + "required_deployments" ] }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } } + }, + "required": [ + "required_deployment_environments" ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 + } + } + }, + "repository-rule-required-signatures": { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" ] + } + } + }, + "repository-rule-params-required-reviewer-configuration": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files.", + "items": { + "type": "string" + } }, - "closed_issues": { + "minimum_approvals": { "type": "integer", - "examples": [ - 8 - ] + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." }, - "created_at": { + "reviewer_id": { "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { + "description": "Node ID of the team which must review changes to matching files." + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer_id" + ] + }, + "repository-rule-pull-request": { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + "repository-rule-params-status-check-configuration": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + }, + "repository-rule-required-status-checks": { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-status-check-configuration" + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + "repository-rule-non-fast-forward": { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + "repository-rule-commit-message-pattern": { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + "repository-rule-commit-author-email-pattern": { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + "repository-rule-committer-email-pattern": { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + "repository-rule-branch-name-pattern": { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + "repository-rule-tag-name-pattern": { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + "repository-rule-params-restricted-commits": { + "title": "RestrictedCommits", + "description": "Restricted commit", + "type": "object", + "properties": { + "oid": { + "type": "string", + "description": "Full or abbreviated commit hash to reject" + }, + "reason": { + "type": "string", + "description": "Reason for restriction" + } + }, + "required": [ + "oid" + ] + }, + "repository-rule-params-workflow-file-reference": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + }, + "repository-rule-workflows": { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + "repository-rule-params-code-scanning-tool": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + }, + "repository-rule-code-scanning": { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + "repository-rule": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "$ref": "#/components/schemas/repository-rule-creation" + }, + { + "$ref": "#/components/schemas/repository-rule-update" + }, + { + "$ref": "#/components/schemas/repository-rule-deletion" + }, + { + "$ref": "#/components/schemas/repository-rule-required-linear-history" + }, + { + "$ref": "#/components/schemas/repository-rule-merge-queue" + }, + { + "$ref": "#/components/schemas/repository-rule-required-deployments" + }, + { + "$ref": "#/components/schemas/repository-rule-required-signatures" + }, + { + "$ref": "#/components/schemas/repository-rule-pull-request" + }, + { + "$ref": "#/components/schemas/repository-rule-required-status-checks" + }, + { + "$ref": "#/components/schemas/repository-rule-non-fast-forward" + }, + { + "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths", + "minimum": 1, + "maximum": 256 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "$ref": "#/components/schemas/repository-rule-workflows" + }, + { + "$ref": "#/components/schemas/repository-rule-code-scanning" + } + ] + }, + "repository-ruleset-conditions-repository-id-target": { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + }, + "org-ruleset-conditions": { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + } + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + } + ] + } + ] + }, + "repository-ruleset": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] + }, + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": [ + "object", + "null" + ], + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "anyOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/org-ruleset-conditions" + } + ], + "type": [ + "null", + "object" + ] + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "secret-scanning-alert-state": { + "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" + ] + }, + "secret-scanning-alert-resolution": { + "type": [ + "string", + "null" + ], + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + null + ] + }, + "organization-secret-scanning-alert": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/alert-updated-at" + } + ] + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + }, + "repository": { + "$ref": "#/components/schemas/simple-repository" + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment that was optionally added when this alert was closed" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise." + } + } + }, + "actions-billing-usage": { + "type": "object", + "properties": { + "total_minutes_used": { + "type": "integer", + "description": "The sum of the free and paid GitHub Actions minutes used." + }, + "total_paid_minutes_used": { + "type": "integer", + "description": "The total paid GitHub Actions minutes used." + }, + "included_minutes": { + "type": "integer", + "description": "The amount of free GitHub Actions minutes available." + }, + "minutes_used_breakdown": { + "type": "object", + "properties": { + "UBUNTU": { + "type": "integer", + "description": "Total minutes used on Ubuntu runner machines." + }, + "MACOS": { + "type": "integer", + "description": "Total minutes used on macOS runner machines." + }, + "WINDOWS": { + "type": "integer", + "description": "Total minutes used on Windows runner machines." + }, + "ubuntu_4_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 4 core runner machines." + }, + "ubuntu_8_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 8 core runner machines." + }, + "ubuntu_16_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 16 core runner machines." + }, + "ubuntu_32_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 32 core runner machines." + }, + "ubuntu_64_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 64 core runner machines." + }, + "windows_4_core": { + "type": "integer", + "description": "Total minutes used on Windows 4 core runner machines." + }, + "windows_8_core": { + "type": "integer", + "description": "Total minutes used on Windows 8 core runner machines." + }, + "windows_16_core": { + "type": "integer", + "description": "Total minutes used on Windows 16 core runner machines." + }, + "windows_32_core": { + "type": "integer", + "description": "Total minutes used on Windows 32 core runner machines." + }, + "windows_64_core": { + "type": "integer", + "description": "Total minutes used on Windows 64 core runner machines." + }, + "macos_12_core": { + "type": "integer", + "description": "Total minutes used on macOS 12 core runner machines." + }, + "total": { + "type": "integer", + "description": "Total minutes used on all runner machines." + } + } + } + }, + "required": [ + "total_minutes_used", + "total_paid_minutes_used", + "included_minutes", + "minutes_used_breakdown" + ] + }, + "advanced-security-active-committers-user": { + "type": "object", + "properties": { + "user_login": { + "type": "string" + }, + "last_pushed_date": { + "type": "string", + "examples": [ + "2021-11-03" + ] + }, + "last_pushed_email": { + "type": "string", + "examples": [ + "monalisa@github.com" + ] + } + }, + "required": [ + "user_login", + "last_pushed_date", + "last_pushed_email" + ] + }, + "advanced-security-active-committers-repository": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "advanced_security_committers": { + "type": "integer", + "examples": [ + 25 + ] + }, + "advanced_security_committers_breakdown": { + "type": "array", + "items": { + "$ref": "#/components/schemas/advanced-security-active-committers-user" + } + } + }, + "required": [ + "name", + "advanced_security_committers", + "advanced_security_committers_breakdown" + ] + }, + "advanced-security-active-committers": { + "type": "object", + "properties": { + "total_advanced_security_committers": { + "type": "integer", + "examples": [ + 25 + ] + }, + "total_count": { + "type": "integer", + "examples": [ + 2 + ] + }, + "maximum_advanced_security_committers": { + "type": "integer", + "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security", + "examples": [ + 4 + ] + }, + "purchased_advanced_security_committers": { + "type": "integer", + "description": "The total number of GitHub Advanced Security licences purchased", + "examples": [ + 4 + ] + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/advanced-security-active-committers-repository" + } + } + }, + "required": [ + "repositories" + ] + }, + "get-all-cost-centers": { + "type": "object", + "properties": { + "costCenters": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the cost center." + }, + "name": { + "type": "string", + "description": "Name of the cost center." + }, + "resources": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the resource." + }, + "name": { + "type": "string", + "description": "Name of the resource." + } + }, + "required": [ + "type", + "name" + ] + } + } + }, + "required": [ + "id", + "name", + "resources" + ] + } + } + } + }, + "packages-billing-usage": { + "type": "object", + "properties": { + "total_gigabytes_bandwidth_used": { + "type": "integer", + "description": "Sum of the free and paid storage space (GB) for GitHuub Packages." + }, + "total_paid_gigabytes_bandwidth_used": { + "type": "integer", + "description": "Total paid storage space (GB) for GitHuub Packages." + }, + "included_gigabytes_bandwidth": { + "type": "integer", + "description": "Free storage space (GB) for GitHub Packages." + } + }, + "required": [ + "total_gigabytes_bandwidth_used", + "total_paid_gigabytes_bandwidth_used", + "included_gigabytes_bandwidth" + ] + }, + "combined-billing-usage": { + "type": "object", + "properties": { + "days_left_in_billing_cycle": { + "type": "integer", + "description": "Numbers of days left in billing cycle." + }, + "estimated_paid_storage_for_month": { + "type": "integer", + "description": "Estimated storage space (GB) used in billing cycle." + }, + "estimated_storage_for_month": { + "type": "integer", + "description": "Estimated sum of free and paid storage space (GB) used in billing cycle." + } + }, + "required": [ + "days_left_in_billing_cycle", + "estimated_paid_storage_for_month", + "estimated_storage_for_month" + ] + }, + "billing-usage-report": { + "type": "object", + "properties": { + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of the usage line item." + }, + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + }, + "organizationName": { + "type": "string", + "description": "Name of the organization." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." + } + }, + "required": [ + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" + ] + } + } + } + }, + "actor": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" ] }, "closed_at": { @@ -114628,880 +116435,83 @@ "token_expires_at", "token_last_used_at" ] - }, - "project": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "custom-property-value": { - "title": "Custom Property Value", - "description": "Custom property name and associated value", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The value assigned to the property", - "type": [ - "null", - "string", - "array" - ] - } - }, - "required": [ - "property_name", - "value" - ] - }, - "org-repo-custom-property-values": { - "title": "Organization Repository Custom Property Values", - "description": "List of custom property values for a repository", - "type": "object", - "properties": { - "repository_id": { - "type": "integer", - "examples": [ - 1296269 - ] - }, - "repository_name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "repository_full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "properties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/custom-property-value" - }, - "description": "List of custom property names and associated values" - } - }, - "required": [ - "repository_id", - "repository_name", - "repository_full_name", - "properties" - ] - }, - "code-of-conduct-simple": { - "title": "Code Of Conduct Simple", - "description": "Code of Conduct Simple", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/github/docs/community/code_of_conduct" - ] - }, - "key": { - "type": "string", - "examples": [ - "citizen_code_of_conduct" - ] - }, - "name": { - "type": "string", - "examples": [ - "Citizen Code of Conduct" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" - ] - } - }, - "required": [ - "url", - "key", - "name", - "html_url" - ] - }, - "full-repository": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "$ref": "#/components/schemas/simple-user" - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string", - "examples": [ - "public" - ] - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean", - "examples": [ - true - ] - }, - "template_repository": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/repository" - } - ] - }, - "temp_clone_token": { - "type": [ - "string", - "null" - ] - }, - "allow_squash_merge": { - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "type": "boolean", - "examples": [ - false - ] - }, - "allow_merge_commit": { - "type": "boolean", - "examples": [ - true - ] - }, - "allow_update_branch": { - "type": "boolean", + }, + "project": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", "examples": [ - true + "https://api.github.com/repos/api-playground/projects-test" ] }, - "use_squash_pr_title_as_default": { - "type": "boolean", + "url": { + "type": "string", + "format": "uri", "examples": [ - false + "https://api.github.com/projects/1002604" ] }, - "squash_merge_commit_title": { + "html_url": { "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "format": "uri", "examples": [ - "PR_TITLE" + "https://github.com/api-playground/projects-test/projects/12" ] }, - "squash_merge_commit_message": { + "columns_url": { "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "format": "uri", "examples": [ - "PR_BODY" + "https://api.github.com/projects/1002604/columns" ] }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "id": { + "type": "integer", "examples": [ - "PR_TITLE" + 1002604 ] }, - "merge_commit_message": { + "node_id": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "examples": [ - "PR_BODY" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "allow_forking": { - "type": "boolean", + "name": { + "description": "Name of the project", + "type": "string", "examples": [ - true + "Week One Sprint" ] }, - "web_commit_signoff_required": { - "type": "boolean", + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], "examples": [ - false + "This project represents the sprint of the first week in January" ] }, - "subscribers_count": { + "number": { "type": "integer", "examples": [ - 42 + 1 ] }, - "network_count": { - "type": "integer", + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", "examples": [ - 0 - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/license-simple" - } + "open" ] }, - "organization": { + "creator": { "anyOf": [ { "type": "null" @@ -115511,1383 +116521,915 @@ } ] }, - "parent": { - "$ref": "#/components/schemas/repository" - }, - "source": { - "$ref": "#/components/schemas/repository" - }, - "forks": { - "type": "integer" - }, - "master_branch": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] }, - "open_issues": { - "type": "integer" + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] }, - "watchers": { - "type": "integer" + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] }, - "anonymous_access_enabled": { - "description": "Whether anonymous git access is allowed.", - "default": true, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", "type": "boolean" - }, - "code_of_conduct": { - "$ref": "#/components/schemas/code-of-conduct-simple" - }, - "security_and_analysis": { - "$ref": "#/components/schemas/security-and-analysis" - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", "id", "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", + "number", "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", + "body", + "state", "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", - "updated_at", - "network_count", - "subscribers_count" - ] - }, - "repository-rule-enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", - "enum": [ - "disabled", - "active", - "evaluate" + "updated_at" ] }, - "repository-ruleset-bypass-actor": { - "title": "Repository Ruleset Bypass Actor", + "custom-property-value": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." - }, - "actor_type": { + "property_name": { "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey", - "EnterpriseOwner" - ], - "description": "The type of actor that can bypass a ruleset" + "description": "The name of the property" }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - }, - "repository-ruleset-conditions": { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - "repository-ruleset-conditions-repository-name-target": { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } + "value": { + "oneOf": [ + { + "type": "string" }, - "exclude": { + { "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", "items": { "type": "string" } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." } - } + ], + "description": "The value assigned to the property", + "type": [ + "null", + "string", + "array" + ] } }, "required": [ - "repository_name" + "property_name", + "value" ] }, - "repository-ruleset-conditions-repository-id-target": { - "title": "Repository ruleset conditions for repository IDs", + "org-repo-custom-property-values": { + "title": "Organization Repository Custom Property Values", + "description": "List of custom property values for a repository", "type": "object", - "description": "Parameters for a repository ID condition", "properties": { "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } + "type": "integer", + "examples": [ + 1296269 + ] + }, + "repository_name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "repository_full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "properties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + }, + "description": "List of custom property names and associated values" } }, "required": [ - "repository_id" + "repository_id", + "repository_name", + "repository_full_name", + "properties" ] }, - "repository-ruleset-conditions-repository-property-spec": { - "title": "Repository ruleset property targeting definition", + "code-of-conduct-simple": { + "title": "Code Of Conduct Simple", + "description": "Code of Conduct Simple", "type": "object", - "description": "Parameters for a targeting a repository property", "properties": { - "name": { + "url": { "type": "string", - "description": "The name of the repository property to target" + "format": "uri", + "examples": [ + "https://api.github.com/repos/github/docs/community/code_of_conduct" + ] }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } + "key": { + "type": "string", + "examples": [ + "citizen_code_of_conduct" + ] }, - "source": { + "name": { "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" + "examples": [ + "Citizen Code of Conduct" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" ] } }, "required": [ + "url", + "key", "name", - "property_values" + "html_url" ] }, - "repository-ruleset-conditions-repository-property-target": { - "title": "Repository ruleset conditions for repository properties", + "full-repository": { + "title": "Full Repository", + "description": "Full Repository", "type": "object", - "description": "Parameters for a repository property condition", "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" - } - } - } - } - }, - "required": [ - "repository_property" - ] - }, - "org-ruleset-conditions": { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "$ref": "#/components/schemas/repository-ruleset-conditions" - }, - { - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" - } + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 ] }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "$ref": "#/components/schemas/repository-ruleset-conditions" - }, - { - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" - } + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "$ref": "#/components/schemas/repository-ruleset-conditions" - }, - { - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" - } + "name": { + "type": "string", + "examples": [ + "Hello-World" ] - } - ] - }, - "repository-rule-creation": { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "full_name": { "type": "string", - "enum": [ - "creation" + "examples": [ + "octocat/Hello-World" ] - } - } - }, - "repository-rule-update": { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", - "enum": [ - "update" + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" ] }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" ] - } - } - }, - "repository-rule-deletion": { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "enum": [ - "deletion" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" ] - } - } - }, - "repository-rule-required-linear-history": { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "archive_url": { "type": "string", - "enum": [ - "required_linear_history" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] - } - } - }, - "repository-rule-merge-queue": { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "assignees_url": { "type": "string", - "enum": [ - "merge_queue" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } - }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] - } - } - }, - "repository-rule-required-deployments": { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "branches_url": { "type": "string", - "enum": [ - "required_deployments" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] - } - } - }, - "repository-rule-required-signatures": { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "comments_url": { "type": "string", - "enum": [ - "required_signatures" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] - } - } - }, - "repository-rule-params-required-reviewer-configuration": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files.", - "items": { - "type": "string" - } }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] }, - "reviewer_id": { + "compare_url": { "type": "string", - "description": "Node ID of the team which must review changes to matching files." - } - }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer_id" - ] - }, - "repository-rule-pull-request": { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { "type": "string", - "enum": [ - "pull_request" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, - "parameters": { - "type": "object", - "properties": { - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" ] - } - } - }, - "repository-rule-params-status-check-configuration": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { + }, + "deployments_url": { "type": "string", - "description": "The status check context name that must be present on the commit." + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - }, - "repository-rule-required-status-checks": { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + "downloads_url": { "type": "string", - "enum": [ - "required_status_checks" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "$ref": "#/components/schemas/repository-rule-params-status-check-configuration" - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" ] - } - } - }, - "repository-rule-non-fast-forward": { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "forks_url": { "type": "string", - "enum": [ - "non_fast_forward" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" ] - } - } - }, - "repository-rule-commit-message-pattern": { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "git_commits_url": { "type": "string", - "enum": [ - "commit_message_pattern" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] - } - } - }, - "repository-rule-commit-author-email-pattern": { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", - "enum": [ - "commit_author_email_pattern" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" ] - } - } - }, - "repository-rule-committer-email-pattern": { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "milestones_url": { "type": "string", - "enum": [ - "committer_email_pattern" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] - } - } - }, - "repository-rule-branch-name-pattern": { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "pulls_url": { "type": "string", - "enum": [ - "branch_name_pattern" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] - } - } - }, - "repository-rule-tag-name-pattern": { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "ssh_url": { "type": "string", - "enum": [ - "tag_name_pattern" + "examples": [ + "git@github.com:octocat/Hello-World.git" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] - } - } - }, - "repository-rule-params-restricted-commits": { - "title": "RestrictedCommits", - "description": "Restricted commit", - "type": "object", - "properties": { - "oid": { + }, + "statuses_url": { "type": "string", - "description": "Full or abbreviated commit hash to reject" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] }, - "reason": { + "subscribers_url": { "type": "string", - "description": "Reason for restriction" - } - }, - "required": [ - "oid" - ] - }, - "repository-rule-params-workflow-file-reference": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { "type": "string", - "description": "The path to the workflow file" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] }, - "ref": { + "tags_url": { "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] }, - "sha": { + "trees_url": { "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - }, - "repository-rule-workflows": { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { "type": "string", - "enum": [ - "workflows" + "examples": [ + "https://github.com/octocat/Hello-World.git" ] }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" - } - } - }, - "required": [ - "workflows" + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" ] - } - } - }, - "repository-rule-params-code-scanning-tool": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { + }, + "hooks_url": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, - "security_alerts_threshold": { + "svn_url": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" ] }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - }, - "repository-rule-code-scanning": { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { "type": "string", - "enum": [ - "code_scanning" + "examples": [ + "master" ] }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" - } - } - }, - "required": [ - "code_scanning_tools" + "open_issues_count": { + "type": "integer", + "examples": [ + 0 ] - } - } - }, - "repository-rule": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "$ref": "#/components/schemas/repository-rule-creation" }, - { - "$ref": "#/components/schemas/repository-rule-update" + "is_template": { + "type": "boolean", + "examples": [ + true + ] }, - { - "$ref": "#/components/schemas/repository-rule-deletion" + "topics": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "octocat", + "atom", + "electron", + "API" + ] }, - { - "$ref": "#/components/schemas/repository-rule-required-linear-history" + "has_issues": { + "type": "boolean", + "examples": [ + true + ] }, - { - "$ref": "#/components/schemas/repository-rule-merge-queue" + "has_projects": { + "type": "boolean", + "examples": [ + true + ] }, - { - "$ref": "#/components/schemas/repository-rule-required-deployments" + "has_wiki": { + "type": "boolean", + "examples": [ + true + ] }, - { - "$ref": "#/components/schemas/repository-rule-required-signatures" + "has_pages": { + "type": "boolean" }, - { - "$ref": "#/components/schemas/repository-rule-pull-request" + "has_downloads": { + "type": "boolean", + "examples": [ + true + ] }, - { - "$ref": "#/components/schemas/repository-rule-required-status-checks" + "has_discussions": { + "type": "boolean", + "examples": [ + true + ] }, - { - "$ref": "#/components/schemas/repository-rule-non-fast-forward" + "archived": { + "type": "boolean" }, - { - "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." }, - { - "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "type": "string", + "examples": [ + "public" + ] }, - { - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + "pushed_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] }, - { - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] }, - { - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.", + "permissions": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] + "admin": { + "type": "boolean" }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] + "maintain": { + "type": "boolean" }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths", - "minimum": 1, - "maximum": 256 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] + "push": { + "type": "boolean" }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.", - "type": "object", + }, "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] + "admin", + "pull", + "push" + ] + }, + "allow_rebase_merge": { + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "anyOf": [ + { + "type": "null" }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] + { + "$ref": "#/components/schemas/repository" } - } + ] }, - { - "$ref": "#/components/schemas/repository-rule-workflows" + "temp_clone_token": { + "type": [ + "string", + "null" + ] }, - { - "$ref": "#/components/schemas/repository-rule-code-scanning" - } - ] - }, - "repository-ruleset": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" + "allow_squash_merge": { + "type": "boolean", + "examples": [ + true + ] }, - "name": { + "allow_auto_merge": { + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "type": "boolean", + "examples": [ + false + ] + }, + "allow_merge_commit": { + "type": "boolean", + "examples": [ + true + ] + }, + "allow_update_branch": { + "type": "boolean", + "examples": [ + true + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "examples": [ + false + ] + }, + "squash_merge_commit_title": { "type": "string", - "description": "The name of the ruleset" + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "examples": [ + "PR_TITLE" + ] }, - "target": { + "squash_merge_commit_message": { "type": "string", - "description": "The target of the ruleset", "enum": [ - "branch", - "tag", - "push" + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "examples": [ + "PR_BODY" ] }, - "source_type": { + "merge_commit_title": { "type": "string", - "description": "The type of the source of the ruleset", "enum": [ - "Repository", - "Organization" + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "examples": [ + "PR_TITLE" ] }, - "source": { + "merge_commit_message": { "type": "string", - "description": "The name of the source" + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "examples": [ + "PR_BODY" + ] }, - "enforcement": { - "$ref": "#/components/schemas/repository-rule-enforcement" + "allow_forking": { + "type": "boolean", + "examples": [ + true + ] }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "$ref": "#/components/schemas/repository-ruleset-bypass-actor" - } + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" + "subscribers_count": { + "type": "integer", + "examples": [ + 42 ] }, - "node_id": { - "type": "string" + "network_count": { + "type": "integer", + "examples": [ + 0 + ] }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } + "license": { + "anyOf": [ + { + "type": "null" }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } + { + "$ref": "#/components/schemas/license-simple" } - } + ] }, - "conditions": { + "organization": { "anyOf": [ { - "$ref": "#/components/schemas/repository-ruleset-conditions" + "type": "null" }, { - "$ref": "#/components/schemas/org-ruleset-conditions" + "$ref": "#/components/schemas/simple-user" } - ], - "type": [ - "null", - "object" ] }, - "rules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/repository-rule" - } + "parent": { + "$ref": "#/components/schemas/repository" }, - "created_at": { - "type": "string", - "format": "date-time" + "source": { + "$ref": "#/components/schemas/repository" }, - "updated_at": { - "type": "string", - "format": "date-time" + "forks": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "anonymous_access_enabled": { + "description": "Whether anonymous git access is allowed.", + "default": true, + "type": "boolean" + }, + "code_of_conduct": { + "$ref": "#/components/schemas/code-of-conduct-simple" + }, + "security_and_analysis": { + "$ref": "#/components/schemas/security-and-analysis" + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "has_discussions", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at", + "network_count", + "subscribers_count" + ] }, "rule-suites": { "title": "Rule Suites", @@ -119518,6 +120060,9 @@ }, "dependency_snapshots": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -133723,6 +134268,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -140577,6 +141129,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -151988,6 +152547,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -287852,6 +288418,44 @@ ] } }, + "enterprise-ruleset": { + "value": { + "id": 21, + "name": "super cool ruleset", + "target": "repository", + "source_type": "Enterprise", + "source": "my-enterprise", + "enforcement": "active", + "conditions": { + "organization_name": { + "include": [ + "important_organization" + ] + }, + "repository_name": { + "include": [ + "~ALL" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/enterprises/my-enterprise/rulesets/21" + }, + "html": { + "href": "https://github.com/enterprise/my-enterprise/settings/policies/repositories/21" + } + }, + "created_at": "2024-08-15T08:43:03Z", + "updated_at": "2024-09-23T16:29:47Z" + } + }, "organization-secret-scanning-alert-list": { "value": [ { @@ -287995,6 +288599,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -288086,6 +288691,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -295503,6 +296109,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -308268,6 +308880,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -308292,6 +308905,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -308319,6 +308933,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -308364,6 +308979,7 @@ "push_protection_bypassed_by": null, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": "Example comment", diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index 7c453e138..5a1f692b7 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -3575,7 +3575,7 @@ paths: '404': "$ref": "#/components/responses/not_found" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-user-management @@ -3646,7 +3646,7 @@ paths: '422': "$ref": "#/components/responses/usage_metrics_api_disabled" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-metrics @@ -3723,7 +3723,7 @@ paths: '404': "$ref": "#/components/responses/not_found" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage @@ -3982,6 +3982,22 @@ paths: parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/custom-property-name" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/custom-property-set-payload" + examples: + default: + value: + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development responses: '200': description: Response @@ -4031,6 +4047,249 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: custom-properties + "/enterprises/{enterprise}/rulesets": + post: + summary: Create an enterprise repository ruleset + description: Create a repository ruleset for an enterprise. + tags: + - repos + operationId: repos/create-enterprise-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + description: Request body + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the ruleset. + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + default: branch + enforcement: + "$ref": "#/components/schemas/repository-rule-enforcement" + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + conditions: + "$ref": "#/components/schemas/enterprise-ruleset-conditions" + rules: + type: array + description: An array of rules within the ruleset. + items: + "$ref": "#/components/schemas/repository-rule" + required: + - name + - enforcement + examples: + default: + value: + name: super cool ruleset + target: repository + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + org_name: + include: + - important_org + exclude: + - unimportant_org + rules: + - type: repository_delete + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/repository-ruleset" + examples: + default: + "$ref": "#/components/examples/enterprise-ruleset" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: rules + "/enterprises/{enterprise}/rulesets/{ruleset_id}": + get: + summary: Get an enterprise repository ruleset + description: |- + Get a repository ruleset for an enterprise. + + **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + making the API request has write access to the ruleset. + tags: + - repos + operationId: repos/get-enterprise-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset + parameters: + - "$ref": "#/components/parameters/enterprise" + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/repository-ruleset" + examples: + default: + "$ref": "#/components/examples/enterprise-ruleset" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: rules + put: + summary: Update an enterprise repository ruleset + description: Update a ruleset for an enterprise. + tags: + - repos + operationId: repos/update-enterprise-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset + parameters: + - "$ref": "#/components/parameters/enterprise" + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + requestBody: + description: Request body + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the ruleset. + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + enforcement: + "$ref": "#/components/schemas/repository-rule-enforcement" + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + conditions: + "$ref": "#/components/schemas/enterprise-ruleset-conditions" + rules: + description: An array of rules within the ruleset. + type: array + items: + "$ref": "#/components/schemas/repository-rule" + examples: + default: + value: + name: super cool ruleset + target: repository + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + org_name: + include: + - important_org + exclude: + - unimportant_org + rules: + - type: repository_delete + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/repository-ruleset" + examples: + default: + "$ref": "#/components/examples/enterprise-ruleset" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: rules + delete: + summary: Delete an enterprise repository ruleset + description: Delete a ruleset for an enterprise. + tags: + - repos + operationId: repos/delete-enterprise-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset + parameters: + - "$ref": "#/components/parameters/enterprise" + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: rules "/enterprises/{enterprise}/secret-scanning/alerts": get: summary: List secret scanning alerts for an enterprise @@ -4458,7 +4717,7 @@ paths: '422': "$ref": "#/components/responses/usage_metrics_api_disabled" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-metrics @@ -4537,7 +4796,7 @@ paths: '404': "$ref": "#/components/responses/not_found" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage @@ -9576,6 +9835,8 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: default: "$ref": "#/components/examples/list-attestations" @@ -16774,50 +17035,7 @@ paths: content: application/json: schema: - type: object - properties: - value_type: - type: string - enum: - - string - - single_select - - multi_select - - true_false - description: The type of the value for the property - examples: - - single_select - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - description: Default value of the property - type: - - 'null' - - string - - array - description: - type: - - string - - 'null' - description: Short description of the property - allowed_values: - type: - - array - - 'null' - items: - type: string - maxLength: 75 - maxItems: 200 - description: |- - An ordered list of the allowed values of the property. - The property can have up to 200 allowed values. - required: - - value_type + "$ref": "#/components/schemas/custom-property-set-payload" examples: default: value: @@ -17489,6 +17707,7 @@ paths: - branch - tag - push + - repository default: branch enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" @@ -17705,6 +17924,7 @@ paths: - branch - tag - push + - repository enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -24889,6 +25109,8 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: default: "$ref": "#/components/examples/list-attestations" @@ -53343,6 +53565,8 @@ paths: "$ref": "#/components/schemas/sigstore-bundle-0" repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -77811,6 +78035,1083 @@ components: required: - property_name - value_type + custom-property-set-payload: + title: Custom Property Set Payload + description: Custom property set payload + type: object + properties: + value_type: + type: string + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + required: + - value_type + repository-rule-enforcement: + type: string + description: The enforcement level of the ruleset. `evaluate` allows admins + to test rules before enforcing them. Admins can view insights on the Rule + Insights page. `evaluate` is not available for the `repository` target. + enum: + - disabled + - active + - evaluate + repository-ruleset-bypass-actor: + title: Repository Ruleset Bypass Actor + type: object + description: An actor that can bypass rules in a ruleset + required: + - actor_type + properties: + actor_id: + type: + - integer + - 'null' + description: The ID of the actor that can bypass a ruleset. If `actor_type` + is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, + this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` + is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable + for personal repositories. + actor_type: + type: string + enum: + - Integration + - OrganizationAdmin + - RepositoryRole + - Team + - DeployKey + - EnterpriseOwner + description: The type of actor that can bypass a ruleset + bypass_mode: + type: string + description: When the specified actor can bypass the ruleset. `pull_request` + means that an actor can only bypass rules on pull requests. `pull_request` + is not applicable for the `DeployKey` actor type. Also, `pull_request` + is only applicable to branch rulesets. + enum: + - always + - pull_request + default: always + enterprise-ruleset-conditions-organization-name-target: + title: Repository ruleset conditions for organization names + type: object + description: Parameters for an organization name condition + properties: + organization_name: + type: object + properties: + include: + type: array + description: Array of organization names or patterns to include. One + of these patterns must match for the condition to pass. Also accepts + `~ALL` to include all organizations and ~EMUS to target all enterprise + managed user accounts. + items: + type: string + exclude: + type: array + description: Array of organization names or patterns to exclude. The + condition will not pass if any of these patterns match. + items: + type: string + required: + - organization_name + repository-ruleset-conditions-repository-name-target: + title: Repository ruleset conditions for repository names + type: object + description: Parameters for a repository name condition + properties: + repository_name: + type: object + properties: + include: + type: array + description: Array of repository names or patterns to include. One of + these patterns must match for the condition to pass. Also accepts + `~ALL` to include all repositories. + items: + type: string + exclude: + type: array + description: Array of repository names or patterns to exclude. The condition + will not pass if any of these patterns match. + items: + type: string + protected: + type: boolean + description: Whether renaming of target repositories is prevented. + required: + - repository_name + repository-ruleset-conditions: + title: Repository ruleset conditions for ref names + type: object + description: Parameters for a repository ruleset ref name condition + properties: + ref_name: + type: object + properties: + include: + type: array + description: Array of ref names or patterns to include. One of these + patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` + to include the default branch or `~ALL` to include all branches. + items: + type: string + exclude: + type: array + description: Array of ref names or patterns to exclude. The condition + will not pass if any of these patterns match. + items: + type: string + repository-ruleset-conditions-repository-property-spec: + title: Repository ruleset property targeting definition + type: object + description: Parameters for a targeting a repository property + properties: + name: + type: string + description: The name of the repository property to target + property_values: + type: array + description: The values to match for the repository property + items: + type: string + source: + type: string + description: The source of the repository property. Defaults to 'custom' + if not specified. + enum: + - custom + - system + required: + - name + - property_values + repository-ruleset-conditions-repository-property-target: + title: Repository ruleset conditions for repository properties + type: object + description: Parameters for a repository property condition + properties: + repository_property: + type: object + properties: + include: + type: array + description: The repository properties and values to include. All of + these properties must match for the condition to pass. + items: + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + exclude: + type: array + description: The repository properties and values to exclude. The condition + will not pass if any of these properties match. + items: + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + required: + - repository_property + enterprise-ruleset-conditions-organization-id-target: + title: Repository ruleset conditions for organization IDs + type: object + description: Parameters for an organization ID condition + properties: + organization_id: + type: object + properties: + organization_ids: + type: array + description: The organization IDs that the ruleset applies to. One of + these IDs must match for the condition to pass. + items: + type: integer + required: + - organization_id + enterprise-ruleset-conditions: + title: Enterprise ruleset conditions + type: object + description: Conditions for an enterprise ruleset. The conditions object should + contain either the `organization_id` or `organization_name` property and the + `repository_name` or `repository_property` property. For branch and tag rulesets, + the conditions object should also contain the `ref_name` property. + oneOf: + - type: object + title: organization_name_and_repository_name + description: Conditions to target organizations by name and all repositories + allOf: + - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-name-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - type: object + title: organization_name_and_repository_property + description: Conditions to target organizations by name and repositories by + property + allOf: + - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-name-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - type: object + title: organization_id_and_repository_name + description: Conditions to target organizations by id and all repositories + allOf: + - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-id-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - type: object + title: organization_id_and_repository_property + description: Conditions to target organization by id and repositories by property + allOf: + - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-id-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions" + repository-rule-creation: + title: creation + description: Only allow users with bypass permission to create matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - creation + repository-rule-update: + title: update + description: Only allow users with bypass permission to update matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - update + parameters: + type: object + properties: + update_allows_fetch_and_merge: + type: boolean + description: Branch can pull changes from its upstream repository + required: + - update_allows_fetch_and_merge + repository-rule-deletion: + title: deletion + description: Only allow users with bypass permissions to delete matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - deletion + repository-rule-required-linear-history: + title: required_linear_history + description: Prevent merge commits from being pushed to matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_linear_history + repository-rule-merge-queue: + title: merge_queue + description: Merges must be performed via a merge queue. + type: object + required: + - type + properties: + type: + type: string + enum: + - merge_queue + parameters: + type: object + properties: + check_response_timeout_minutes: + type: integer + description: Maximum time for a required status check to report a conclusion. + After this much time has elapsed, checks that have not reported a + conclusion will be assumed to have failed + minimum: 1 + maximum: 360 + grouping_strategy: + type: string + description: When set to ALLGREEN, the merge commit created by merge + queue for each PR in the group must pass all required checks to merge. + When set to HEADGREEN, only the commit at the head of the merge group, + i.e. the commit containing changes from all of the PRs in the group, + must pass its required checks to merge. + enum: + - ALLGREEN + - HEADGREEN + max_entries_to_build: + type: integer + description: Limit the number of queued pull requests requesting checks + and workflow runs at the same time. + minimum: 0 + maximum: 100 + max_entries_to_merge: + type: integer + description: The maximum number of PRs that will be merged together + in a group. + minimum: 0 + maximum: 100 + merge_method: + type: string + description: Method to use when merging changes from queued pull requests. + enum: + - MERGE + - SQUASH + - REBASE + min_entries_to_merge: + type: integer + description: The minimum number of PRs that will be merged together + in a group. + minimum: 0 + maximum: 100 + min_entries_to_merge_wait_minutes: + type: integer + description: The time merge queue should wait after the first PR is + added to the queue for the minimum group size to be met. After this + time has elapsed, the minimum group size will be ignored and a smaller + group will be merged. + minimum: 0 + maximum: 360 + required: + - check_response_timeout_minutes + - grouping_strategy + - max_entries_to_build + - max_entries_to_merge + - merge_method + - min_entries_to_merge + - min_entries_to_merge_wait_minutes + repository-rule-required-deployments: + title: required_deployments + description: Choose which environments must be successfully deployed to before + refs can be pushed into a ref that matches this rule. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_deployments + parameters: + type: object + properties: + required_deployment_environments: + type: array + description: The environments that must be successfully deployed to + before branches can be merged. + items: + type: string + required: + - required_deployment_environments + repository-rule-required-signatures: + title: required_signatures + description: Commits pushed to matching refs must have verified signatures. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_signatures + repository-rule-params-required-reviewer-configuration: + title: RequiredReviewerConfiguration + description: A reviewing team, and file patterns describing which files they + must approve changes to. + type: object + properties: + file_patterns: + type: array + description: Array of file patterns. Pull requests which change matching + files must be approved by the specified team. File patterns use the same + syntax as `.gitignore` files. + items: + type: string + minimum_approvals: + type: integer + description: Minimum number of approvals required from the specified team. + If set to zero, the team will be added to the pull request but approval + is optional. + reviewer_id: + type: string + description: Node ID of the team which must review changes to matching files. + required: + - file_patterns + - minimum_approvals + - reviewer_id + repository-rule-pull-request: + title: pull_request + description: Require all commits be made to a non-target branch and submitted + via a pull request before they can be merged. + type: object + required: + - type + properties: + type: + type: string + enum: + - pull_request + parameters: + type: object + properties: + allowed_merge_methods: + type: array + description: When merging pull requests, you can allow any combination + of merge commits, squashing, or rebasing. At least one option must + be enabled. + items: + type: string + dismiss_stale_reviews_on_push: + type: boolean + description: New, reviewable commits pushed will dismiss previous pull + request review approvals. + require_code_owner_review: + type: boolean + description: Require an approving review in pull requests that modify + files that have a designated code owner. + require_last_push_approval: + type: boolean + description: Whether the most recent reviewable push must be approved + by someone other than the person who pushed it. + required_approving_review_count: + type: integer + description: The number of approving reviews that are required before + a pull request can be merged. + minimum: 0 + maximum: 10 + required_review_thread_resolution: + type: boolean + description: All conversations on code must be resolved before a pull + request can be merged. + required: + - dismiss_stale_reviews_on_push + - require_code_owner_review + - require_last_push_approval + - required_approving_review_count + - required_review_thread_resolution + repository-rule-params-status-check-configuration: + title: StatusCheckConfiguration + description: Required status check + type: object + properties: + context: + type: string + description: The status check context name that must be present on the commit. + integration_id: + type: integer + description: The optional integration ID that this status check must originate + from. + required: + - context + repository-rule-required-status-checks: + title: required_status_checks + description: Choose which status checks must pass before the ref is updated. + When enabled, commits must first be pushed to another ref where the checks + pass. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_status_checks + parameters: + type: object + properties: + do_not_enforce_on_create: + type: boolean + description: Allow repositories and branches to be created if a check + would otherwise prohibit it. + required_status_checks: + type: array + description: Status checks that are required. + items: + "$ref": "#/components/schemas/repository-rule-params-status-check-configuration" + strict_required_status_checks_policy: + type: boolean + description: Whether pull requests targeting a matching branch must + be tested with the latest code. This setting will not take effect + unless at least one status check is enabled. + required: + - required_status_checks + - strict_required_status_checks_policy + repository-rule-non-fast-forward: + title: non_fast_forward + description: Prevent users with push access from force pushing to refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - non_fast_forward + repository-rule-commit-message-pattern: + title: commit_message_pattern + description: Parameters to be used for the commit_message_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - commit_message_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-commit-author-email-pattern: + title: commit_author_email_pattern + description: Parameters to be used for the commit_author_email_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - commit_author_email_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-committer-email-pattern: + title: committer_email_pattern + description: Parameters to be used for the committer_email_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - committer_email_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-branch-name-pattern: + title: branch_name_pattern + description: Parameters to be used for the branch_name_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - branch_name_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-tag-name-pattern: + title: tag_name_pattern + description: Parameters to be used for the tag_name_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - tag_name_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-params-restricted-commits: + title: RestrictedCommits + description: Restricted commit + type: object + properties: + oid: + type: string + description: Full or abbreviated commit hash to reject + reason: + type: string + description: Reason for restriction + required: + - oid + repository-rule-params-workflow-file-reference: + title: WorkflowFileReference + description: A workflow that must run for this rule to pass + type: object + properties: + path: + type: string + description: The path to the workflow file + ref: + type: string + description: The ref (branch or tag) of the workflow file to use + repository_id: + type: integer + description: The ID of the repository where the workflow is defined + sha: + type: string + description: The commit SHA of the workflow file to use + required: + - path + - repository_id + repository-rule-workflows: + title: workflows + description: Require all changes made to a targeted branch to pass the specified + workflows before they can be merged. + type: object + required: + - type + properties: + type: + type: string + enum: + - workflows + parameters: + type: object + properties: + do_not_enforce_on_create: + type: boolean + description: Allow repositories and branches to be created if a check + would otherwise prohibit it. + workflows: + type: array + description: Workflows that must pass for this rule to pass. + items: + "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" + required: + - workflows + repository-rule-params-code-scanning-tool: + title: CodeScanningTool + description: A tool that must provide code scanning results for this rule to + pass. + type: object + properties: + alerts_threshold: + type: string + description: The severity level at which code scanning results that raise + alerts block a reference update. For more information on alert severity + levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + enum: + - none + - errors + - errors_and_warnings + - all + security_alerts_threshold: + type: string + description: The severity level at which code scanning results that raise + security alerts block a reference update. For more information on security + severity levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + enum: + - none + - critical + - high_or_higher + - medium_or_higher + - all + tool: + type: string + description: The name of a code scanning tool + required: + - alerts_threshold + - security_alerts_threshold + - tool + repository-rule-code-scanning: + title: code_scanning + description: Choose which tools must provide code scanning results before the + reference is updated. When configured, code scanning must be enabled and have + results for both the commit and the reference being updated. + type: object + required: + - type + properties: + type: + type: string + enum: + - code_scanning + parameters: + type: object + properties: + code_scanning_tools: + type: array + description: Tools that must provide code scanning results for this + rule to pass. + items: + "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" + required: + - code_scanning_tools + repository-rule: + title: Repository Rule + type: object + description: A repository rule. + oneOf: + - "$ref": "#/components/schemas/repository-rule-creation" + - "$ref": "#/components/schemas/repository-rule-update" + - "$ref": "#/components/schemas/repository-rule-deletion" + - "$ref": "#/components/schemas/repository-rule-required-linear-history" + - "$ref": "#/components/schemas/repository-rule-merge-queue" + - "$ref": "#/components/schemas/repository-rule-required-deployments" + - "$ref": "#/components/schemas/repository-rule-required-signatures" + - "$ref": "#/components/schemas/repository-rule-pull-request" + - "$ref": "#/components/schemas/repository-rule-required-status-checks" + - "$ref": "#/components/schemas/repository-rule-non-fast-forward" + - "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + - "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + - title: file_path_restriction + description: Prevent commits that include changes in specified file paths + from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_path_restriction + parameters: + type: object + properties: + restricted_file_paths: + type: array + description: The file paths that are restricted from being pushed + to the commit graph. + items: + type: string + required: + - restricted_file_paths + - title: max_file_path_length + description: Prevent commits that include file paths that exceed a specified + character limit from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_path_length + parameters: + type: object + properties: + max_file_path_length: + type: integer + description: The maximum amount of characters allowed in file paths + minimum: 1 + maximum: 256 + required: + - max_file_path_length + - title: file_extension_restriction + description: Prevent commits that include files with specified file extensions + from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_extension_restriction + parameters: + type: object + properties: + restricted_file_extensions: + type: array + description: The file extensions that are restricted from being pushed + to the commit graph. + items: + type: string + required: + - restricted_file_extensions + - title: max_file_size + description: Prevent commits that exceed a specified file size limit from + being pushed to the commit. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_size + parameters: + type: object + properties: + max_file_size: + type: integer + description: The maximum file size allowed in megabytes. This limit + does not apply to Git Large File Storage (Git LFS). + minimum: 1 + maximum: 100 + required: + - max_file_size + - "$ref": "#/components/schemas/repository-rule-workflows" + - "$ref": "#/components/schemas/repository-rule-code-scanning" + repository-ruleset-conditions-repository-id-target: + title: Repository ruleset conditions for repository IDs + type: object + description: Parameters for a repository ID condition + properties: + repository_id: + type: object + properties: + repository_ids: + type: array + description: The repository IDs that the ruleset applies to. One of + these IDs must match for the condition to pass. + items: + type: integer + required: + - repository_id + org-ruleset-conditions: + title: Organization ruleset conditions + type: object + description: |- + Conditions for an organization ruleset. + The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + The push rulesets conditions object does not require the `ref_name` property. + For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. + oneOf: + - type: object + title: repository_name_and_ref_name + description: Conditions to target repositories by name and refs by name + allOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + - type: object + title: repository_id_and_ref_name + description: Conditions to target repositories by id and refs by name + allOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" + - type: object + title: repository_property_and_ref_name + description: Conditions to target repositories by property and refs by name + allOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + repository-ruleset: + title: Repository ruleset + type: object + description: A set of rules to apply when specified conditions are met. + required: + - id + - name + - source + - enforcement + properties: + id: + type: integer + description: The ID of the ruleset + name: + type: string + description: The name of the ruleset + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + source_type: + type: string + description: The type of the source of the ruleset + enum: + - Repository + - Organization + - Enterprise + source: + type: string + description: The name of the source + enforcement: + "$ref": "#/components/schemas/repository-rule-enforcement" + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + current_user_can_bypass: + type: string + description: |- + The bypass type of the user making the API request for this ruleset. This field is only returned when + querying the repository-level endpoint. + enum: + - always + - pull_requests_only + - never + node_id: + type: string + _links: + type: object + properties: + self: + type: object + properties: + href: + type: string + description: The URL of the ruleset + html: + type: + - object + - 'null' + properties: + href: + type: string + description: The html URL of the ruleset + conditions: + anyOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/org-ruleset-conditions" + type: + - 'null' + - object + rules: + type: array + items: + "$ref": "#/components/schemas/repository-rule" + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time secret-scanning-alert-state: description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. @@ -77896,6 +79197,11 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. push_protection_bypass_request_comment: type: - string @@ -83943,949 +85249,6 @@ components: - updated_at - network_count - subscribers_count - repository-rule-enforcement: - type: string - description: The enforcement level of the ruleset. `evaluate` allows admins - to test rules before enforcing them. Admins can view insights on the Rule - Insights page. - enum: - - disabled - - active - - evaluate - repository-ruleset-bypass-actor: - title: Repository Ruleset Bypass Actor - type: object - description: An actor that can bypass rules in a ruleset - required: - - actor_type - properties: - actor_id: - type: - - integer - - 'null' - description: The ID of the actor that can bypass a ruleset. If `actor_type` - is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, - this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` - is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable - for personal repositories. - actor_type: - type: string - enum: - - Integration - - OrganizationAdmin - - RepositoryRole - - Team - - DeployKey - - EnterpriseOwner - description: The type of actor that can bypass a ruleset - bypass_mode: - type: string - description: When the specified actor can bypass the ruleset. `pull_request` - means that an actor can only bypass rules on pull requests. `pull_request` - is not applicable for the `DeployKey` actor type. Also, `pull_request` - is only applicable to branch rulesets. - enum: - - always - - pull_request - default: always - repository-ruleset-conditions: - title: Repository ruleset conditions for ref names - type: object - description: Parameters for a repository ruleset ref name condition - properties: - ref_name: - type: object - properties: - include: - type: array - description: Array of ref names or patterns to include. One of these - patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` - to include the default branch or `~ALL` to include all branches. - items: - type: string - exclude: - type: array - description: Array of ref names or patterns to exclude. The condition - will not pass if any of these patterns match. - items: - type: string - repository-ruleset-conditions-repository-name-target: - title: Repository ruleset conditions for repository names - type: object - description: Parameters for a repository name condition - properties: - repository_name: - type: object - properties: - include: - type: array - description: Array of repository names or patterns to include. One of - these patterns must match for the condition to pass. Also accepts - `~ALL` to include all repositories. - items: - type: string - exclude: - type: array - description: Array of repository names or patterns to exclude. The condition - will not pass if any of these patterns match. - items: - type: string - protected: - type: boolean - description: Whether renaming of target repositories is prevented. - required: - - repository_name - repository-ruleset-conditions-repository-id-target: - title: Repository ruleset conditions for repository IDs - type: object - description: Parameters for a repository ID condition - properties: - repository_id: - type: object - properties: - repository_ids: - type: array - description: The repository IDs that the ruleset applies to. One of - these IDs must match for the condition to pass. - items: - type: integer - required: - - repository_id - repository-ruleset-conditions-repository-property-spec: - title: Repository ruleset property targeting definition - type: object - description: Parameters for a targeting a repository property - properties: - name: - type: string - description: The name of the repository property to target - property_values: - type: array - description: The values to match for the repository property - items: - type: string - source: - type: string - description: The source of the repository property. Defaults to 'custom' - if not specified. - enum: - - custom - - system - required: - - name - - property_values - repository-ruleset-conditions-repository-property-target: - title: Repository ruleset conditions for repository properties - type: object - description: Parameters for a repository property condition - properties: - repository_property: - type: object - properties: - include: - type: array - description: The repository properties and values to include. All of - these properties must match for the condition to pass. - items: - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" - exclude: - type: array - description: The repository properties and values to exclude. The condition - will not pass if any of these properties match. - items: - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" - required: - - repository_property - org-ruleset-conditions: - title: Organization ruleset conditions - type: object - description: |- - Conditions for an organization ruleset. - The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. - The push rulesets conditions object does not require the `ref_name` property. - oneOf: - - type: object - title: repository_name_and_ref_name - description: Conditions to target repositories by name and refs by name - allOf: - - "$ref": "#/components/schemas/repository-ruleset-conditions" - - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" - - type: object - title: repository_id_and_ref_name - description: Conditions to target repositories by id and refs by name - allOf: - - "$ref": "#/components/schemas/repository-ruleset-conditions" - - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" - - type: object - title: repository_property_and_ref_name - description: Conditions to target repositories by property and refs by name - allOf: - - "$ref": "#/components/schemas/repository-ruleset-conditions" - - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" - repository-rule-creation: - title: creation - description: Only allow users with bypass permission to create matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - creation - repository-rule-update: - title: update - description: Only allow users with bypass permission to update matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - update - parameters: - type: object - properties: - update_allows_fetch_and_merge: - type: boolean - description: Branch can pull changes from its upstream repository - required: - - update_allows_fetch_and_merge - repository-rule-deletion: - title: deletion - description: Only allow users with bypass permissions to delete matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - deletion - repository-rule-required-linear-history: - title: required_linear_history - description: Prevent merge commits from being pushed to matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_linear_history - repository-rule-merge-queue: - title: merge_queue - description: Merges must be performed via a merge queue. - type: object - required: - - type - properties: - type: - type: string - enum: - - merge_queue - parameters: - type: object - properties: - check_response_timeout_minutes: - type: integer - description: Maximum time for a required status check to report a conclusion. - After this much time has elapsed, checks that have not reported a - conclusion will be assumed to have failed - minimum: 1 - maximum: 360 - grouping_strategy: - type: string - description: When set to ALLGREEN, the merge commit created by merge - queue for each PR in the group must pass all required checks to merge. - When set to HEADGREEN, only the commit at the head of the merge group, - i.e. the commit containing changes from all of the PRs in the group, - must pass its required checks to merge. - enum: - - ALLGREEN - - HEADGREEN - max_entries_to_build: - type: integer - description: Limit the number of queued pull requests requesting checks - and workflow runs at the same time. - minimum: 0 - maximum: 100 - max_entries_to_merge: - type: integer - description: The maximum number of PRs that will be merged together - in a group. - minimum: 0 - maximum: 100 - merge_method: - type: string - description: Method to use when merging changes from queued pull requests. - enum: - - MERGE - - SQUASH - - REBASE - min_entries_to_merge: - type: integer - description: The minimum number of PRs that will be merged together - in a group. - minimum: 0 - maximum: 100 - min_entries_to_merge_wait_minutes: - type: integer - description: The time merge queue should wait after the first PR is - added to the queue for the minimum group size to be met. After this - time has elapsed, the minimum group size will be ignored and a smaller - group will be merged. - minimum: 0 - maximum: 360 - required: - - check_response_timeout_minutes - - grouping_strategy - - max_entries_to_build - - max_entries_to_merge - - merge_method - - min_entries_to_merge - - min_entries_to_merge_wait_minutes - repository-rule-required-deployments: - title: required_deployments - description: Choose which environments must be successfully deployed to before - refs can be pushed into a ref that matches this rule. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_deployments - parameters: - type: object - properties: - required_deployment_environments: - type: array - description: The environments that must be successfully deployed to - before branches can be merged. - items: - type: string - required: - - required_deployment_environments - repository-rule-required-signatures: - title: required_signatures - description: Commits pushed to matching refs must have verified signatures. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_signatures - repository-rule-params-required-reviewer-configuration: - title: RequiredReviewerConfiguration - description: A reviewing team, and file patterns describing which files they - must approve changes to. - type: object - properties: - file_patterns: - type: array - description: Array of file patterns. Pull requests which change matching - files must be approved by the specified team. File patterns use the same - syntax as `.gitignore` files. - items: - type: string - minimum_approvals: - type: integer - description: Minimum number of approvals required from the specified team. - If set to zero, the team will be added to the pull request but approval - is optional. - reviewer_id: - type: string - description: Node ID of the team which must review changes to matching files. - required: - - file_patterns - - minimum_approvals - - reviewer_id - repository-rule-pull-request: - title: pull_request - description: Require all commits be made to a non-target branch and submitted - via a pull request before they can be merged. - type: object - required: - - type - properties: - type: - type: string - enum: - - pull_request - parameters: - type: object - properties: - dismiss_stale_reviews_on_push: - type: boolean - description: New, reviewable commits pushed will dismiss previous pull - request review approvals. - require_code_owner_review: - type: boolean - description: Require an approving review in pull requests that modify - files that have a designated code owner. - require_last_push_approval: - type: boolean - description: Whether the most recent reviewable push must be approved - by someone other than the person who pushed it. - required_approving_review_count: - type: integer - description: The number of approving reviews that are required before - a pull request can be merged. - minimum: 0 - maximum: 10 - required_review_thread_resolution: - type: boolean - description: All conversations on code must be resolved before a pull - request can be merged. - required: - - dismiss_stale_reviews_on_push - - require_code_owner_review - - require_last_push_approval - - required_approving_review_count - - required_review_thread_resolution - repository-rule-params-status-check-configuration: - title: StatusCheckConfiguration - description: Required status check - type: object - properties: - context: - type: string - description: The status check context name that must be present on the commit. - integration_id: - type: integer - description: The optional integration ID that this status check must originate - from. - required: - - context - repository-rule-required-status-checks: - title: required_status_checks - description: Choose which status checks must pass before the ref is updated. - When enabled, commits must first be pushed to another ref where the checks - pass. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_status_checks - parameters: - type: object - properties: - do_not_enforce_on_create: - type: boolean - description: Allow repositories and branches to be created if a check - would otherwise prohibit it. - required_status_checks: - type: array - description: Status checks that are required. - items: - "$ref": "#/components/schemas/repository-rule-params-status-check-configuration" - strict_required_status_checks_policy: - type: boolean - description: Whether pull requests targeting a matching branch must - be tested with the latest code. This setting will not take effect - unless at least one status check is enabled. - required: - - required_status_checks - - strict_required_status_checks_policy - repository-rule-non-fast-forward: - title: non_fast_forward - description: Prevent users with push access from force pushing to refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - non_fast_forward - repository-rule-commit-message-pattern: - title: commit_message_pattern - description: Parameters to be used for the commit_message_pattern rule - type: object - required: - - type - properties: - type: - type: string - enum: - - commit_message_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - repository-rule-commit-author-email-pattern: - title: commit_author_email_pattern - description: Parameters to be used for the commit_author_email_pattern rule - type: object - required: - - type - properties: - type: - type: string - enum: - - commit_author_email_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - repository-rule-committer-email-pattern: - title: committer_email_pattern - description: Parameters to be used for the committer_email_pattern rule - type: object - required: - - type - properties: - type: - type: string - enum: - - committer_email_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - repository-rule-branch-name-pattern: - title: branch_name_pattern - description: Parameters to be used for the branch_name_pattern rule - type: object - required: - - type - properties: - type: - type: string - enum: - - branch_name_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - repository-rule-tag-name-pattern: - title: tag_name_pattern - description: Parameters to be used for the tag_name_pattern rule - type: object - required: - - type - properties: - type: - type: string - enum: - - tag_name_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - repository-rule-params-restricted-commits: - title: RestrictedCommits - description: Restricted commit - type: object - properties: - oid: - type: string - description: Full or abbreviated commit hash to reject - reason: - type: string - description: Reason for restriction - required: - - oid - repository-rule-params-workflow-file-reference: - title: WorkflowFileReference - description: A workflow that must run for this rule to pass - type: object - properties: - path: - type: string - description: The path to the workflow file - ref: - type: string - description: The ref (branch or tag) of the workflow file to use - repository_id: - type: integer - description: The ID of the repository where the workflow is defined - sha: - type: string - description: The commit SHA of the workflow file to use - required: - - path - - repository_id - repository-rule-workflows: - title: workflows - description: Require all changes made to a targeted branch to pass the specified - workflows before they can be merged. - type: object - required: - - type - properties: - type: - type: string - enum: - - workflows - parameters: - type: object - properties: - do_not_enforce_on_create: - type: boolean - description: Allow repositories and branches to be created if a check - would otherwise prohibit it. - workflows: - type: array - description: Workflows that must pass for this rule to pass. - items: - "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" - required: - - workflows - repository-rule-params-code-scanning-tool: - title: CodeScanningTool - description: A tool that must provide code scanning results for this rule to - pass. - type: object - properties: - alerts_threshold: - type: string - description: The severity level at which code scanning results that raise - alerts block a reference update. For more information on alert severity - levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." - enum: - - none - - errors - - errors_and_warnings - - all - security_alerts_threshold: - type: string - description: The severity level at which code scanning results that raise - security alerts block a reference update. For more information on security - severity levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." - enum: - - none - - critical - - high_or_higher - - medium_or_higher - - all - tool: - type: string - description: The name of a code scanning tool - required: - - alerts_threshold - - security_alerts_threshold - - tool - repository-rule-code-scanning: - title: code_scanning - description: Choose which tools must provide code scanning results before the - reference is updated. When configured, code scanning must be enabled and have - results for both the commit and the reference being updated. - type: object - required: - - type - properties: - type: - type: string - enum: - - code_scanning - parameters: - type: object - properties: - code_scanning_tools: - type: array - description: Tools that must provide code scanning results for this - rule to pass. - items: - "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" - required: - - code_scanning_tools - repository-rule: - title: Repository Rule - type: object - description: A repository rule. - oneOf: - - "$ref": "#/components/schemas/repository-rule-creation" - - "$ref": "#/components/schemas/repository-rule-update" - - "$ref": "#/components/schemas/repository-rule-deletion" - - "$ref": "#/components/schemas/repository-rule-required-linear-history" - - "$ref": "#/components/schemas/repository-rule-merge-queue" - - "$ref": "#/components/schemas/repository-rule-required-deployments" - - "$ref": "#/components/schemas/repository-rule-required-signatures" - - "$ref": "#/components/schemas/repository-rule-pull-request" - - "$ref": "#/components/schemas/repository-rule-required-status-checks" - - "$ref": "#/components/schemas/repository-rule-non-fast-forward" - - "$ref": "#/components/schemas/repository-rule-commit-message-pattern" - - "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" - - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" - - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" - - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - - title: file_path_restriction - description: Prevent commits that include changes in specified file paths - from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_path_restriction - parameters: - type: object - properties: - restricted_file_paths: - type: array - description: The file paths that are restricted from being pushed - to the commit graph. - items: - type: string - required: - - restricted_file_paths - - title: max_file_path_length - description: Prevent commits that include file paths that exceed a specified - character limit from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_path_length - parameters: - type: object - properties: - max_file_path_length: - type: integer - description: The maximum amount of characters allowed in file paths - minimum: 1 - maximum: 256 - required: - - max_file_path_length - - title: file_extension_restriction - description: Prevent commits that include files with specified file extensions - from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_extension_restriction - parameters: - type: object - properties: - restricted_file_extensions: - type: array - description: The file extensions that are restricted from being pushed - to the commit graph. - items: - type: string - required: - - restricted_file_extensions - - title: max_file_size - description: Prevent commits that exceed a specified file size limit from - being pushed to the commit. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_size - parameters: - type: object - properties: - max_file_size: - type: integer - description: The maximum file size allowed in megabytes. This limit - does not apply to Git Large File Storage (Git LFS). - minimum: 1 - maximum: 100 - required: - - max_file_size - - "$ref": "#/components/schemas/repository-rule-workflows" - - "$ref": "#/components/schemas/repository-rule-code-scanning" - repository-ruleset: - title: Repository ruleset - type: object - description: A set of rules to apply when specified conditions are met. - required: - - id - - name - - source - - enforcement - properties: - id: - type: integer - description: The ID of the ruleset - name: - type: string - description: The name of the ruleset - target: - type: string - description: The target of the ruleset - enum: - - branch - - tag - - push - source_type: - type: string - description: The type of the source of the ruleset - enum: - - Repository - - Organization - source: - type: string - description: The name of the source - enforcement: - "$ref": "#/components/schemas/repository-rule-enforcement" - bypass_actors: - type: array - description: The actors that can bypass the rules in this ruleset - items: - "$ref": "#/components/schemas/repository-ruleset-bypass-actor" - current_user_can_bypass: - type: string - description: |- - The bypass type of the user making the API request for this ruleset. This field is only returned when - querying the repository-level endpoint. - enum: - - always - - pull_requests_only - - never - node_id: - type: string - _links: - type: object - properties: - self: - type: object - properties: - href: - type: string - description: The URL of the ruleset - html: - type: - - object - - 'null' - properties: - href: - type: string - description: The html URL of the ruleset - conditions: - anyOf: - - "$ref": "#/components/schemas/repository-ruleset-conditions" - - "$ref": "#/components/schemas/org-ruleset-conditions" - type: - - 'null' - - object - rules: - type: array - items: - "$ref": "#/components/schemas/repository-rule" - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time rule-suites: title: Rule Suites description: Response @@ -86801,6 +87164,8 @@ components: "$ref": "#/components/schemas/rate-limit" dependency_snapshots: "$ref": "#/components/schemas/rate-limit" + code_scanning_autofix: + "$ref": "#/components/schemas/rate-limit" required: - core - search @@ -96864,6 +97229,11 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. push_protection_bypass_request_comment: type: - string @@ -101849,6 +102219,12 @@ components: - approved - rejected - dismissed + reviewer_comment: + type: + - string + - 'null' + description: The comment the reviewer provided when responding to the exemption + request. created_at: type: string format: date-time @@ -110346,6 +110722,11 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. push_protection_bypass_request_comment: type: - string @@ -212014,6 +212395,31 @@ components: allowed_values: - production - development + enterprise-ruleset: + value: + id: 21 + name: super cool ruleset + target: repository + source_type: Enterprise + source: my-enterprise + enforcement: active + conditions: + organization_name: + include: + - important_organization + repository_name: + include: + - "~ALL" + rules: + - type: repository_delete + node_id: RRS_lACkVXNlcgQB + _links: + self: + href: https://api.github.com/enterprises/my-enterprise/rulesets/21 + html: + href: https://github.com/enterprise/my-enterprise/settings/policies/repositories/21 + created_at: '2024-08-15T08:43:03Z' + updated_at: '2024-09-23T16:29:47Z' organization-secret-scanning-alert-list: value: - number: 2 @@ -212151,6 +212557,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true + push_protection_bypass_request_reviewer_comment: Example response push_protection_bypass_request_comment: Example comment push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment @@ -212238,6 +212645,7 @@ components: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -218659,6 +219067,11 @@ components: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -229609,6 +230022,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true + push_protection_bypass_request_reviewer_comment: Example response push_protection_bypass_request_comment: Example comment push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment @@ -229631,6 +230045,7 @@ components: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -229655,6 +230070,7 @@ components: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -229697,6 +230113,7 @@ components: push_protection_bypassed_by: push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: Example comment diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index 781f25879..95223dab9 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -5061,7 +5061,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-user-management" @@ -5148,7 +5148,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-metrics" @@ -5235,7 +5235,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-usage" @@ -5605,6 +5605,30 @@ "$ref": "#/components/parameters/custom-property-name" } ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/custom-property-set-payload" + }, + "examples": { + "default": { + "value": { + "value_type": "single_select", + "required": true, + "default_value": "production", + "description": "Prod or dev environment", + "allowed_values": [ + "production", + "development" + ] + } + } + } + } + } + }, "responses": { "200": { "description": "Response", @@ -5673,6 +5697,370 @@ } } }, + "/enterprises/{enterprise}/rulesets": { + "post": { + "summary": "Create an enterprise repository ruleset", + "description": "Create a repository ruleset for an enterprise.", + "tags": [ + "repos" + ], + "operationId": "repos/create-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + } + ], + "requestBody": { + "description": "Request body", + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ], + "default": "branch" + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/enterprise-ruleset-conditions" + }, + "rules": { + "type": "array", + "description": "An array of rules within the ruleset.", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + } + }, + "required": [ + "name", + "enforcement" + ] + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "repository", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "org_name": { + "include": [ + "important_org" + ], + "exclude": [ + "unimportant_org" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ] + } + } + } + } + } + }, + "responses": { + "201": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "rules" + } + } + }, + "/enterprises/{enterprise}/rulesets/{ruleset_id}": { + "get": { + "summary": "Get an enterprise repository ruleset", + "description": "Get a repository ruleset for an enterprise.\n\n**Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user\nmaking the API request has write access to the ruleset.", + "tags": [ + "repos" + ], + "operationId": "repos/get-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "rules" + } + }, + "put": { + "summary": "Update an enterprise repository ruleset", + "description": "Update a ruleset for an enterprise.", + "tags": [ + "repos" + ], + "operationId": "repos/update-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "description": "Request body", + "required": false, + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the ruleset." + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "conditions": { + "$ref": "#/components/schemas/enterprise-ruleset-conditions" + }, + "rules": { + "description": "An array of rules within the ruleset.", + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + } + } + }, + "examples": { + "default": { + "value": { + "name": "super cool ruleset", + "target": "repository", + "enforcement": "active", + "bypass_actors": [ + { + "actor_id": 234, + "actor_type": "Team", + "bypass_mode": "always" + } + ], + "conditions": { + "org_name": { + "include": [ + "important_org" + ], + "exclude": [ + "unimportant_org" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/repository-ruleset" + }, + "examples": { + "default": { + "$ref": "#/components/examples/enterprise-ruleset" + } + } + } + } + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "rules" + } + }, + "delete": { + "summary": "Delete an enterprise repository ruleset", + "description": "Delete a ruleset for an enterprise.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-enterprise-ruleset", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset" + }, + "parameters": [ + { + "$ref": "#/components/parameters/enterprise" + }, + { + "name": "ruleset_id", + "description": "The ID of the ruleset.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "500": { + "$ref": "#/components/responses/internal_error" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "enterprise-admin", + "subcategory": "rules" + } + } + }, "/enterprises/{enterprise}/secret-scanning/alerts": { "get": { "summary": "List secret scanning alerts for an enterprise", @@ -6277,7 +6665,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-metrics" @@ -6367,7 +6755,7 @@ } }, "x-github": { - "githubCloudOnly": false, + "githubCloudOnly": true, "enabledForGitHubApps": true, "category": "copilot", "subcategory": "copilot-usage" @@ -13206,6 +13594,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -23112,67 +23503,7 @@ "content": { "application/json": { "schema": { - "type": "object", - "properties": { - "value_type": { - "type": "string", - "enum": [ - "string", - "single_select", - "multi_select", - "true_false" - ], - "description": "The type of the value for the property", - "examples": [ - "single_select" - ] - }, - "required": { - "type": "boolean", - "description": "Whether the property is required." - }, - "default_value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "Default value of the property", - "type": [ - "null", - "string", - "array" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "description": "Short description of the property" - }, - "allowed_values": { - "type": [ - "array", - "null" - ], - "items": { - "type": "string", - "maxLength": 75 - }, - "maxItems": 200, - "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." - } - }, - "required": [ - "value_type" - ] + "$ref": "#/components/schemas/custom-property-set-payload" }, "examples": { "default": { @@ -24030,7 +24361,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ], "default": "branch" }, @@ -24359,7 +24691,8 @@ "enum": [ "branch", "tag", - "push" + "push", + "repository" ] }, "enforcement": { @@ -34395,6 +34728,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -73599,6 +73935,9 @@ }, "repository_id": { "type": "integer" + }, + "bundle_url": { + "type": "string" } } } @@ -107301,663 +107640,2131 @@ "value_type" ] }, - "secret-scanning-alert-state": { - "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" - ] - }, - "secret-scanning-alert-resolution": { - "type": [ - "string", - "null" - ], - "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", - "enum": [ - "false_positive", - "wont_fix", - "revoked", - "used_in_tests", - null - ] - }, - "organization-secret-scanning-alert": { + "custom-property-set-payload": { + "title": "Custom Property Set Payload", + "description": "Custom property set payload", "type": "object", "properties": { - "number": { - "$ref": "#/components/schemas/alert-number" - }, - "created_at": { - "$ref": "#/components/schemas/alert-created-at" - }, - "updated_at": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/alert-updated-at" - } - ] - }, - "url": { - "$ref": "#/components/schemas/alert-url" - }, - "html_url": { - "$ref": "#/components/schemas/alert-html-url" - }, - "locations_url": { + "value_type": { "type": "string", - "format": "uri", - "description": "The REST API URL of the code locations for this alert." - }, - "state": { - "$ref": "#/components/schemas/secret-scanning-alert-state" - }, - "resolution": { - "$ref": "#/components/schemas/secret-scanning-alert-resolution" - }, - "resolved_at": { - "type": [ + "enum": [ "string", - "null" + "single_select", + "multi_select", + "true_false" ], - "format": "date-time", - "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "resolved_by": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } + "description": "The type of the value for the property", + "examples": [ + "single_select" ] }, - "secret_type": { - "type": "string", - "description": "The type of secret that secret scanning detected." - }, - "secret_type_display_name": { - "type": "string", - "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" - }, - "secret": { - "type": "string", - "description": "The secret that was detected." - }, - "repository": { - "$ref": "#/components/schemas/simple-repository" - }, - "push_protection_bypassed": { - "type": [ - "boolean", - "null" - ], - "description": "Whether push protection was bypassed for the detected secret." + "required": { + "type": "boolean", + "description": "Whether the property is required." }, - "push_protection_bypassed_by": { - "anyOf": [ + "default_value": { + "oneOf": [ { - "type": "null" + "type": "string" }, { - "$ref": "#/components/schemas/simple-user" + "type": "array", + "items": { + "type": "string" + } } - ] - }, - "push_protection_bypassed_at": { + ], + "description": "Default value of the property", "type": [ + "null", "string", - "null" - ], - "format": "date-time", - "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." - }, - "push_protection_bypass_request_reviewer": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } + "array" ] }, - "push_protection_bypass_request_comment": { + "description": { "type": [ "string", "null" ], - "description": "An optional comment when requesting a push protection bypass." + "description": "Short description of the property" }, - "push_protection_bypass_request_html_url": { + "allowed_values": { "type": [ - "string", + "array", "null" ], - "format": "uri", - "description": "The URL to a push protection bypass request." - }, - "resolution_comment": { + "items": { + "type": "string", + "maxLength": 75 + }, + "maxItems": 200, + "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." + } + }, + "required": [ + "value_type" + ] + }, + "repository-rule-enforcement": { + "type": "string", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", + "enum": [ + "disabled", + "active", + "evaluate" + ] + }, + "repository-ruleset-bypass-actor": { + "title": "Repository Ruleset Bypass Actor", + "type": "object", + "description": "An actor that can bypass rules in a ruleset", + "required": [ + "actor_type" + ], + "properties": { + "actor_id": { "type": [ - "string", + "integer", "null" ], - "description": "The comment that was optionally added when this alert was closed" + "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." }, - "validity": { + "actor_type": { "type": "string", - "description": "The token status as of the latest validity check.", "enum": [ - "active", - "inactive", - "unknown" - ] - }, - "publicly_leaked": { - "type": [ - "boolean", - "null" + "Integration", + "OrganizationAdmin", + "RepositoryRole", + "Team", + "DeployKey", + "EnterpriseOwner" ], - "description": "Whether the secret was publicly leaked." + "description": "The type of actor that can bypass a ruleset" }, - "multi_repo": { - "type": [ - "boolean", - "null" + "bypass_mode": { + "type": "string", + "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", + "enum": [ + "always", + "pull_request" ], - "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise." + "default": "always" } } }, - "actions-billing-usage": { + "enterprise-ruleset-conditions-organization-name-target": { + "title": "Repository ruleset conditions for organization names", "type": "object", + "description": "Parameters for an organization name condition", "properties": { - "total_minutes_used": { - "type": "integer", - "description": "The sum of the free and paid GitHub Actions minutes used." - }, - "total_paid_minutes_used": { - "type": "integer", - "description": "The total paid GitHub Actions minutes used." - }, - "included_minutes": { - "type": "integer", - "description": "The amount of free GitHub Actions minutes available." - }, - "minutes_used_breakdown": { + "organization_name": { "type": "object", "properties": { - "UBUNTU": { - "type": "integer", - "description": "Total minutes used on Ubuntu runner machines." - }, - "MACOS": { - "type": "integer", - "description": "Total minutes used on macOS runner machines." - }, - "WINDOWS": { - "type": "integer", - "description": "Total minutes used on Windows runner machines." - }, - "ubuntu_4_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 4 core runner machines." - }, - "ubuntu_8_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 8 core runner machines." - }, - "ubuntu_16_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 16 core runner machines." - }, - "ubuntu_32_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 32 core runner machines." - }, - "ubuntu_64_core": { - "type": "integer", - "description": "Total minutes used on Ubuntu 64 core runner machines." - }, - "windows_4_core": { - "type": "integer", - "description": "Total minutes used on Windows 4 core runner machines." - }, - "windows_8_core": { - "type": "integer", - "description": "Total minutes used on Windows 8 core runner machines." - }, - "windows_16_core": { - "type": "integer", - "description": "Total minutes used on Windows 16 core runner machines." - }, - "windows_32_core": { - "type": "integer", - "description": "Total minutes used on Windows 32 core runner machines." - }, - "windows_64_core": { - "type": "integer", - "description": "Total minutes used on Windows 64 core runner machines." - }, - "macos_12_core": { - "type": "integer", - "description": "Total minutes used on macOS 12 core runner machines." + "include": { + "type": "array", + "description": "Array of organization names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all organizations and ~EMUS to target all enterprise managed user accounts.", + "items": { + "type": "string" + } }, - "total": { - "type": "integer", - "description": "Total minutes used on all runner machines." + "exclude": { + "type": "array", + "description": "Array of organization names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } } } } }, "required": [ - "total_minutes_used", - "total_paid_minutes_used", - "included_minutes", - "minutes_used_breakdown" + "organization_name" ] }, - "advanced-security-active-committers-user": { + "repository-ruleset-conditions-repository-name-target": { + "title": "Repository ruleset conditions for repository names", "type": "object", + "description": "Parameters for a repository name condition", "properties": { - "user_login": { - "type": "string" - }, - "last_pushed_date": { - "type": "string", - "examples": [ - "2021-11-03" - ] - }, - "last_pushed_email": { - "type": "string", - "examples": [ - "monalisa@github.com" - ] + "repository_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + }, + "protected": { + "type": "boolean", + "description": "Whether renaming of target repositories is prevented." + } + } } }, "required": [ - "user_login", - "last_pushed_date", - "last_pushed_email" + "repository_name" ] }, - "advanced-security-active-committers-repository": { + "repository-ruleset-conditions": { + "title": "Repository ruleset conditions for ref names", + "type": "object", + "description": "Parameters for a repository ruleset ref name condition", + "properties": { + "ref_name": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", + "items": { + "type": "string" + } + }, + "exclude": { + "type": "array", + "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", + "items": { + "type": "string" + } + } + } + } + } + }, + "repository-ruleset-conditions-repository-property-spec": { + "title": "Repository ruleset property targeting definition", "type": "object", + "description": "Parameters for a targeting a repository property", "properties": { "name": { "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "advanced_security_committers": { - "type": "integer", - "examples": [ - 25 - ] + "description": "The name of the repository property to target" }, - "advanced_security_committers_breakdown": { + "property_values": { "type": "array", + "description": "The values to match for the repository property", "items": { - "$ref": "#/components/schemas/advanced-security-active-committers-user" + "type": "string" } + }, + "source": { + "type": "string", + "description": "The source of the repository property. Defaults to 'custom' if not specified.", + "enum": [ + "custom", + "system" + ] } }, "required": [ "name", - "advanced_security_committers", - "advanced_security_committers_breakdown" + "property_values" ] }, - "advanced-security-active-committers": { + "repository-ruleset-conditions-repository-property-target": { + "title": "Repository ruleset conditions for repository properties", "type": "object", + "description": "Parameters for a repository property condition", "properties": { - "total_advanced_security_committers": { - "type": "integer", - "examples": [ - 25 - ] - }, - "total_count": { - "type": "integer", - "examples": [ - 2 - ] - }, - "maximum_advanced_security_committers": { - "type": "integer", - "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security", - "examples": [ - 4 - ] - }, - "purchased_advanced_security_committers": { - "type": "integer", - "description": "The total number of GitHub Advanced Security licences purchased", - "examples": [ - 4 - ] - }, - "repositories": { - "type": "array", - "items": { - "$ref": "#/components/schemas/advanced-security-active-committers-repository" + "repository_property": { + "type": "object", + "properties": { + "include": { + "type": "array", + "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + } + }, + "exclude": { + "type": "array", + "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", + "items": { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + } + } } } }, "required": [ - "repositories" + "repository_property" ] }, - "get-all-cost-centers": { + "enterprise-ruleset-conditions-organization-id-target": { + "title": "Repository ruleset conditions for organization IDs", "type": "object", + "description": "Parameters for an organization ID condition", "properties": { - "costCenters": { - "type": "array", - "items": { - "type": "object", - "properties": { - "id": { - "type": "string", - "description": "ID of the cost center." - }, - "name": { - "type": "string", - "description": "Name of the cost center." - }, - "resources": { - "type": "array", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type of the resource." - }, - "name": { - "type": "string", - "description": "Name of the resource." - } - }, - "required": [ - "type", - "name" - ] - } + "organization_id": { + "type": "object", + "properties": { + "organization_ids": { + "type": "array", + "description": "The organization IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" } - }, - "required": [ - "id", - "name", - "resources" - ] + } } } - } - }, - "packages-billing-usage": { - "type": "object", - "properties": { - "total_gigabytes_bandwidth_used": { - "type": "integer", - "description": "Sum of the free and paid storage space (GB) for GitHuub Packages." - }, - "total_paid_gigabytes_bandwidth_used": { - "type": "integer", - "description": "Total paid storage space (GB) for GitHuub Packages." - }, - "included_gigabytes_bandwidth": { - "type": "integer", - "description": "Free storage space (GB) for GitHub Packages." - } }, "required": [ - "total_gigabytes_bandwidth_used", - "total_paid_gigabytes_bandwidth_used", - "included_gigabytes_bandwidth" + "organization_id" ] }, - "combined-billing-usage": { + "enterprise-ruleset-conditions": { + "title": "Enterprise ruleset conditions", "type": "object", - "properties": { - "days_left_in_billing_cycle": { - "type": "integer", - "description": "Numbers of days left in billing cycle." + "description": "Conditions for an enterprise ruleset. The conditions object should contain either the `organization_id` or `organization_name` property and the `repository_name` or `repository_property` property. For branch and tag rulesets, the conditions object should also contain the `ref_name` property.", + "oneOf": [ + { + "type": "object", + "title": "organization_name_and_repository_name", + "description": "Conditions to target organizations by name and all repositories", + "allOf": [ + { + "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-name-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + ] }, - "estimated_paid_storage_for_month": { - "type": "integer", - "description": "Estimated storage space (GB) used in billing cycle." + { + "type": "object", + "title": "organization_name_and_repository_property", + "description": "Conditions to target organizations by name and repositories by property", + "allOf": [ + { + "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-name-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + ] }, - "estimated_storage_for_month": { - "type": "integer", - "description": "Estimated sum of free and paid storage space (GB) used in billing cycle." + { + "type": "object", + "title": "organization_id_and_repository_name", + "description": "Conditions to target organizations by id and all repositories", + "allOf": [ + { + "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-id-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + ] + }, + { + "type": "object", + "title": "organization_id_and_repository_property", + "description": "Conditions to target organization by id and repositories by property", + "allOf": [ + { + "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-id-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + } + ] } - }, - "required": [ - "days_left_in_billing_cycle", - "estimated_paid_storage_for_month", - "estimated_storage_for_month" ] }, - "billing-usage-report": { + "repository-rule-creation": { + "title": "creation", + "description": "Only allow users with bypass permission to create matching refs.", "type": "object", + "required": [ + "type" + ], "properties": { - "usageItems": { - "type": "array", - "items": { - "type": "object", - "properties": { - "date": { - "type": "string", - "description": "Date of the usage line item." - }, - "product": { - "type": "string", - "description": "Product name." - }, - "sku": { - "type": "string", - "description": "SKU name." - }, - "quantity": { - "type": "integer", - "description": "Quantity of the usage line item." - }, - "unitType": { - "type": "string", - "description": "Unit type of the usage line item." - }, - "pricePerUnit": { - "type": "number", - "description": "Price per unit of the usage line item." - }, - "grossAmount": { - "type": "number", - "description": "Gross amount of the usage line item." - }, - "discountAmount": { - "type": "number", - "description": "Discount amount of the usage line item." - }, - "netAmount": { - "type": "number", - "description": "Net amount of the usage line item." - }, - "organizationName": { - "type": "string", - "description": "Name of the organization." - }, - "repositoryName": { - "type": "string", - "description": "Name of the repository." - } - }, - "required": [ - "date", - "product", - "sku", - "quantity", - "unitType", - "pricePerUnit", - "grossAmount", - "discountAmount", - "netAmount", - "organizationName" - ] - } + "type": { + "type": "string", + "enum": [ + "creation" + ] } } }, - "actor": { - "title": "Actor", - "description": "Actor", + "repository-rule-update": { + "title": "update", + "description": "Only allow users with bypass permission to update matching refs.", "type": "object", + "required": [ + "type" + ], "properties": { - "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" - }, - "gravatar_id": { - "type": [ - "string", - "null" - ] - }, - "url": { + "type": { "type": "string", - "format": "uri" + "enum": [ + "update" + ] }, - "avatar_url": { - "type": "string", - "format": "uri" + "parameters": { + "type": "object", + "properties": { + "update_allows_fetch_and_merge": { + "type": "boolean", + "description": "Branch can pull changes from its upstream repository" + } + }, + "required": [ + "update_allows_fetch_and_merge" + ] } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] + } }, - "milestone": { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", + "repository-rule-deletion": { + "title": "deletion", + "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", + "required": [ + "type" + ], "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1" - ] - }, - "html_url": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World/milestones/v1.0" + "enum": [ + "deletion" ] - }, - "labels_url": { + } + } + }, + "repository-rule-required-linear-history": { + "title": "required_linear_history", + "description": "Prevent merge commits from being pushed to matching refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 + "enum": [ + "required_linear_history" ] - }, - "node_id": { + } + } + }, + "repository-rule-merge-queue": { + "title": "merge_queue", + "description": "Merges must be performed via a merge queue.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "examples": [ - "MDk6TWlsZXN0b25lMTAwMjYwNA==" + "enum": [ + "merge_queue" ] }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "examples": [ - 42 + "parameters": { + "type": "object", + "properties": { + "check_response_timeout_minutes": { + "type": "integer", + "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", + "minimum": 1, + "maximum": 360 + }, + "grouping_strategy": { + "type": "string", + "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", + "enum": [ + "ALLGREEN", + "HEADGREEN" + ] + }, + "max_entries_to_build": { + "type": "integer", + "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", + "minimum": 0, + "maximum": 100 + }, + "max_entries_to_merge": { + "type": "integer", + "description": "The maximum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "merge_method": { + "type": "string", + "description": "Method to use when merging changes from queued pull requests.", + "enum": [ + "MERGE", + "SQUASH", + "REBASE" + ] + }, + "min_entries_to_merge": { + "type": "integer", + "description": "The minimum number of PRs that will be merged together in a group.", + "minimum": 0, + "maximum": 100 + }, + "min_entries_to_merge_wait_minutes": { + "type": "integer", + "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", + "minimum": 0, + "maximum": 360 + } + }, + "required": [ + "check_response_timeout_minutes", + "grouping_strategy", + "max_entries_to_build", + "max_entries_to_merge", + "merge_method", + "min_entries_to_merge", + "min_entries_to_merge_wait_minutes" ] - }, - "state": { - "description": "The state of the milestone.", + } + } + }, + "repository-rule-required-deployments": { + "title": "required_deployments", + "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", "enum": [ - "open", - "closed" - ], - "default": "open", - "examples": [ - "open" - ] - }, - "title": { - "description": "The title of the milestone.", - "type": "string", - "examples": [ - "v1.0" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "Tracking milestone for version 1.0" + "required_deployments" ] }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" + "parameters": { + "type": "object", + "properties": { + "required_deployment_environments": { + "type": "array", + "description": "The environments that must be successfully deployed to before branches can be merged.", + "items": { + "type": "string" + } } + }, + "required": [ + "required_deployment_environments" ] - }, - "open_issues": { - "type": "integer", - "examples": [ - 4 + } + } + }, + "repository-rule-required-signatures": { + "title": "required_signatures", + "description": "Commits pushed to matching refs must have verified signatures.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_signatures" ] + } + } + }, + "repository-rule-params-required-reviewer-configuration": { + "title": "RequiredReviewerConfiguration", + "description": "A reviewing team, and file patterns describing which files they must approve changes to.", + "type": "object", + "properties": { + "file_patterns": { + "type": "array", + "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files.", + "items": { + "type": "string" + } }, - "closed_issues": { + "minimum_approvals": { "type": "integer", - "examples": [ - 8 - ] + "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." }, - "created_at": { + "reviewer_id": { "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { + "description": "Node ID of the team which must review changes to matching files." + } + }, + "required": [ + "file_patterns", + "minimum_approvals", + "reviewer_id" + ] + }, + "repository-rule-pull-request": { + "title": "pull_request", + "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" + "enum": [ + "pull_request" + ] + }, + "parameters": { + "type": "object", + "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, + "dismiss_stale_reviews_on_push": { + "type": "boolean", + "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." + }, + "require_code_owner_review": { + "type": "boolean", + "description": "Require an approving review in pull requests that modify files that have a designated code owner." + }, + "require_last_push_approval": { + "type": "boolean", + "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." + }, + "required_approving_review_count": { + "type": "integer", + "description": "The number of approving reviews that are required before a pull request can be merged.", + "minimum": 0, + "maximum": 10 + }, + "required_review_thread_resolution": { + "type": "boolean", + "description": "All conversations on code must be resolved before a pull request can be merged." + } + }, + "required": [ + "dismiss_stale_reviews_on_push", + "require_code_owner_review", + "require_last_push_approval", + "required_approving_review_count", + "required_review_thread_resolution" + ] + } + } + }, + "repository-rule-params-status-check-configuration": { + "title": "StatusCheckConfiguration", + "description": "Required status check", + "type": "object", + "properties": { + "context": { + "type": "string", + "description": "The status check context name that must be present on the commit." + }, + "integration_id": { + "type": "integer", + "description": "The optional integration ID that this status check must originate from." + } + }, + "required": [ + "context" + ] + }, + "repository-rule-required-status-checks": { + "title": "required_status_checks", + "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "required_status_checks" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "required_status_checks": { + "type": "array", + "description": "Status checks that are required.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-status-check-configuration" + } + }, + "strict_required_status_checks_policy": { + "type": "boolean", + "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." + } + }, + "required": [ + "required_status_checks", + "strict_required_status_checks_policy" + ] + } + } + }, + "repository-rule-non-fast-forward": { + "title": "non_fast_forward", + "description": "Prevent users with push access from force pushing to refs.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "non_fast_forward" + ] + } + } + }, + "repository-rule-commit-message-pattern": { + "title": "commit_message_pattern", + "description": "Parameters to be used for the commit_message_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_message_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + "repository-rule-commit-author-email-pattern": { + "title": "commit_author_email_pattern", + "description": "Parameters to be used for the commit_author_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "commit_author_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + "repository-rule-committer-email-pattern": { + "title": "committer_email_pattern", + "description": "Parameters to be used for the committer_email_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "committer_email_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + "repository-rule-branch-name-pattern": { + "title": "branch_name_pattern", + "description": "Parameters to be used for the branch_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "branch_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + "repository-rule-tag-name-pattern": { + "title": "tag_name_pattern", + "description": "Parameters to be used for the tag_name_pattern rule", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "tag_name_pattern" + ] + }, + "parameters": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "How this rule will appear to users." + }, + "negate": { + "type": "boolean", + "description": "If true, the rule will fail if the pattern matches." + }, + "operator": { + "type": "string", + "description": "The operator to use for matching.", + "enum": [ + "starts_with", + "ends_with", + "contains", + "regex" + ] + }, + "pattern": { + "type": "string", + "description": "The pattern to match with." + } + }, + "required": [ + "operator", + "pattern" + ] + } + } + }, + "repository-rule-params-restricted-commits": { + "title": "RestrictedCommits", + "description": "Restricted commit", + "type": "object", + "properties": { + "oid": { + "type": "string", + "description": "Full or abbreviated commit hash to reject" + }, + "reason": { + "type": "string", + "description": "Reason for restriction" + } + }, + "required": [ + "oid" + ] + }, + "repository-rule-params-workflow-file-reference": { + "title": "WorkflowFileReference", + "description": "A workflow that must run for this rule to pass", + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path to the workflow file" + }, + "ref": { + "type": "string", + "description": "The ref (branch or tag) of the workflow file to use" + }, + "repository_id": { + "type": "integer", + "description": "The ID of the repository where the workflow is defined" + }, + "sha": { + "type": "string", + "description": "The commit SHA of the workflow file to use" + } + }, + "required": [ + "path", + "repository_id" + ] + }, + "repository-rule-workflows": { + "title": "workflows", + "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "workflows" + ] + }, + "parameters": { + "type": "object", + "properties": { + "do_not_enforce_on_create": { + "type": "boolean", + "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." + }, + "workflows": { + "type": "array", + "description": "Workflows that must pass for this rule to pass.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" + } + } + }, + "required": [ + "workflows" + ] + } + } + }, + "repository-rule-params-code-scanning-tool": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + }, + "repository-rule-code-scanning": { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + "repository-rule": { + "title": "Repository Rule", + "type": "object", + "description": "A repository rule.", + "oneOf": [ + { + "$ref": "#/components/schemas/repository-rule-creation" + }, + { + "$ref": "#/components/schemas/repository-rule-update" + }, + { + "$ref": "#/components/schemas/repository-rule-deletion" + }, + { + "$ref": "#/components/schemas/repository-rule-required-linear-history" + }, + { + "$ref": "#/components/schemas/repository-rule-merge-queue" + }, + { + "$ref": "#/components/schemas/repository-rule-required-deployments" + }, + { + "$ref": "#/components/schemas/repository-rule-required-signatures" + }, + { + "$ref": "#/components/schemas/repository-rule-pull-request" + }, + { + "$ref": "#/components/schemas/repository-rule-required-status-checks" + }, + { + "$ref": "#/components/schemas/repository-rule-non-fast-forward" + }, + { + "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + }, + { + "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + }, + { + "title": "file_path_restriction", + "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_path_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_paths": { + "type": "array", + "description": "The file paths that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_paths" + ] + } + } + }, + { + "title": "max_file_path_length", + "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_path_length" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_path_length": { + "type": "integer", + "description": "The maximum amount of characters allowed in file paths", + "minimum": 1, + "maximum": 256 + } + }, + "required": [ + "max_file_path_length" + ] + } + } + }, + { + "title": "file_extension_restriction", + "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "file_extension_restriction" + ] + }, + "parameters": { + "type": "object", + "properties": { + "restricted_file_extensions": { + "type": "array", + "description": "The file extensions that are restricted from being pushed to the commit graph.", + "items": { + "type": "string" + } + } + }, + "required": [ + "restricted_file_extensions" + ] + } + } + }, + { + "title": "max_file_size", + "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "max_file_size" + ] + }, + "parameters": { + "type": "object", + "properties": { + "max_file_size": { + "type": "integer", + "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", + "minimum": 1, + "maximum": 100 + } + }, + "required": [ + "max_file_size" + ] + } + } + }, + { + "$ref": "#/components/schemas/repository-rule-workflows" + }, + { + "$ref": "#/components/schemas/repository-rule-code-scanning" + } + ] + }, + "repository-ruleset-conditions-repository-id-target": { + "title": "Repository ruleset conditions for repository IDs", + "type": "object", + "description": "Parameters for a repository ID condition", + "properties": { + "repository_id": { + "type": "object", + "properties": { + "repository_ids": { + "type": "array", + "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", + "items": { + "type": "integer" + } + } + } + } + }, + "required": [ + "repository_id" + ] + }, + "org-ruleset-conditions": { + "title": "Organization ruleset conditions", + "type": "object", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", + "oneOf": [ + { + "type": "object", + "title": "repository_name_and_ref_name", + "description": "Conditions to target repositories by name and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + } + ] + }, + { + "type": "object", + "title": "repository_id_and_ref_name", + "description": "Conditions to target repositories by id and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" + } + ] + }, + { + "type": "object", + "title": "repository_property_and_ref_name", + "description": "Conditions to target repositories by property and refs by name", + "allOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + } + ] + } + ] + }, + "repository-ruleset": { + "title": "Repository ruleset", + "type": "object", + "description": "A set of rules to apply when specified conditions are met.", + "required": [ + "id", + "name", + "source", + "enforcement" + ], + "properties": { + "id": { + "type": "integer", + "description": "The ID of the ruleset" + }, + "name": { + "type": "string", + "description": "The name of the ruleset" + }, + "target": { + "type": "string", + "description": "The target of the ruleset", + "enum": [ + "branch", + "tag", + "push", + "repository" + ] + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization", + "Enterprise" + ] + }, + "source": { + "type": "string", + "description": "The name of the source" + }, + "enforcement": { + "$ref": "#/components/schemas/repository-rule-enforcement" + }, + "bypass_actors": { + "type": "array", + "description": "The actors that can bypass the rules in this ruleset", + "items": { + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + } + }, + "current_user_can_bypass": { + "type": "string", + "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", + "enum": [ + "always", + "pull_requests_only", + "never" + ] + }, + "node_id": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string", + "description": "The URL of the ruleset" + } + } + }, + "html": { + "type": [ + "object", + "null" + ], + "properties": { + "href": { + "type": "string", + "description": "The html URL of the ruleset" + } + } + } + } + }, + "conditions": { + "anyOf": [ + { + "$ref": "#/components/schemas/repository-ruleset-conditions" + }, + { + "$ref": "#/components/schemas/org-ruleset-conditions" + } + ], + "type": [ + "null", + "object" + ] + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/components/schemas/repository-rule" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + } + }, + "secret-scanning-alert-state": { + "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" + ] + }, + "secret-scanning-alert-resolution": { + "type": [ + "string", + "null" + ], + "description": "**Required when the `state` is `resolved`.** The reason for resolving the alert.", + "enum": [ + "false_positive", + "wont_fix", + "revoked", + "used_in_tests", + null + ] + }, + "organization-secret-scanning-alert": { + "type": "object", + "properties": { + "number": { + "$ref": "#/components/schemas/alert-number" + }, + "created_at": { + "$ref": "#/components/schemas/alert-created-at" + }, + "updated_at": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/alert-updated-at" + } + ] + }, + "url": { + "$ref": "#/components/schemas/alert-url" + }, + "html_url": { + "$ref": "#/components/schemas/alert-html-url" + }, + "locations_url": { + "type": "string", + "format": "uri", + "description": "The REST API URL of the code locations for this alert." + }, + "state": { + "$ref": "#/components/schemas/secret-scanning-alert-state" + }, + "resolution": { + "$ref": "#/components/schemas/secret-scanning-alert-resolution" + }, + "resolved_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "resolved_by": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "secret_type": { + "type": "string", + "description": "The type of secret that secret scanning detected." + }, + "secret_type_display_name": { + "type": "string", + "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest//code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" + }, + "secret": { + "type": "string", + "description": "The secret that was detected." + }, + "repository": { + "$ref": "#/components/schemas/simple-repository" + }, + "push_protection_bypassed": { + "type": [ + "boolean", + "null" + ], + "description": "Whether push protection was bypassed for the detected secret." + }, + "push_protection_bypassed_by": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "push_protection_bypassed_at": { + "type": [ + "string", + "null" + ], + "format": "date-time", + "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." + }, + "push_protection_bypass_request_reviewer": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, + "push_protection_bypass_request_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when requesting a push protection bypass." + }, + "push_protection_bypass_request_html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "description": "The URL to a push protection bypass request." + }, + "resolution_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment that was optionally added when this alert was closed" + }, + "validity": { + "type": "string", + "description": "The token status as of the latest validity check.", + "enum": [ + "active", + "inactive", + "unknown" + ] + }, + "publicly_leaked": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the secret was publicly leaked." + }, + "multi_repo": { + "type": [ + "boolean", + "null" + ], + "description": "Whether the detected secret was found in multiple repositories in the same organization or enterprise." + } + } + }, + "actions-billing-usage": { + "type": "object", + "properties": { + "total_minutes_used": { + "type": "integer", + "description": "The sum of the free and paid GitHub Actions minutes used." + }, + "total_paid_minutes_used": { + "type": "integer", + "description": "The total paid GitHub Actions minutes used." + }, + "included_minutes": { + "type": "integer", + "description": "The amount of free GitHub Actions minutes available." + }, + "minutes_used_breakdown": { + "type": "object", + "properties": { + "UBUNTU": { + "type": "integer", + "description": "Total minutes used on Ubuntu runner machines." + }, + "MACOS": { + "type": "integer", + "description": "Total minutes used on macOS runner machines." + }, + "WINDOWS": { + "type": "integer", + "description": "Total minutes used on Windows runner machines." + }, + "ubuntu_4_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 4 core runner machines." + }, + "ubuntu_8_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 8 core runner machines." + }, + "ubuntu_16_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 16 core runner machines." + }, + "ubuntu_32_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 32 core runner machines." + }, + "ubuntu_64_core": { + "type": "integer", + "description": "Total minutes used on Ubuntu 64 core runner machines." + }, + "windows_4_core": { + "type": "integer", + "description": "Total minutes used on Windows 4 core runner machines." + }, + "windows_8_core": { + "type": "integer", + "description": "Total minutes used on Windows 8 core runner machines." + }, + "windows_16_core": { + "type": "integer", + "description": "Total minutes used on Windows 16 core runner machines." + }, + "windows_32_core": { + "type": "integer", + "description": "Total minutes used on Windows 32 core runner machines." + }, + "windows_64_core": { + "type": "integer", + "description": "Total minutes used on Windows 64 core runner machines." + }, + "macos_12_core": { + "type": "integer", + "description": "Total minutes used on macOS 12 core runner machines." + }, + "total": { + "type": "integer", + "description": "Total minutes used on all runner machines." + } + } + } + }, + "required": [ + "total_minutes_used", + "total_paid_minutes_used", + "included_minutes", + "minutes_used_breakdown" + ] + }, + "advanced-security-active-committers-user": { + "type": "object", + "properties": { + "user_login": { + "type": "string" + }, + "last_pushed_date": { + "type": "string", + "examples": [ + "2021-11-03" + ] + }, + "last_pushed_email": { + "type": "string", + "examples": [ + "monalisa@github.com" + ] + } + }, + "required": [ + "user_login", + "last_pushed_date", + "last_pushed_email" + ] + }, + "advanced-security-active-committers-repository": { + "type": "object", + "properties": { + "name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "advanced_security_committers": { + "type": "integer", + "examples": [ + 25 + ] + }, + "advanced_security_committers_breakdown": { + "type": "array", + "items": { + "$ref": "#/components/schemas/advanced-security-active-committers-user" + } + } + }, + "required": [ + "name", + "advanced_security_committers", + "advanced_security_committers_breakdown" + ] + }, + "advanced-security-active-committers": { + "type": "object", + "properties": { + "total_advanced_security_committers": { + "type": "integer", + "examples": [ + 25 + ] + }, + "total_count": { + "type": "integer", + "examples": [ + 2 + ] + }, + "maximum_advanced_security_committers": { + "type": "integer", + "description": "The total number of GitHub Advanced Security licences required if all repositories were to enable GitHub Advanced Security", + "examples": [ + 4 + ] + }, + "purchased_advanced_security_committers": { + "type": "integer", + "description": "The total number of GitHub Advanced Security licences purchased", + "examples": [ + 4 + ] + }, + "repositories": { + "type": "array", + "items": { + "$ref": "#/components/schemas/advanced-security-active-committers-repository" + } + } + }, + "required": [ + "repositories" + ] + }, + "get-all-cost-centers": { + "type": "object", + "properties": { + "costCenters": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ID of the cost center." + }, + "name": { + "type": "string", + "description": "Name of the cost center." + }, + "resources": { + "type": "array", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of the resource." + }, + "name": { + "type": "string", + "description": "Name of the resource." + } + }, + "required": [ + "type", + "name" + ] + } + } + }, + "required": [ + "id", + "name", + "resources" + ] + } + } + } + }, + "packages-billing-usage": { + "type": "object", + "properties": { + "total_gigabytes_bandwidth_used": { + "type": "integer", + "description": "Sum of the free and paid storage space (GB) for GitHuub Packages." + }, + "total_paid_gigabytes_bandwidth_used": { + "type": "integer", + "description": "Total paid storage space (GB) for GitHuub Packages." + }, + "included_gigabytes_bandwidth": { + "type": "integer", + "description": "Free storage space (GB) for GitHub Packages." + } + }, + "required": [ + "total_gigabytes_bandwidth_used", + "total_paid_gigabytes_bandwidth_used", + "included_gigabytes_bandwidth" + ] + }, + "combined-billing-usage": { + "type": "object", + "properties": { + "days_left_in_billing_cycle": { + "type": "integer", + "description": "Numbers of days left in billing cycle." + }, + "estimated_paid_storage_for_month": { + "type": "integer", + "description": "Estimated storage space (GB) used in billing cycle." + }, + "estimated_storage_for_month": { + "type": "integer", + "description": "Estimated sum of free and paid storage space (GB) used in billing cycle." + } + }, + "required": [ + "days_left_in_billing_cycle", + "estimated_paid_storage_for_month", + "estimated_storage_for_month" + ] + }, + "billing-usage-report": { + "type": "object", + "properties": { + "usageItems": { + "type": "array", + "items": { + "type": "object", + "properties": { + "date": { + "type": "string", + "description": "Date of the usage line item." + }, + "product": { + "type": "string", + "description": "Product name." + }, + "sku": { + "type": "string", + "description": "SKU name." + }, + "quantity": { + "type": "integer", + "description": "Quantity of the usage line item." + }, + "unitType": { + "type": "string", + "description": "Unit type of the usage line item." + }, + "pricePerUnit": { + "type": "number", + "description": "Price per unit of the usage line item." + }, + "grossAmount": { + "type": "number", + "description": "Gross amount of the usage line item." + }, + "discountAmount": { + "type": "number", + "description": "Discount amount of the usage line item." + }, + "netAmount": { + "type": "number", + "description": "Net amount of the usage line item." + }, + "organizationName": { + "type": "string", + "description": "Name of the organization." + }, + "repositoryName": { + "type": "string", + "description": "Name of the repository." + } + }, + "required": [ + "date", + "product", + "sku", + "quantity", + "unitType", + "pricePerUnit", + "grossAmount", + "discountAmount", + "netAmount", + "organizationName" + ] + } + } + } + }, + "actor": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": [ + "string", + "null" + ] + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "milestone": { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1" + ] + }, + "html_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World/milestones/v1.0" + ] + }, + "labels_url": { + "type": "string", + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + ] + }, + "id": { + "type": "integer", + "examples": [ + 1002604 + ] + }, + "node_id": { + "type": "string", + "examples": [ + "MDk6TWlsZXN0b25lMTAwMjYwNA==" + ] + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "examples": [ + 42 + ] + }, + "state": { + "description": "The state of the milestone.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open", + "examples": [ + "open" + ] + }, + "title": { + "description": "The title of the milestone.", + "type": "string", + "examples": [ + "v1.0" + ] + }, + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "Tracking milestone for version 1.0" + ] + }, + "creator": { + "anyOf": [ + { + "type": "null" + }, + { + "$ref": "#/components/schemas/simple-user" + } + ] + }, + "open_issues": { + "type": "integer", + "examples": [ + 4 + ] + }, + "closed_issues": { + "type": "integer", + "examples": [ + 8 + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] + }, + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" ] }, "closed_at": { @@ -114628,880 +116435,83 @@ "token_expires_at", "token_last_used_at" ] - }, - "project": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/api-playground/projects-test" - ] - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604" - ] - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/api-playground/projects-test/projects/12" - ] - }, - "columns_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/projects/1002604/columns" - ] - }, - "id": { - "type": "integer", - "examples": [ - 1002604 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDc6UHJvamVjdDEwMDI2MDQ=" - ] - }, - "name": { - "description": "Name of the project", - "type": "string", - "examples": [ - "Week One Sprint" - ] - }, - "body": { - "description": "Body of the project", - "type": [ - "string", - "null" - ], - "examples": [ - "This project represents the sprint of the first week in January" - ] - }, - "number": { - "type": "integer", - "examples": [ - 1 - ] - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "type": "string", - "examples": [ - "open" - ] - }, - "creator": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/simple-user" - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-04-10T20:09:31Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2014-03-03T18:58:10Z" - ] - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } - }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] - }, - "custom-property-value": { - "title": "Custom Property Value", - "description": "Custom property name and associated value", - "type": "object", - "properties": { - "property_name": { - "type": "string", - "description": "The name of the property" - }, - "value": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "array", - "items": { - "type": "string" - } - } - ], - "description": "The value assigned to the property", - "type": [ - "null", - "string", - "array" - ] - } - }, - "required": [ - "property_name", - "value" - ] - }, - "org-repo-custom-property-values": { - "title": "Organization Repository Custom Property Values", - "description": "List of custom property values for a repository", - "type": "object", - "properties": { - "repository_id": { - "type": "integer", - "examples": [ - 1296269 - ] - }, - "repository_name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "repository_full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "properties": { - "type": "array", - "items": { - "$ref": "#/components/schemas/custom-property-value" - }, - "description": "List of custom property names and associated values" - } - }, - "required": [ - "repository_id", - "repository_name", - "repository_full_name", - "properties" - ] - }, - "code-of-conduct-simple": { - "title": "Code Of Conduct Simple", - "description": "Code of Conduct Simple", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/github/docs/community/code_of_conduct" - ] - }, - "key": { - "type": "string", - "examples": [ - "citizen_code_of_conduct" - ] - }, - "name": { - "type": "string", - "examples": [ - "Citizen Code of Conduct" - ] - }, - "html_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" - ] - } - }, - "required": [ - "url", - "key", - "name", - "html_url" - ] - }, - "full-repository": { - "title": "Full Repository", - "description": "Full Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "format": "int64", - "examples": [ - 1296269 - ] - }, - "node_id": { - "type": "string", - "examples": [ - "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - ] - }, - "name": { - "type": "string", - "examples": [ - "Hello-World" - ] - }, - "full_name": { - "type": "string", - "examples": [ - "octocat/Hello-World" - ] - }, - "owner": { - "$ref": "#/components/schemas/simple-user" - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://github.com/octocat/Hello-World" - ] - }, - "description": { - "type": [ - "string", - "null" - ], - "examples": [ - "This your first repo!" - ] - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "examples": [ - "https://api.github.com/repos/octocat/Hello-World" - ] - }, - "archive_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - ] - }, - "assignees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - ] - }, - "blobs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - ] - }, - "branches_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - ] - }, - "collaborators_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - ] - }, - "comments_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - ] - }, - "commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - ] - }, - "compare_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - ] - }, - "contents_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - ] - }, - "contributors_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/contributors" - ] - }, - "deployments_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/deployments" - ] - }, - "downloads_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/downloads" - ] - }, - "events_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/events" - ] - }, - "forks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/forks" - ] - }, - "git_commits_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - ] - }, - "git_refs_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - ] - }, - "git_tags_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - ] - }, - "git_url": { - "type": "string", - "examples": [ - "git:github.com/octocat/Hello-World.git" - ] - }, - "issue_comment_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - ] - }, - "issue_events_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - ] - }, - "issues_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - ] - }, - "keys_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - ] - }, - "labels_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - ] - }, - "languages_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/languages" - ] - }, - "merges_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/merges" - ] - }, - "milestones_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - ] - }, - "notifications_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - ] - }, - "pulls_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - ] - }, - "releases_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - ] - }, - "ssh_url": { - "type": "string", - "examples": [ - "git@github.com:octocat/Hello-World.git" - ] - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/stargazers" - ] - }, - "statuses_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - ] - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscribers" - ] - }, - "subscription_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/subscription" - ] - }, - "tags_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/tags" - ] - }, - "teams_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/teams" - ] - }, - "trees_url": { - "type": "string", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - ] - }, - "clone_url": { - "type": "string", - "examples": [ - "https://github.com/octocat/Hello-World.git" - ] - }, - "mirror_url": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "git:git.example.com/octocat/Hello-World" - ] - }, - "hooks_url": { - "type": "string", - "format": "uri", - "examples": [ - "http://api.github.com/repos/octocat/Hello-World/hooks" - ] - }, - "svn_url": { - "type": "string", - "format": "uri", - "examples": [ - "https://svn.github.com/octocat/Hello-World" - ] - }, - "homepage": { - "type": [ - "string", - "null" - ], - "format": "uri", - "examples": [ - "https://github.com" - ] - }, - "language": { - "type": [ - "string", - "null" - ] - }, - "forks_count": { - "type": "integer", - "examples": [ - 9 - ] - }, - "stargazers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "watchers_count": { - "type": "integer", - "examples": [ - 80 - ] - }, - "size": { - "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", - "type": "integer", - "examples": [ - 108 - ] - }, - "default_branch": { - "type": "string", - "examples": [ - "master" - ] - }, - "open_issues_count": { - "type": "integer", - "examples": [ - 0 - ] - }, - "is_template": { - "type": "boolean", - "examples": [ - true - ] - }, - "topics": { - "type": "array", - "items": { - "type": "string" - }, - "examples": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_projects": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_wiki": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "examples": [ - true - ] - }, - "has_discussions": { - "type": "boolean", - "examples": [ - true - ] - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string", - "examples": [ - "public" - ] - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:06:43Z" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:01:12Z" - ] - }, - "updated_at": { - "type": "string", - "format": "date-time", - "examples": [ - "2011-01-26T19:14:43Z" - ] - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "allow_rebase_merge": { - "type": "boolean", - "examples": [ - true - ] - }, - "template_repository": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/repository" - } - ] - }, - "temp_clone_token": { - "type": [ - "string", - "null" - ] - }, - "allow_squash_merge": { - "type": "boolean", - "examples": [ - true - ] - }, - "allow_auto_merge": { - "type": "boolean", - "examples": [ - false - ] - }, - "delete_branch_on_merge": { - "type": "boolean", - "examples": [ - false - ] - }, - "allow_merge_commit": { - "type": "boolean", - "examples": [ - true - ] - }, - "allow_update_branch": { - "type": "boolean", + }, + "project": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", "examples": [ - true + "https://api.github.com/repos/api-playground/projects-test" ] }, - "use_squash_pr_title_as_default": { - "type": "boolean", + "url": { + "type": "string", + "format": "uri", "examples": [ - false + "https://api.github.com/projects/1002604" ] }, - "squash_merge_commit_title": { + "html_url": { "type": "string", - "enum": [ - "PR_TITLE", - "COMMIT_OR_PR_TITLE" - ], - "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "format": "uri", "examples": [ - "PR_TITLE" + "https://github.com/api-playground/projects-test/projects/12" ] }, - "squash_merge_commit_message": { + "columns_url": { "type": "string", - "enum": [ - "PR_BODY", - "COMMIT_MESSAGES", - "BLANK" - ], - "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "format": "uri", "examples": [ - "PR_BODY" + "https://api.github.com/projects/1002604/columns" ] }, - "merge_commit_title": { - "type": "string", - "enum": [ - "PR_TITLE", - "MERGE_MESSAGE" - ], - "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "id": { + "type": "integer", "examples": [ - "PR_TITLE" + 1002604 ] }, - "merge_commit_message": { + "node_id": { "type": "string", - "enum": [ - "PR_BODY", - "PR_TITLE", - "BLANK" - ], - "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "examples": [ - "PR_BODY" + "MDc6UHJvamVjdDEwMDI2MDQ=" ] }, - "allow_forking": { - "type": "boolean", + "name": { + "description": "Name of the project", + "type": "string", "examples": [ - true + "Week One Sprint" ] }, - "web_commit_signoff_required": { - "type": "boolean", + "body": { + "description": "Body of the project", + "type": [ + "string", + "null" + ], "examples": [ - false + "This project represents the sprint of the first week in January" ] }, - "subscribers_count": { + "number": { "type": "integer", "examples": [ - 42 + 1 ] }, - "network_count": { - "type": "integer", + "state": { + "description": "State of the project; either 'open' or 'closed'", + "type": "string", "examples": [ - 0 - ] - }, - "license": { - "anyOf": [ - { - "type": "null" - }, - { - "$ref": "#/components/schemas/license-simple" - } + "open" ] }, - "organization": { + "creator": { "anyOf": [ { "type": "null" @@ -115511,1383 +116521,915 @@ } ] }, - "parent": { - "$ref": "#/components/schemas/repository" - }, - "source": { - "$ref": "#/components/schemas/repository" - }, - "forks": { - "type": "integer" - }, - "master_branch": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-04-10T20:09:31Z" + ] }, - "open_issues": { - "type": "integer" + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2014-03-03T18:58:10Z" + ] }, - "watchers": { - "type": "integer" + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] }, - "anonymous_access_enabled": { - "description": "Whether anonymous git access is allowed.", - "default": true, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", "type": "boolean" - }, - "code_of_conduct": { - "$ref": "#/components/schemas/code-of-conduct-simple" - }, - "security_and_analysis": { - "$ref": "#/components/schemas/security-and-analysis" - }, - "custom_properties": { - "type": "object", - "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", - "additionalProperties": true } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", "id", "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", + "number", "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", + "body", + "state", "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "has_discussions", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", + "html_url", + "owner_url", + "creator", + "columns_url", "created_at", - "updated_at", - "network_count", - "subscribers_count" - ] - }, - "repository-rule-enforcement": { - "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", - "enum": [ - "disabled", - "active", - "evaluate" + "updated_at" ] }, - "repository-ruleset-bypass-actor": { - "title": "Repository Ruleset Bypass Actor", + "custom-property-value": { + "title": "Custom Property Value", + "description": "Custom property name and associated value", "type": "object", - "description": "An actor that can bypass rules in a ruleset", - "required": [ - "actor_type" - ], "properties": { - "actor_id": { - "type": [ - "integer", - "null" - ], - "description": "The ID of the actor that can bypass a ruleset. If `actor_type` is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable for personal repositories." - }, - "actor_type": { + "property_name": { "type": "string", - "enum": [ - "Integration", - "OrganizationAdmin", - "RepositoryRole", - "Team", - "DeployKey", - "EnterpriseOwner" - ], - "description": "The type of actor that can bypass a ruleset" + "description": "The name of the property" }, - "bypass_mode": { - "type": "string", - "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets.", - "enum": [ - "always", - "pull_request" - ], - "default": "always" - } - } - }, - "repository-ruleset-conditions": { - "title": "Repository ruleset conditions for ref names", - "type": "object", - "description": "Parameters for a repository ruleset ref name condition", - "properties": { - "ref_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", - "items": { - "type": "string" - } - }, - "exclude": { - "type": "array", - "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", - "items": { - "type": "string" - } - } - } - } - } - }, - "repository-ruleset-conditions-repository-name-target": { - "title": "Repository ruleset conditions for repository names", - "type": "object", - "description": "Parameters for a repository name condition", - "properties": { - "repository_name": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", - "items": { - "type": "string" - } + "value": { + "oneOf": [ + { + "type": "string" }, - "exclude": { + { "type": "array", - "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", "items": { "type": "string" } - }, - "protected": { - "type": "boolean", - "description": "Whether renaming of target repositories is prevented." } - } + ], + "description": "The value assigned to the property", + "type": [ + "null", + "string", + "array" + ] } }, "required": [ - "repository_name" + "property_name", + "value" ] }, - "repository-ruleset-conditions-repository-id-target": { - "title": "Repository ruleset conditions for repository IDs", + "org-repo-custom-property-values": { + "title": "Organization Repository Custom Property Values", + "description": "List of custom property values for a repository", "type": "object", - "description": "Parameters for a repository ID condition", "properties": { "repository_id": { - "type": "object", - "properties": { - "repository_ids": { - "type": "array", - "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", - "items": { - "type": "integer" - } - } - } + "type": "integer", + "examples": [ + 1296269 + ] + }, + "repository_name": { + "type": "string", + "examples": [ + "Hello-World" + ] + }, + "repository_full_name": { + "type": "string", + "examples": [ + "octocat/Hello-World" + ] + }, + "properties": { + "type": "array", + "items": { + "$ref": "#/components/schemas/custom-property-value" + }, + "description": "List of custom property names and associated values" } }, "required": [ - "repository_id" + "repository_id", + "repository_name", + "repository_full_name", + "properties" ] }, - "repository-ruleset-conditions-repository-property-spec": { - "title": "Repository ruleset property targeting definition", + "code-of-conduct-simple": { + "title": "Code Of Conduct Simple", + "description": "Code of Conduct Simple", "type": "object", - "description": "Parameters for a targeting a repository property", "properties": { - "name": { + "url": { "type": "string", - "description": "The name of the repository property to target" + "format": "uri", + "examples": [ + "https://api.github.com/repos/github/docs/community/code_of_conduct" + ] }, - "property_values": { - "type": "array", - "description": "The values to match for the repository property", - "items": { - "type": "string" - } + "key": { + "type": "string", + "examples": [ + "citizen_code_of_conduct" + ] }, - "source": { + "name": { "type": "string", - "description": "The source of the repository property. Defaults to 'custom' if not specified.", - "enum": [ - "custom", - "system" + "examples": [ + "Citizen Code of Conduct" + ] + }, + "html_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" ] } }, "required": [ + "url", + "key", "name", - "property_values" + "html_url" ] }, - "repository-ruleset-conditions-repository-property-target": { - "title": "Repository ruleset conditions for repository properties", + "full-repository": { + "title": "Full Repository", + "description": "Full Repository", "type": "object", - "description": "Parameters for a repository property condition", "properties": { - "repository_property": { - "type": "object", - "properties": { - "include": { - "type": "array", - "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", - "items": { - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" - } - }, - "exclude": { - "type": "array", - "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", - "items": { - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" - } - } - } - } - }, - "required": [ - "repository_property" - ] - }, - "org-ruleset-conditions": { - "title": "Organization ruleset conditions", - "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", - "oneOf": [ - { - "type": "object", - "title": "repository_name_and_ref_name", - "description": "Conditions to target repositories by name and refs by name", - "allOf": [ - { - "$ref": "#/components/schemas/repository-ruleset-conditions" - }, - { - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" - } + "id": { + "type": "integer", + "format": "int64", + "examples": [ + 1296269 ] }, - { - "type": "object", - "title": "repository_id_and_ref_name", - "description": "Conditions to target repositories by id and refs by name", - "allOf": [ - { - "$ref": "#/components/schemas/repository-ruleset-conditions" - }, - { - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" - } + "node_id": { + "type": "string", + "examples": [ + "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" ] }, - { - "type": "object", - "title": "repository_property_and_ref_name", - "description": "Conditions to target repositories by property and refs by name", - "allOf": [ - { - "$ref": "#/components/schemas/repository-ruleset-conditions" - }, - { - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" - } + "name": { + "type": "string", + "examples": [ + "Hello-World" ] - } - ] - }, - "repository-rule-creation": { - "title": "creation", - "description": "Only allow users with bypass permission to create matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "full_name": { "type": "string", - "enum": [ - "creation" + "examples": [ + "octocat/Hello-World" ] - } - } - }, - "repository-rule-update": { - "title": "update", - "description": "Only allow users with bypass permission to update matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "owner": { + "$ref": "#/components/schemas/simple-user" + }, + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", - "enum": [ - "update" + "format": "uri", + "examples": [ + "https://github.com/octocat/Hello-World" ] }, - "parameters": { - "type": "object", - "properties": { - "update_allows_fetch_and_merge": { - "type": "boolean", - "description": "Branch can pull changes from its upstream repository" - } - }, - "required": [ - "update_allows_fetch_and_merge" + "description": { + "type": [ + "string", + "null" + ], + "examples": [ + "This your first repo!" ] - } - } - }, - "repository-rule-deletion": { - "title": "deletion", - "description": "Only allow users with bypass permissions to delete matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "enum": [ - "deletion" + "format": "uri", + "examples": [ + "https://api.github.com/repos/octocat/Hello-World" ] - } - } - }, - "repository-rule-required-linear-history": { - "title": "required_linear_history", - "description": "Prevent merge commits from being pushed to matching refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "archive_url": { "type": "string", - "enum": [ - "required_linear_history" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] - } - } - }, - "repository-rule-merge-queue": { - "title": "merge_queue", - "description": "Merges must be performed via a merge queue.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "assignees_url": { "type": "string", - "enum": [ - "merge_queue" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, - "parameters": { - "type": "object", - "properties": { - "check_response_timeout_minutes": { - "type": "integer", - "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", - "minimum": 1, - "maximum": 360 - }, - "grouping_strategy": { - "type": "string", - "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", - "enum": [ - "ALLGREEN", - "HEADGREEN" - ] - }, - "max_entries_to_build": { - "type": "integer", - "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", - "minimum": 0, - "maximum": 100 - }, - "max_entries_to_merge": { - "type": "integer", - "description": "The maximum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "merge_method": { - "type": "string", - "description": "Method to use when merging changes from queued pull requests.", - "enum": [ - "MERGE", - "SQUASH", - "REBASE" - ] - }, - "min_entries_to_merge": { - "type": "integer", - "description": "The minimum number of PRs that will be merged together in a group.", - "minimum": 0, - "maximum": 100 - }, - "min_entries_to_merge_wait_minutes": { - "type": "integer", - "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", - "minimum": 0, - "maximum": 360 - } - }, - "required": [ - "check_response_timeout_minutes", - "grouping_strategy", - "max_entries_to_build", - "max_entries_to_merge", - "merge_method", - "min_entries_to_merge", - "min_entries_to_merge_wait_minutes" + "blobs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] - } - } - }, - "repository-rule-required-deployments": { - "title": "required_deployments", - "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "branches_url": { "type": "string", - "enum": [ - "required_deployments" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, - "parameters": { - "type": "object", - "properties": { - "required_deployment_environments": { - "type": "array", - "description": "The environments that must be successfully deployed to before branches can be merged.", - "items": { - "type": "string" - } - } - }, - "required": [ - "required_deployment_environments" + "collaborators_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] - } - } - }, - "repository-rule-required-signatures": { - "title": "required_signatures", - "description": "Commits pushed to matching refs must have verified signatures.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "comments_url": { "type": "string", - "enum": [ - "required_signatures" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] - } - } - }, - "repository-rule-params-required-reviewer-configuration": { - "title": "RequiredReviewerConfiguration", - "description": "A reviewing team, and file patterns describing which files they must approve changes to.", - "type": "object", - "properties": { - "file_patterns": { - "type": "array", - "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use the same syntax as `.gitignore` files.", - "items": { - "type": "string" - } }, - "minimum_approvals": { - "type": "integer", - "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." + "commits_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + ] }, - "reviewer_id": { + "compare_url": { "type": "string", - "description": "Node ID of the team which must review changes to matching files." - } - }, - "required": [ - "file_patterns", - "minimum_approvals", - "reviewer_id" - ] - }, - "repository-rule-pull-request": { - "title": "pull_request", - "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + ] + }, + "contents_url": { "type": "string", - "enum": [ - "pull_request" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, - "parameters": { - "type": "object", - "properties": { - "dismiss_stale_reviews_on_push": { - "type": "boolean", - "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." - }, - "require_code_owner_review": { - "type": "boolean", - "description": "Require an approving review in pull requests that modify files that have a designated code owner." - }, - "require_last_push_approval": { - "type": "boolean", - "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." - }, - "required_approving_review_count": { - "type": "integer", - "description": "The number of approving reviews that are required before a pull request can be merged.", - "minimum": 0, - "maximum": 10 - }, - "required_review_thread_resolution": { - "type": "boolean", - "description": "All conversations on code must be resolved before a pull request can be merged." - } - }, - "required": [ - "dismiss_stale_reviews_on_push", - "require_code_owner_review", - "require_last_push_approval", - "required_approving_review_count", - "required_review_thread_resolution" + "contributors_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/contributors" ] - } - } - }, - "repository-rule-params-status-check-configuration": { - "title": "StatusCheckConfiguration", - "description": "Required status check", - "type": "object", - "properties": { - "context": { + }, + "deployments_url": { "type": "string", - "description": "The status check context name that must be present on the commit." + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/deployments" + ] }, - "integration_id": { - "type": "integer", - "description": "The optional integration ID that this status check must originate from." - } - }, - "required": [ - "context" - ] - }, - "repository-rule-required-status-checks": { - "title": "required_status_checks", - "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + "downloads_url": { "type": "string", - "enum": [ - "required_status_checks" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "required_status_checks": { - "type": "array", - "description": "Status checks that are required.", - "items": { - "$ref": "#/components/schemas/repository-rule-params-status-check-configuration" - } - }, - "strict_required_status_checks_policy": { - "type": "boolean", - "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." - } - }, - "required": [ - "required_status_checks", - "strict_required_status_checks_policy" + "events_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/events" ] - } - } - }, - "repository-rule-non-fast-forward": { - "title": "non_fast_forward", - "description": "Prevent users with push access from force pushing to refs.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "forks_url": { "type": "string", - "enum": [ - "non_fast_forward" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/forks" ] - } - } - }, - "repository-rule-commit-message-pattern": { - "title": "commit_message_pattern", - "description": "Parameters to be used for the commit_message_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "git_commits_url": { "type": "string", - "enum": [ - "commit_message_pattern" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "git_refs_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] - } - } - }, - "repository-rule-commit-author-email-pattern": { - "title": "commit_author_email_pattern", - "description": "Parameters to be used for the commit_author_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "git_tags_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + ] + }, + "git_url": { + "type": "string", + "examples": [ + "git:github.com/octocat/Hello-World.git" + ] + }, + "issue_comment_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + ] + }, + "issue_events_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + ] + }, + "issues_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + ] + }, + "keys_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + ] + }, + "labels_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + ] + }, + "languages_url": { "type": "string", - "enum": [ - "commit_author_email_pattern" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/languages" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "merges_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/merges" ] - } - } - }, - "repository-rule-committer-email-pattern": { - "title": "committer_email_pattern", - "description": "Parameters to be used for the committer_email_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "milestones_url": { "type": "string", - "enum": [ - "committer_email_pattern" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "notifications_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] - } - } - }, - "repository-rule-branch-name-pattern": { - "title": "branch_name_pattern", - "description": "Parameters to be used for the branch_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "pulls_url": { "type": "string", - "enum": [ - "branch_name_pattern" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "releases_url": { + "type": "string", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] - } - } - }, - "repository-rule-tag-name-pattern": { - "title": "tag_name_pattern", - "description": "Parameters to be used for the tag_name_pattern rule", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + }, + "ssh_url": { "type": "string", - "enum": [ - "tag_name_pattern" + "examples": [ + "git@github.com:octocat/Hello-World.git" ] }, - "parameters": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "How this rule will appear to users." - }, - "negate": { - "type": "boolean", - "description": "If true, the rule will fail if the pattern matches." - }, - "operator": { - "type": "string", - "description": "The operator to use for matching.", - "enum": [ - "starts_with", - "ends_with", - "contains", - "regex" - ] - }, - "pattern": { - "type": "string", - "description": "The pattern to match with." - } - }, - "required": [ - "operator", - "pattern" + "stargazers_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/stargazers" ] - } - } - }, - "repository-rule-params-restricted-commits": { - "title": "RestrictedCommits", - "description": "Restricted commit", - "type": "object", - "properties": { - "oid": { + }, + "statuses_url": { "type": "string", - "description": "Full or abbreviated commit hash to reject" + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + ] }, - "reason": { + "subscribers_url": { "type": "string", - "description": "Reason for restriction" - } - }, - "required": [ - "oid" - ] - }, - "repository-rule-params-workflow-file-reference": { - "title": "WorkflowFileReference", - "description": "A workflow that must run for this rule to pass", - "type": "object", - "properties": { - "path": { + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscribers" + ] + }, + "subscription_url": { "type": "string", - "description": "The path to the workflow file" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/subscription" + ] }, - "ref": { + "tags_url": { "type": "string", - "description": "The ref (branch or tag) of the workflow file to use" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/tags" + ] }, - "repository_id": { - "type": "integer", - "description": "The ID of the repository where the workflow is defined" + "teams_url": { + "type": "string", + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/teams" + ] }, - "sha": { + "trees_url": { "type": "string", - "description": "The commit SHA of the workflow file to use" - } - }, - "required": [ - "path", - "repository_id" - ] - }, - "repository-rule-workflows": { - "title": "workflows", - "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + ] + }, + "clone_url": { "type": "string", - "enum": [ - "workflows" + "examples": [ + "https://github.com/octocat/Hello-World.git" ] }, - "parameters": { - "type": "object", - "properties": { - "do_not_enforce_on_create": { - "type": "boolean", - "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." - }, - "workflows": { - "type": "array", - "description": "Workflows that must pass for this rule to pass.", - "items": { - "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" - } - } - }, - "required": [ - "workflows" + "mirror_url": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "git:git.example.com/octocat/Hello-World" ] - } - } - }, - "repository-rule-params-code-scanning-tool": { - "title": "CodeScanningTool", - "description": "A tool that must provide code scanning results for this rule to pass.", - "type": "object", - "properties": { - "alerts_threshold": { + }, + "hooks_url": { "type": "string", - "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "errors", - "errors_and_warnings", - "all" + "format": "uri", + "examples": [ + "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, - "security_alerts_threshold": { + "svn_url": { "type": "string", - "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", - "enum": [ - "none", - "critical", - "high_or_higher", - "medium_or_higher", - "all" + "format": "uri", + "examples": [ + "https://svn.github.com/octocat/Hello-World" ] }, - "tool": { - "type": "string", - "description": "The name of a code scanning tool" - } - }, - "required": [ - "alerts_threshold", - "security_alerts_threshold", - "tool" - ] - }, - "repository-rule-code-scanning": { - "title": "code_scanning", - "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { + "homepage": { + "type": [ + "string", + "null" + ], + "format": "uri", + "examples": [ + "https://github.com" + ] + }, + "language": { + "type": [ + "string", + "null" + ] + }, + "forks_count": { + "type": "integer", + "examples": [ + 9 + ] + }, + "stargazers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "watchers_count": { + "type": "integer", + "examples": [ + 80 + ] + }, + "size": { + "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.", + "type": "integer", + "examples": [ + 108 + ] + }, + "default_branch": { "type": "string", - "enum": [ - "code_scanning" + "examples": [ + "master" ] }, - "parameters": { - "type": "object", - "properties": { - "code_scanning_tools": { - "type": "array", - "description": "Tools that must provide code scanning results for this rule to pass.", - "items": { - "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" - } - } - }, - "required": [ - "code_scanning_tools" + "open_issues_count": { + "type": "integer", + "examples": [ + 0 ] - } - } - }, - "repository-rule": { - "title": "Repository Rule", - "type": "object", - "description": "A repository rule.", - "oneOf": [ - { - "$ref": "#/components/schemas/repository-rule-creation" }, - { - "$ref": "#/components/schemas/repository-rule-update" + "is_template": { + "type": "boolean", + "examples": [ + true + ] }, - { - "$ref": "#/components/schemas/repository-rule-deletion" + "topics": { + "type": "array", + "items": { + "type": "string" + }, + "examples": [ + "octocat", + "atom", + "electron", + "API" + ] }, - { - "$ref": "#/components/schemas/repository-rule-required-linear-history" + "has_issues": { + "type": "boolean", + "examples": [ + true + ] }, - { - "$ref": "#/components/schemas/repository-rule-merge-queue" + "has_projects": { + "type": "boolean", + "examples": [ + true + ] }, - { - "$ref": "#/components/schemas/repository-rule-required-deployments" + "has_wiki": { + "type": "boolean", + "examples": [ + true + ] }, - { - "$ref": "#/components/schemas/repository-rule-required-signatures" + "has_pages": { + "type": "boolean" }, - { - "$ref": "#/components/schemas/repository-rule-pull-request" + "has_downloads": { + "type": "boolean", + "examples": [ + true + ] }, - { - "$ref": "#/components/schemas/repository-rule-required-status-checks" + "has_discussions": { + "type": "boolean", + "examples": [ + true + ] }, - { - "$ref": "#/components/schemas/repository-rule-non-fast-forward" + "archived": { + "type": "boolean" }, - { - "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." }, - { - "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "type": "string", + "examples": [ + "public" + ] }, - { - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + "pushed_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:06:43Z" + ] }, - { - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + "created_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:01:12Z" + ] }, - { - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + "updated_at": { + "type": "string", + "format": "date-time", + "examples": [ + "2011-01-26T19:14:43Z" + ] }, - { - "title": "file_path_restriction", - "description": "Prevent commits that include changes in specified file paths from being pushed to the commit graph.", + "permissions": { "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "type": "string", - "enum": [ - "file_path_restriction" - ] + "admin": { + "type": "boolean" }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_paths": { - "type": "array", - "description": "The file paths that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_paths" - ] - } - } - }, - { - "title": "max_file_path_length", - "description": "Prevent commits that include file paths that exceed a specified character limit from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_path_length" - ] + "maintain": { + "type": "boolean" }, - "parameters": { - "type": "object", - "properties": { - "max_file_path_length": { - "type": "integer", - "description": "The maximum amount of characters allowed in file paths", - "minimum": 1, - "maximum": 256 - } - }, - "required": [ - "max_file_path_length" - ] - } - } - }, - { - "title": "file_extension_restriction", - "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", - "type": "object", - "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "file_extension_restriction" - ] + "push": { + "type": "boolean" }, - "parameters": { - "type": "object", - "properties": { - "restricted_file_extensions": { - "type": "array", - "description": "The file extensions that are restricted from being pushed to the commit graph.", - "items": { - "type": "string" - } - } - }, - "required": [ - "restricted_file_extensions" - ] + "triage": { + "type": "boolean" + }, + "pull": { + "type": "boolean" } - } - }, - { - "title": "max_file_size", - "description": "Prevent commits that exceed a specified file size limit from being pushed to the commit.", - "type": "object", + }, "required": [ - "type" - ], - "properties": { - "type": { - "type": "string", - "enum": [ - "max_file_size" - ] + "admin", + "pull", + "push" + ] + }, + "allow_rebase_merge": { + "type": "boolean", + "examples": [ + true + ] + }, + "template_repository": { + "anyOf": [ + { + "type": "null" }, - "parameters": { - "type": "object", - "properties": { - "max_file_size": { - "type": "integer", - "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", - "minimum": 1, - "maximum": 100 - } - }, - "required": [ - "max_file_size" - ] + { + "$ref": "#/components/schemas/repository" } - } + ] }, - { - "$ref": "#/components/schemas/repository-rule-workflows" + "temp_clone_token": { + "type": [ + "string", + "null" + ] }, - { - "$ref": "#/components/schemas/repository-rule-code-scanning" - } - ] - }, - "repository-ruleset": { - "title": "Repository ruleset", - "type": "object", - "description": "A set of rules to apply when specified conditions are met.", - "required": [ - "id", - "name", - "source", - "enforcement" - ], - "properties": { - "id": { - "type": "integer", - "description": "The ID of the ruleset" + "allow_squash_merge": { + "type": "boolean", + "examples": [ + true + ] }, - "name": { + "allow_auto_merge": { + "type": "boolean", + "examples": [ + false + ] + }, + "delete_branch_on_merge": { + "type": "boolean", + "examples": [ + false + ] + }, + "allow_merge_commit": { + "type": "boolean", + "examples": [ + true + ] + }, + "allow_update_branch": { + "type": "boolean", + "examples": [ + true + ] + }, + "use_squash_pr_title_as_default": { + "type": "boolean", + "examples": [ + false + ] + }, + "squash_merge_commit_title": { "type": "string", - "description": "The name of the ruleset" + "enum": [ + "PR_TITLE", + "COMMIT_OR_PR_TITLE" + ], + "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit).", + "examples": [ + "PR_TITLE" + ] }, - "target": { + "squash_merge_commit_message": { "type": "string", - "description": "The target of the ruleset", "enum": [ - "branch", - "tag", - "push" + "PR_BODY", + "COMMIT_MESSAGES", + "BLANK" + ], + "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", + "examples": [ + "PR_BODY" ] }, - "source_type": { + "merge_commit_title": { "type": "string", - "description": "The type of the source of the ruleset", "enum": [ - "Repository", - "Organization" + "PR_TITLE", + "MERGE_MESSAGE" + ], + "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", + "examples": [ + "PR_TITLE" ] }, - "source": { + "merge_commit_message": { "type": "string", - "description": "The name of the source" + "enum": [ + "PR_BODY", + "PR_TITLE", + "BLANK" + ], + "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", + "examples": [ + "PR_BODY" + ] }, - "enforcement": { - "$ref": "#/components/schemas/repository-rule-enforcement" + "allow_forking": { + "type": "boolean", + "examples": [ + true + ] }, - "bypass_actors": { - "type": "array", - "description": "The actors that can bypass the rules in this ruleset", - "items": { - "$ref": "#/components/schemas/repository-ruleset-bypass-actor" - } + "web_commit_signoff_required": { + "type": "boolean", + "examples": [ + false + ] }, - "current_user_can_bypass": { - "type": "string", - "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", - "enum": [ - "always", - "pull_requests_only", - "never" + "subscribers_count": { + "type": "integer", + "examples": [ + 42 ] }, - "node_id": { - "type": "string" + "network_count": { + "type": "integer", + "examples": [ + 0 + ] }, - "_links": { - "type": "object", - "properties": { - "self": { - "type": "object", - "properties": { - "href": { - "type": "string", - "description": "The URL of the ruleset" - } - } + "license": { + "anyOf": [ + { + "type": "null" }, - "html": { - "type": [ - "object", - "null" - ], - "properties": { - "href": { - "type": "string", - "description": "The html URL of the ruleset" - } - } + { + "$ref": "#/components/schemas/license-simple" } - } + ] }, - "conditions": { + "organization": { "anyOf": [ { - "$ref": "#/components/schemas/repository-ruleset-conditions" + "type": "null" }, { - "$ref": "#/components/schemas/org-ruleset-conditions" + "$ref": "#/components/schemas/simple-user" } - ], - "type": [ - "null", - "object" ] }, - "rules": { - "type": "array", - "items": { - "$ref": "#/components/schemas/repository-rule" - } + "parent": { + "$ref": "#/components/schemas/repository" }, - "created_at": { - "type": "string", - "format": "date-time" + "source": { + "$ref": "#/components/schemas/repository" }, - "updated_at": { - "type": "string", - "format": "date-time" + "forks": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "anonymous_access_enabled": { + "description": "Whether anonymous git access is allowed.", + "default": true, + "type": "boolean" + }, + "code_of_conduct": { + "$ref": "#/components/schemas/code-of-conduct-simple" + }, + "security_and_analysis": { + "$ref": "#/components/schemas/security-and-analysis" + }, + "custom_properties": { + "type": "object", + "description": "The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values.", + "additionalProperties": true } - } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "has_discussions", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at", + "network_count", + "subscribers_count" + ] }, "rule-suites": { "title": "Rule Suites", @@ -119518,6 +120060,9 @@ }, "dependency_snapshots": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -133723,6 +134268,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -140577,6 +141129,13 @@ "dismissed" ] }, + "reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "The comment the reviewer provided when responding to the exemption request." + }, "created_at": { "type": "string", "format": "date-time", @@ -151988,6 +152547,13 @@ } ] }, + "push_protection_bypass_request_reviewer_comment": { + "type": [ + "string", + "null" + ], + "description": "An optional comment when reviewing a push protection bypass." + }, "push_protection_bypass_request_comment": { "type": [ "string", @@ -287852,6 +288418,44 @@ ] } }, + "enterprise-ruleset": { + "value": { + "id": 21, + "name": "super cool ruleset", + "target": "repository", + "source_type": "Enterprise", + "source": "my-enterprise", + "enforcement": "active", + "conditions": { + "organization_name": { + "include": [ + "important_organization" + ] + }, + "repository_name": { + "include": [ + "~ALL" + ] + } + }, + "rules": [ + { + "type": "repository_delete" + } + ], + "node_id": "RRS_lACkVXNlcgQB", + "_links": { + "self": { + "href": "https://api.github.com/enterprises/my-enterprise/rulesets/21" + }, + "html": { + "href": "https://github.com/enterprise/my-enterprise/settings/policies/repositories/21" + } + }, + "created_at": "2024-08-15T08:43:03Z", + "updated_at": "2024-09-23T16:29:47Z" + } + }, "organization-secret-scanning-alert-list": { "value": [ { @@ -287995,6 +288599,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -288086,6 +288691,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -295503,6 +296109,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -308268,6 +308880,7 @@ "type": "User", "site_admin": true }, + "push_protection_bypass_request_reviewer_comment": "Example response", "push_protection_bypass_request_comment": "Example comment", "push_protection_bypass_request_html_url": "https://github.com/owner/repo/secret_scanning_exemptions/1", "resolution_comment": "Example comment", @@ -308292,6 +308905,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -308319,6 +308933,7 @@ "push_protection_bypassed": false, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": null, @@ -308364,6 +308979,7 @@ "push_protection_bypassed_by": null, "push_protection_bypassed_at": null, "push_protection_bypass_request_reviewer": null, + "push_protection_bypass_request_reviewer_comment": null, "push_protection_bypass_request_comment": null, "push_protection_bypass_request_html_url": null, "resolution_comment": "Example comment", diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index 7c453e138..5a1f692b7 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -3575,7 +3575,7 @@ paths: '404': "$ref": "#/components/responses/not_found" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-user-management @@ -3646,7 +3646,7 @@ paths: '422': "$ref": "#/components/responses/usage_metrics_api_disabled" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-metrics @@ -3723,7 +3723,7 @@ paths: '404': "$ref": "#/components/responses/not_found" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage @@ -3982,6 +3982,22 @@ paths: parameters: - "$ref": "#/components/parameters/enterprise" - "$ref": "#/components/parameters/custom-property-name" + requestBody: + required: true + content: + application/json: + schema: + "$ref": "#/components/schemas/custom-property-set-payload" + examples: + default: + value: + value_type: single_select + required: true + default_value: production + description: Prod or dev environment + allowed_values: + - production + - development responses: '200': description: Response @@ -4031,6 +4047,249 @@ paths: enabledForGitHubApps: true category: enterprise-admin subcategory: custom-properties + "/enterprises/{enterprise}/rulesets": + post: + summary: Create an enterprise repository ruleset + description: Create a repository ruleset for an enterprise. + tags: + - repos + operationId: repos/create-enterprise-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#create-an-enterprise-repository-ruleset + parameters: + - "$ref": "#/components/parameters/enterprise" + requestBody: + description: Request body + required: true + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the ruleset. + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + default: branch + enforcement: + "$ref": "#/components/schemas/repository-rule-enforcement" + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + conditions: + "$ref": "#/components/schemas/enterprise-ruleset-conditions" + rules: + type: array + description: An array of rules within the ruleset. + items: + "$ref": "#/components/schemas/repository-rule" + required: + - name + - enforcement + examples: + default: + value: + name: super cool ruleset + target: repository + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + org_name: + include: + - important_org + exclude: + - unimportant_org + rules: + - type: repository_delete + responses: + '201': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/repository-ruleset" + examples: + default: + "$ref": "#/components/examples/enterprise-ruleset" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: rules + "/enterprises/{enterprise}/rulesets/{ruleset_id}": + get: + summary: Get an enterprise repository ruleset + description: |- + Get a repository ruleset for an enterprise. + + **Note:** To prevent leaking sensitive information, the `bypass_actors` property is only returned if the user + making the API request has write access to the ruleset. + tags: + - repos + operationId: repos/get-enterprise-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#get-an-enterprise-repository-ruleset + parameters: + - "$ref": "#/components/parameters/enterprise" + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/repository-ruleset" + examples: + default: + "$ref": "#/components/examples/enterprise-ruleset" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: rules + put: + summary: Update an enterprise repository ruleset + description: Update a ruleset for an enterprise. + tags: + - repos + operationId: repos/update-enterprise-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#update-an-enterprise-repository-ruleset + parameters: + - "$ref": "#/components/parameters/enterprise" + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + requestBody: + description: Request body + required: false + content: + application/json: + schema: + type: object + properties: + name: + type: string + description: The name of the ruleset. + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + enforcement: + "$ref": "#/components/schemas/repository-rule-enforcement" + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + conditions: + "$ref": "#/components/schemas/enterprise-ruleset-conditions" + rules: + description: An array of rules within the ruleset. + type: array + items: + "$ref": "#/components/schemas/repository-rule" + examples: + default: + value: + name: super cool ruleset + target: repository + enforcement: active + bypass_actors: + - actor_id: 234 + actor_type: Team + bypass_mode: always + conditions: + org_name: + include: + - important_org + exclude: + - unimportant_org + rules: + - type: repository_delete + responses: + '200': + description: Response + content: + application/json: + schema: + "$ref": "#/components/schemas/repository-ruleset" + examples: + default: + "$ref": "#/components/examples/enterprise-ruleset" + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: rules + delete: + summary: Delete an enterprise repository ruleset + description: Delete a ruleset for an enterprise. + tags: + - repos + operationId: repos/delete-enterprise-ruleset + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest//rest/enterprise-admin/rules#delete-an-enterprise-repository-ruleset + parameters: + - "$ref": "#/components/parameters/enterprise" + - name: ruleset_id + description: The ID of the ruleset. + in: path + required: true + schema: + type: integer + responses: + '204': + description: Response + '404': + "$ref": "#/components/responses/not_found" + '500': + "$ref": "#/components/responses/internal_error" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: enterprise-admin + subcategory: rules "/enterprises/{enterprise}/secret-scanning/alerts": get: summary: List secret scanning alerts for an enterprise @@ -4458,7 +4717,7 @@ paths: '422': "$ref": "#/components/responses/usage_metrics_api_disabled" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-metrics @@ -4537,7 +4796,7 @@ paths: '404': "$ref": "#/components/responses/not_found" x-github: - githubCloudOnly: false + githubCloudOnly: true enabledForGitHubApps: true category: copilot subcategory: copilot-usage @@ -9576,6 +9835,8 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: default: "$ref": "#/components/examples/list-attestations" @@ -16774,50 +17035,7 @@ paths: content: application/json: schema: - type: object - properties: - value_type: - type: string - enum: - - string - - single_select - - multi_select - - true_false - description: The type of the value for the property - examples: - - single_select - required: - type: boolean - description: Whether the property is required. - default_value: - oneOf: - - type: string - - type: array - items: - type: string - description: Default value of the property - type: - - 'null' - - string - - array - description: - type: - - string - - 'null' - description: Short description of the property - allowed_values: - type: - - array - - 'null' - items: - type: string - maxLength: 75 - maxItems: 200 - description: |- - An ordered list of the allowed values of the property. - The property can have up to 200 allowed values. - required: - - value_type + "$ref": "#/components/schemas/custom-property-set-payload" examples: default: value: @@ -17489,6 +17707,7 @@ paths: - branch - tag - push + - repository default: branch enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" @@ -17705,6 +17924,7 @@ paths: - branch - tag - push + - repository enforcement: "$ref": "#/components/schemas/repository-rule-enforcement" bypass_actors: @@ -24889,6 +25109,8 @@ paths: Refer to the [Sigstore Bundle Specification](https://github.com/sigstore/protobuf-specs/blob/main/protos/sigstore_bundle.proto) for more information. repository_id: type: integer + bundle_url: + type: string examples: default: "$ref": "#/components/examples/list-attestations" @@ -53343,6 +53565,8 @@ paths: "$ref": "#/components/schemas/sigstore-bundle-0" repository_id: type: integer + bundle_url: + type: string examples: default: value: @@ -77811,6 +78035,1083 @@ components: required: - property_name - value_type + custom-property-set-payload: + title: Custom Property Set Payload + description: Custom property set payload + type: object + properties: + value_type: + type: string + enum: + - string + - single_select + - multi_select + - true_false + description: The type of the value for the property + examples: + - single_select + required: + type: boolean + description: Whether the property is required. + default_value: + oneOf: + - type: string + - type: array + items: + type: string + description: Default value of the property + type: + - 'null' + - string + - array + description: + type: + - string + - 'null' + description: Short description of the property + allowed_values: + type: + - array + - 'null' + items: + type: string + maxLength: 75 + maxItems: 200 + description: |- + An ordered list of the allowed values of the property. + The property can have up to 200 allowed values. + required: + - value_type + repository-rule-enforcement: + type: string + description: The enforcement level of the ruleset. `evaluate` allows admins + to test rules before enforcing them. Admins can view insights on the Rule + Insights page. `evaluate` is not available for the `repository` target. + enum: + - disabled + - active + - evaluate + repository-ruleset-bypass-actor: + title: Repository Ruleset Bypass Actor + type: object + description: An actor that can bypass rules in a ruleset + required: + - actor_type + properties: + actor_id: + type: + - integer + - 'null' + description: The ID of the actor that can bypass a ruleset. If `actor_type` + is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, + this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` + is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable + for personal repositories. + actor_type: + type: string + enum: + - Integration + - OrganizationAdmin + - RepositoryRole + - Team + - DeployKey + - EnterpriseOwner + description: The type of actor that can bypass a ruleset + bypass_mode: + type: string + description: When the specified actor can bypass the ruleset. `pull_request` + means that an actor can only bypass rules on pull requests. `pull_request` + is not applicable for the `DeployKey` actor type. Also, `pull_request` + is only applicable to branch rulesets. + enum: + - always + - pull_request + default: always + enterprise-ruleset-conditions-organization-name-target: + title: Repository ruleset conditions for organization names + type: object + description: Parameters for an organization name condition + properties: + organization_name: + type: object + properties: + include: + type: array + description: Array of organization names or patterns to include. One + of these patterns must match for the condition to pass. Also accepts + `~ALL` to include all organizations and ~EMUS to target all enterprise + managed user accounts. + items: + type: string + exclude: + type: array + description: Array of organization names or patterns to exclude. The + condition will not pass if any of these patterns match. + items: + type: string + required: + - organization_name + repository-ruleset-conditions-repository-name-target: + title: Repository ruleset conditions for repository names + type: object + description: Parameters for a repository name condition + properties: + repository_name: + type: object + properties: + include: + type: array + description: Array of repository names or patterns to include. One of + these patterns must match for the condition to pass. Also accepts + `~ALL` to include all repositories. + items: + type: string + exclude: + type: array + description: Array of repository names or patterns to exclude. The condition + will not pass if any of these patterns match. + items: + type: string + protected: + type: boolean + description: Whether renaming of target repositories is prevented. + required: + - repository_name + repository-ruleset-conditions: + title: Repository ruleset conditions for ref names + type: object + description: Parameters for a repository ruleset ref name condition + properties: + ref_name: + type: object + properties: + include: + type: array + description: Array of ref names or patterns to include. One of these + patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` + to include the default branch or `~ALL` to include all branches. + items: + type: string + exclude: + type: array + description: Array of ref names or patterns to exclude. The condition + will not pass if any of these patterns match. + items: + type: string + repository-ruleset-conditions-repository-property-spec: + title: Repository ruleset property targeting definition + type: object + description: Parameters for a targeting a repository property + properties: + name: + type: string + description: The name of the repository property to target + property_values: + type: array + description: The values to match for the repository property + items: + type: string + source: + type: string + description: The source of the repository property. Defaults to 'custom' + if not specified. + enum: + - custom + - system + required: + - name + - property_values + repository-ruleset-conditions-repository-property-target: + title: Repository ruleset conditions for repository properties + type: object + description: Parameters for a repository property condition + properties: + repository_property: + type: object + properties: + include: + type: array + description: The repository properties and values to include. All of + these properties must match for the condition to pass. + items: + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + exclude: + type: array + description: The repository properties and values to exclude. The condition + will not pass if any of these properties match. + items: + "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" + required: + - repository_property + enterprise-ruleset-conditions-organization-id-target: + title: Repository ruleset conditions for organization IDs + type: object + description: Parameters for an organization ID condition + properties: + organization_id: + type: object + properties: + organization_ids: + type: array + description: The organization IDs that the ruleset applies to. One of + these IDs must match for the condition to pass. + items: + type: integer + required: + - organization_id + enterprise-ruleset-conditions: + title: Enterprise ruleset conditions + type: object + description: Conditions for an enterprise ruleset. The conditions object should + contain either the `organization_id` or `organization_name` property and the + `repository_name` or `repository_property` property. For branch and tag rulesets, + the conditions object should also contain the `ref_name` property. + oneOf: + - type: object + title: organization_name_and_repository_name + description: Conditions to target organizations by name and all repositories + allOf: + - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-name-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - type: object + title: organization_name_and_repository_property + description: Conditions to target organizations by name and repositories by + property + allOf: + - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-name-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - type: object + title: organization_id_and_repository_name + description: Conditions to target organizations by id and all repositories + allOf: + - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-id-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - type: object + title: organization_id_and_repository_property + description: Conditions to target organization by id and repositories by property + allOf: + - "$ref": "#/components/schemas/enterprise-ruleset-conditions-organization-id-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + - "$ref": "#/components/schemas/repository-ruleset-conditions" + repository-rule-creation: + title: creation + description: Only allow users with bypass permission to create matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - creation + repository-rule-update: + title: update + description: Only allow users with bypass permission to update matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - update + parameters: + type: object + properties: + update_allows_fetch_and_merge: + type: boolean + description: Branch can pull changes from its upstream repository + required: + - update_allows_fetch_and_merge + repository-rule-deletion: + title: deletion + description: Only allow users with bypass permissions to delete matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - deletion + repository-rule-required-linear-history: + title: required_linear_history + description: Prevent merge commits from being pushed to matching refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_linear_history + repository-rule-merge-queue: + title: merge_queue + description: Merges must be performed via a merge queue. + type: object + required: + - type + properties: + type: + type: string + enum: + - merge_queue + parameters: + type: object + properties: + check_response_timeout_minutes: + type: integer + description: Maximum time for a required status check to report a conclusion. + After this much time has elapsed, checks that have not reported a + conclusion will be assumed to have failed + minimum: 1 + maximum: 360 + grouping_strategy: + type: string + description: When set to ALLGREEN, the merge commit created by merge + queue for each PR in the group must pass all required checks to merge. + When set to HEADGREEN, only the commit at the head of the merge group, + i.e. the commit containing changes from all of the PRs in the group, + must pass its required checks to merge. + enum: + - ALLGREEN + - HEADGREEN + max_entries_to_build: + type: integer + description: Limit the number of queued pull requests requesting checks + and workflow runs at the same time. + minimum: 0 + maximum: 100 + max_entries_to_merge: + type: integer + description: The maximum number of PRs that will be merged together + in a group. + minimum: 0 + maximum: 100 + merge_method: + type: string + description: Method to use when merging changes from queued pull requests. + enum: + - MERGE + - SQUASH + - REBASE + min_entries_to_merge: + type: integer + description: The minimum number of PRs that will be merged together + in a group. + minimum: 0 + maximum: 100 + min_entries_to_merge_wait_minutes: + type: integer + description: The time merge queue should wait after the first PR is + added to the queue for the minimum group size to be met. After this + time has elapsed, the minimum group size will be ignored and a smaller + group will be merged. + minimum: 0 + maximum: 360 + required: + - check_response_timeout_minutes + - grouping_strategy + - max_entries_to_build + - max_entries_to_merge + - merge_method + - min_entries_to_merge + - min_entries_to_merge_wait_minutes + repository-rule-required-deployments: + title: required_deployments + description: Choose which environments must be successfully deployed to before + refs can be pushed into a ref that matches this rule. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_deployments + parameters: + type: object + properties: + required_deployment_environments: + type: array + description: The environments that must be successfully deployed to + before branches can be merged. + items: + type: string + required: + - required_deployment_environments + repository-rule-required-signatures: + title: required_signatures + description: Commits pushed to matching refs must have verified signatures. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_signatures + repository-rule-params-required-reviewer-configuration: + title: RequiredReviewerConfiguration + description: A reviewing team, and file patterns describing which files they + must approve changes to. + type: object + properties: + file_patterns: + type: array + description: Array of file patterns. Pull requests which change matching + files must be approved by the specified team. File patterns use the same + syntax as `.gitignore` files. + items: + type: string + minimum_approvals: + type: integer + description: Minimum number of approvals required from the specified team. + If set to zero, the team will be added to the pull request but approval + is optional. + reviewer_id: + type: string + description: Node ID of the team which must review changes to matching files. + required: + - file_patterns + - minimum_approvals + - reviewer_id + repository-rule-pull-request: + title: pull_request + description: Require all commits be made to a non-target branch and submitted + via a pull request before they can be merged. + type: object + required: + - type + properties: + type: + type: string + enum: + - pull_request + parameters: + type: object + properties: + allowed_merge_methods: + type: array + description: When merging pull requests, you can allow any combination + of merge commits, squashing, or rebasing. At least one option must + be enabled. + items: + type: string + dismiss_stale_reviews_on_push: + type: boolean + description: New, reviewable commits pushed will dismiss previous pull + request review approvals. + require_code_owner_review: + type: boolean + description: Require an approving review in pull requests that modify + files that have a designated code owner. + require_last_push_approval: + type: boolean + description: Whether the most recent reviewable push must be approved + by someone other than the person who pushed it. + required_approving_review_count: + type: integer + description: The number of approving reviews that are required before + a pull request can be merged. + minimum: 0 + maximum: 10 + required_review_thread_resolution: + type: boolean + description: All conversations on code must be resolved before a pull + request can be merged. + required: + - dismiss_stale_reviews_on_push + - require_code_owner_review + - require_last_push_approval + - required_approving_review_count + - required_review_thread_resolution + repository-rule-params-status-check-configuration: + title: StatusCheckConfiguration + description: Required status check + type: object + properties: + context: + type: string + description: The status check context name that must be present on the commit. + integration_id: + type: integer + description: The optional integration ID that this status check must originate + from. + required: + - context + repository-rule-required-status-checks: + title: required_status_checks + description: Choose which status checks must pass before the ref is updated. + When enabled, commits must first be pushed to another ref where the checks + pass. + type: object + required: + - type + properties: + type: + type: string + enum: + - required_status_checks + parameters: + type: object + properties: + do_not_enforce_on_create: + type: boolean + description: Allow repositories and branches to be created if a check + would otherwise prohibit it. + required_status_checks: + type: array + description: Status checks that are required. + items: + "$ref": "#/components/schemas/repository-rule-params-status-check-configuration" + strict_required_status_checks_policy: + type: boolean + description: Whether pull requests targeting a matching branch must + be tested with the latest code. This setting will not take effect + unless at least one status check is enabled. + required: + - required_status_checks + - strict_required_status_checks_policy + repository-rule-non-fast-forward: + title: non_fast_forward + description: Prevent users with push access from force pushing to refs. + type: object + required: + - type + properties: + type: + type: string + enum: + - non_fast_forward + repository-rule-commit-message-pattern: + title: commit_message_pattern + description: Parameters to be used for the commit_message_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - commit_message_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-commit-author-email-pattern: + title: commit_author_email_pattern + description: Parameters to be used for the commit_author_email_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - commit_author_email_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-committer-email-pattern: + title: committer_email_pattern + description: Parameters to be used for the committer_email_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - committer_email_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-branch-name-pattern: + title: branch_name_pattern + description: Parameters to be used for the branch_name_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - branch_name_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-tag-name-pattern: + title: tag_name_pattern + description: Parameters to be used for the tag_name_pattern rule + type: object + required: + - type + properties: + type: + type: string + enum: + - tag_name_pattern + parameters: + type: object + properties: + name: + type: string + description: How this rule will appear to users. + negate: + type: boolean + description: If true, the rule will fail if the pattern matches. + operator: + type: string + description: The operator to use for matching. + enum: + - starts_with + - ends_with + - contains + - regex + pattern: + type: string + description: The pattern to match with. + required: + - operator + - pattern + repository-rule-params-restricted-commits: + title: RestrictedCommits + description: Restricted commit + type: object + properties: + oid: + type: string + description: Full or abbreviated commit hash to reject + reason: + type: string + description: Reason for restriction + required: + - oid + repository-rule-params-workflow-file-reference: + title: WorkflowFileReference + description: A workflow that must run for this rule to pass + type: object + properties: + path: + type: string + description: The path to the workflow file + ref: + type: string + description: The ref (branch or tag) of the workflow file to use + repository_id: + type: integer + description: The ID of the repository where the workflow is defined + sha: + type: string + description: The commit SHA of the workflow file to use + required: + - path + - repository_id + repository-rule-workflows: + title: workflows + description: Require all changes made to a targeted branch to pass the specified + workflows before they can be merged. + type: object + required: + - type + properties: + type: + type: string + enum: + - workflows + parameters: + type: object + properties: + do_not_enforce_on_create: + type: boolean + description: Allow repositories and branches to be created if a check + would otherwise prohibit it. + workflows: + type: array + description: Workflows that must pass for this rule to pass. + items: + "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" + required: + - workflows + repository-rule-params-code-scanning-tool: + title: CodeScanningTool + description: A tool that must provide code scanning results for this rule to + pass. + type: object + properties: + alerts_threshold: + type: string + description: The severity level at which code scanning results that raise + alerts block a reference update. For more information on alert severity + levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + enum: + - none + - errors + - errors_and_warnings + - all + security_alerts_threshold: + type: string + description: The severity level at which code scanning results that raise + security alerts block a reference update. For more information on security + severity levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." + enum: + - none + - critical + - high_or_higher + - medium_or_higher + - all + tool: + type: string + description: The name of a code scanning tool + required: + - alerts_threshold + - security_alerts_threshold + - tool + repository-rule-code-scanning: + title: code_scanning + description: Choose which tools must provide code scanning results before the + reference is updated. When configured, code scanning must be enabled and have + results for both the commit and the reference being updated. + type: object + required: + - type + properties: + type: + type: string + enum: + - code_scanning + parameters: + type: object + properties: + code_scanning_tools: + type: array + description: Tools that must provide code scanning results for this + rule to pass. + items: + "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" + required: + - code_scanning_tools + repository-rule: + title: Repository Rule + type: object + description: A repository rule. + oneOf: + - "$ref": "#/components/schemas/repository-rule-creation" + - "$ref": "#/components/schemas/repository-rule-update" + - "$ref": "#/components/schemas/repository-rule-deletion" + - "$ref": "#/components/schemas/repository-rule-required-linear-history" + - "$ref": "#/components/schemas/repository-rule-merge-queue" + - "$ref": "#/components/schemas/repository-rule-required-deployments" + - "$ref": "#/components/schemas/repository-rule-required-signatures" + - "$ref": "#/components/schemas/repository-rule-pull-request" + - "$ref": "#/components/schemas/repository-rule-required-status-checks" + - "$ref": "#/components/schemas/repository-rule-non-fast-forward" + - "$ref": "#/components/schemas/repository-rule-commit-message-pattern" + - "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" + - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" + - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" + - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" + - title: file_path_restriction + description: Prevent commits that include changes in specified file paths + from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_path_restriction + parameters: + type: object + properties: + restricted_file_paths: + type: array + description: The file paths that are restricted from being pushed + to the commit graph. + items: + type: string + required: + - restricted_file_paths + - title: max_file_path_length + description: Prevent commits that include file paths that exceed a specified + character limit from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_path_length + parameters: + type: object + properties: + max_file_path_length: + type: integer + description: The maximum amount of characters allowed in file paths + minimum: 1 + maximum: 256 + required: + - max_file_path_length + - title: file_extension_restriction + description: Prevent commits that include files with specified file extensions + from being pushed to the commit graph. + type: object + required: + - type + properties: + type: + type: string + enum: + - file_extension_restriction + parameters: + type: object + properties: + restricted_file_extensions: + type: array + description: The file extensions that are restricted from being pushed + to the commit graph. + items: + type: string + required: + - restricted_file_extensions + - title: max_file_size + description: Prevent commits that exceed a specified file size limit from + being pushed to the commit. + type: object + required: + - type + properties: + type: + type: string + enum: + - max_file_size + parameters: + type: object + properties: + max_file_size: + type: integer + description: The maximum file size allowed in megabytes. This limit + does not apply to Git Large File Storage (Git LFS). + minimum: 1 + maximum: 100 + required: + - max_file_size + - "$ref": "#/components/schemas/repository-rule-workflows" + - "$ref": "#/components/schemas/repository-rule-code-scanning" + repository-ruleset-conditions-repository-id-target: + title: Repository ruleset conditions for repository IDs + type: object + description: Parameters for a repository ID condition + properties: + repository_id: + type: object + properties: + repository_ids: + type: array + description: The repository IDs that the ruleset applies to. One of + these IDs must match for the condition to pass. + items: + type: integer + required: + - repository_id + org-ruleset-conditions: + title: Organization ruleset conditions + type: object + description: |- + Conditions for an organization ruleset. + The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. + The push rulesets conditions object does not require the `ref_name` property. + For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. + oneOf: + - type: object + title: repository_name_and_ref_name + description: Conditions to target repositories by name and refs by name + allOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" + - type: object + title: repository_id_and_ref_name + description: Conditions to target repositories by id and refs by name + allOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" + - type: object + title: repository_property_and_ref_name + description: Conditions to target repositories by property and refs by name + allOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" + repository-ruleset: + title: Repository ruleset + type: object + description: A set of rules to apply when specified conditions are met. + required: + - id + - name + - source + - enforcement + properties: + id: + type: integer + description: The ID of the ruleset + name: + type: string + description: The name of the ruleset + target: + type: string + description: The target of the ruleset + enum: + - branch + - tag + - push + - repository + source_type: + type: string + description: The type of the source of the ruleset + enum: + - Repository + - Organization + - Enterprise + source: + type: string + description: The name of the source + enforcement: + "$ref": "#/components/schemas/repository-rule-enforcement" + bypass_actors: + type: array + description: The actors that can bypass the rules in this ruleset + items: + "$ref": "#/components/schemas/repository-ruleset-bypass-actor" + current_user_can_bypass: + type: string + description: |- + The bypass type of the user making the API request for this ruleset. This field is only returned when + querying the repository-level endpoint. + enum: + - always + - pull_requests_only + - never + node_id: + type: string + _links: + type: object + properties: + self: + type: object + properties: + href: + type: string + description: The URL of the ruleset + html: + type: + - object + - 'null' + properties: + href: + type: string + description: The html URL of the ruleset + conditions: + anyOf: + - "$ref": "#/components/schemas/repository-ruleset-conditions" + - "$ref": "#/components/schemas/org-ruleset-conditions" + type: + - 'null' + - object + rules: + type: array + items: + "$ref": "#/components/schemas/repository-rule" + created_at: + type: string + format: date-time + updated_at: + type: string + format: date-time secret-scanning-alert-state: description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`. @@ -77896,6 +79197,11 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. push_protection_bypass_request_comment: type: - string @@ -83943,949 +85249,6 @@ components: - updated_at - network_count - subscribers_count - repository-rule-enforcement: - type: string - description: The enforcement level of the ruleset. `evaluate` allows admins - to test rules before enforcing them. Admins can view insights on the Rule - Insights page. - enum: - - disabled - - active - - evaluate - repository-ruleset-bypass-actor: - title: Repository Ruleset Bypass Actor - type: object - description: An actor that can bypass rules in a ruleset - required: - - actor_type - properties: - actor_id: - type: - - integer - - 'null' - description: The ID of the actor that can bypass a ruleset. If `actor_type` - is `OrganizationAdmin`, this should be `1`. If `actor_type` is `DeployKey`, - this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` - is ignored. `OrganizationAdmin` and `EnterpriseOwner` are not applicable - for personal repositories. - actor_type: - type: string - enum: - - Integration - - OrganizationAdmin - - RepositoryRole - - Team - - DeployKey - - EnterpriseOwner - description: The type of actor that can bypass a ruleset - bypass_mode: - type: string - description: When the specified actor can bypass the ruleset. `pull_request` - means that an actor can only bypass rules on pull requests. `pull_request` - is not applicable for the `DeployKey` actor type. Also, `pull_request` - is only applicable to branch rulesets. - enum: - - always - - pull_request - default: always - repository-ruleset-conditions: - title: Repository ruleset conditions for ref names - type: object - description: Parameters for a repository ruleset ref name condition - properties: - ref_name: - type: object - properties: - include: - type: array - description: Array of ref names or patterns to include. One of these - patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` - to include the default branch or `~ALL` to include all branches. - items: - type: string - exclude: - type: array - description: Array of ref names or patterns to exclude. The condition - will not pass if any of these patterns match. - items: - type: string - repository-ruleset-conditions-repository-name-target: - title: Repository ruleset conditions for repository names - type: object - description: Parameters for a repository name condition - properties: - repository_name: - type: object - properties: - include: - type: array - description: Array of repository names or patterns to include. One of - these patterns must match for the condition to pass. Also accepts - `~ALL` to include all repositories. - items: - type: string - exclude: - type: array - description: Array of repository names or patterns to exclude. The condition - will not pass if any of these patterns match. - items: - type: string - protected: - type: boolean - description: Whether renaming of target repositories is prevented. - required: - - repository_name - repository-ruleset-conditions-repository-id-target: - title: Repository ruleset conditions for repository IDs - type: object - description: Parameters for a repository ID condition - properties: - repository_id: - type: object - properties: - repository_ids: - type: array - description: The repository IDs that the ruleset applies to. One of - these IDs must match for the condition to pass. - items: - type: integer - required: - - repository_id - repository-ruleset-conditions-repository-property-spec: - title: Repository ruleset property targeting definition - type: object - description: Parameters for a targeting a repository property - properties: - name: - type: string - description: The name of the repository property to target - property_values: - type: array - description: The values to match for the repository property - items: - type: string - source: - type: string - description: The source of the repository property. Defaults to 'custom' - if not specified. - enum: - - custom - - system - required: - - name - - property_values - repository-ruleset-conditions-repository-property-target: - title: Repository ruleset conditions for repository properties - type: object - description: Parameters for a repository property condition - properties: - repository_property: - type: object - properties: - include: - type: array - description: The repository properties and values to include. All of - these properties must match for the condition to pass. - items: - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" - exclude: - type: array - description: The repository properties and values to exclude. The condition - will not pass if any of these properties match. - items: - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" - required: - - repository_property - org-ruleset-conditions: - title: Organization ruleset conditions - type: object - description: |- - Conditions for an organization ruleset. - The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. - The push rulesets conditions object does not require the `ref_name` property. - oneOf: - - type: object - title: repository_name_and_ref_name - description: Conditions to target repositories by name and refs by name - allOf: - - "$ref": "#/components/schemas/repository-ruleset-conditions" - - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" - - type: object - title: repository_id_and_ref_name - description: Conditions to target repositories by id and refs by name - allOf: - - "$ref": "#/components/schemas/repository-ruleset-conditions" - - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" - - type: object - title: repository_property_and_ref_name - description: Conditions to target repositories by property and refs by name - allOf: - - "$ref": "#/components/schemas/repository-ruleset-conditions" - - "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" - repository-rule-creation: - title: creation - description: Only allow users with bypass permission to create matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - creation - repository-rule-update: - title: update - description: Only allow users with bypass permission to update matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - update - parameters: - type: object - properties: - update_allows_fetch_and_merge: - type: boolean - description: Branch can pull changes from its upstream repository - required: - - update_allows_fetch_and_merge - repository-rule-deletion: - title: deletion - description: Only allow users with bypass permissions to delete matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - deletion - repository-rule-required-linear-history: - title: required_linear_history - description: Prevent merge commits from being pushed to matching refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_linear_history - repository-rule-merge-queue: - title: merge_queue - description: Merges must be performed via a merge queue. - type: object - required: - - type - properties: - type: - type: string - enum: - - merge_queue - parameters: - type: object - properties: - check_response_timeout_minutes: - type: integer - description: Maximum time for a required status check to report a conclusion. - After this much time has elapsed, checks that have not reported a - conclusion will be assumed to have failed - minimum: 1 - maximum: 360 - grouping_strategy: - type: string - description: When set to ALLGREEN, the merge commit created by merge - queue for each PR in the group must pass all required checks to merge. - When set to HEADGREEN, only the commit at the head of the merge group, - i.e. the commit containing changes from all of the PRs in the group, - must pass its required checks to merge. - enum: - - ALLGREEN - - HEADGREEN - max_entries_to_build: - type: integer - description: Limit the number of queued pull requests requesting checks - and workflow runs at the same time. - minimum: 0 - maximum: 100 - max_entries_to_merge: - type: integer - description: The maximum number of PRs that will be merged together - in a group. - minimum: 0 - maximum: 100 - merge_method: - type: string - description: Method to use when merging changes from queued pull requests. - enum: - - MERGE - - SQUASH - - REBASE - min_entries_to_merge: - type: integer - description: The minimum number of PRs that will be merged together - in a group. - minimum: 0 - maximum: 100 - min_entries_to_merge_wait_minutes: - type: integer - description: The time merge queue should wait after the first PR is - added to the queue for the minimum group size to be met. After this - time has elapsed, the minimum group size will be ignored and a smaller - group will be merged. - minimum: 0 - maximum: 360 - required: - - check_response_timeout_minutes - - grouping_strategy - - max_entries_to_build - - max_entries_to_merge - - merge_method - - min_entries_to_merge - - min_entries_to_merge_wait_minutes - repository-rule-required-deployments: - title: required_deployments - description: Choose which environments must be successfully deployed to before - refs can be pushed into a ref that matches this rule. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_deployments - parameters: - type: object - properties: - required_deployment_environments: - type: array - description: The environments that must be successfully deployed to - before branches can be merged. - items: - type: string - required: - - required_deployment_environments - repository-rule-required-signatures: - title: required_signatures - description: Commits pushed to matching refs must have verified signatures. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_signatures - repository-rule-params-required-reviewer-configuration: - title: RequiredReviewerConfiguration - description: A reviewing team, and file patterns describing which files they - must approve changes to. - type: object - properties: - file_patterns: - type: array - description: Array of file patterns. Pull requests which change matching - files must be approved by the specified team. File patterns use the same - syntax as `.gitignore` files. - items: - type: string - minimum_approvals: - type: integer - description: Minimum number of approvals required from the specified team. - If set to zero, the team will be added to the pull request but approval - is optional. - reviewer_id: - type: string - description: Node ID of the team which must review changes to matching files. - required: - - file_patterns - - minimum_approvals - - reviewer_id - repository-rule-pull-request: - title: pull_request - description: Require all commits be made to a non-target branch and submitted - via a pull request before they can be merged. - type: object - required: - - type - properties: - type: - type: string - enum: - - pull_request - parameters: - type: object - properties: - dismiss_stale_reviews_on_push: - type: boolean - description: New, reviewable commits pushed will dismiss previous pull - request review approvals. - require_code_owner_review: - type: boolean - description: Require an approving review in pull requests that modify - files that have a designated code owner. - require_last_push_approval: - type: boolean - description: Whether the most recent reviewable push must be approved - by someone other than the person who pushed it. - required_approving_review_count: - type: integer - description: The number of approving reviews that are required before - a pull request can be merged. - minimum: 0 - maximum: 10 - required_review_thread_resolution: - type: boolean - description: All conversations on code must be resolved before a pull - request can be merged. - required: - - dismiss_stale_reviews_on_push - - require_code_owner_review - - require_last_push_approval - - required_approving_review_count - - required_review_thread_resolution - repository-rule-params-status-check-configuration: - title: StatusCheckConfiguration - description: Required status check - type: object - properties: - context: - type: string - description: The status check context name that must be present on the commit. - integration_id: - type: integer - description: The optional integration ID that this status check must originate - from. - required: - - context - repository-rule-required-status-checks: - title: required_status_checks - description: Choose which status checks must pass before the ref is updated. - When enabled, commits must first be pushed to another ref where the checks - pass. - type: object - required: - - type - properties: - type: - type: string - enum: - - required_status_checks - parameters: - type: object - properties: - do_not_enforce_on_create: - type: boolean - description: Allow repositories and branches to be created if a check - would otherwise prohibit it. - required_status_checks: - type: array - description: Status checks that are required. - items: - "$ref": "#/components/schemas/repository-rule-params-status-check-configuration" - strict_required_status_checks_policy: - type: boolean - description: Whether pull requests targeting a matching branch must - be tested with the latest code. This setting will not take effect - unless at least one status check is enabled. - required: - - required_status_checks - - strict_required_status_checks_policy - repository-rule-non-fast-forward: - title: non_fast_forward - description: Prevent users with push access from force pushing to refs. - type: object - required: - - type - properties: - type: - type: string - enum: - - non_fast_forward - repository-rule-commit-message-pattern: - title: commit_message_pattern - description: Parameters to be used for the commit_message_pattern rule - type: object - required: - - type - properties: - type: - type: string - enum: - - commit_message_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - repository-rule-commit-author-email-pattern: - title: commit_author_email_pattern - description: Parameters to be used for the commit_author_email_pattern rule - type: object - required: - - type - properties: - type: - type: string - enum: - - commit_author_email_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - repository-rule-committer-email-pattern: - title: committer_email_pattern - description: Parameters to be used for the committer_email_pattern rule - type: object - required: - - type - properties: - type: - type: string - enum: - - committer_email_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - repository-rule-branch-name-pattern: - title: branch_name_pattern - description: Parameters to be used for the branch_name_pattern rule - type: object - required: - - type - properties: - type: - type: string - enum: - - branch_name_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - repository-rule-tag-name-pattern: - title: tag_name_pattern - description: Parameters to be used for the tag_name_pattern rule - type: object - required: - - type - properties: - type: - type: string - enum: - - tag_name_pattern - parameters: - type: object - properties: - name: - type: string - description: How this rule will appear to users. - negate: - type: boolean - description: If true, the rule will fail if the pattern matches. - operator: - type: string - description: The operator to use for matching. - enum: - - starts_with - - ends_with - - contains - - regex - pattern: - type: string - description: The pattern to match with. - required: - - operator - - pattern - repository-rule-params-restricted-commits: - title: RestrictedCommits - description: Restricted commit - type: object - properties: - oid: - type: string - description: Full or abbreviated commit hash to reject - reason: - type: string - description: Reason for restriction - required: - - oid - repository-rule-params-workflow-file-reference: - title: WorkflowFileReference - description: A workflow that must run for this rule to pass - type: object - properties: - path: - type: string - description: The path to the workflow file - ref: - type: string - description: The ref (branch or tag) of the workflow file to use - repository_id: - type: integer - description: The ID of the repository where the workflow is defined - sha: - type: string - description: The commit SHA of the workflow file to use - required: - - path - - repository_id - repository-rule-workflows: - title: workflows - description: Require all changes made to a targeted branch to pass the specified - workflows before they can be merged. - type: object - required: - - type - properties: - type: - type: string - enum: - - workflows - parameters: - type: object - properties: - do_not_enforce_on_create: - type: boolean - description: Allow repositories and branches to be created if a check - would otherwise prohibit it. - workflows: - type: array - description: Workflows that must pass for this rule to pass. - items: - "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" - required: - - workflows - repository-rule-params-code-scanning-tool: - title: CodeScanningTool - description: A tool that must provide code scanning results for this rule to - pass. - type: object - properties: - alerts_threshold: - type: string - description: The severity level at which code scanning results that raise - alerts block a reference update. For more information on alert severity - levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." - enum: - - none - - errors - - errors_and_warnings - - all - security_alerts_threshold: - type: string - description: The severity level at which code scanning results that raise - security alerts block a reference update. For more information on security - severity levels, see "[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels)." - enum: - - none - - critical - - high_or_higher - - medium_or_higher - - all - tool: - type: string - description: The name of a code scanning tool - required: - - alerts_threshold - - security_alerts_threshold - - tool - repository-rule-code-scanning: - title: code_scanning - description: Choose which tools must provide code scanning results before the - reference is updated. When configured, code scanning must be enabled and have - results for both the commit and the reference being updated. - type: object - required: - - type - properties: - type: - type: string - enum: - - code_scanning - parameters: - type: object - properties: - code_scanning_tools: - type: array - description: Tools that must provide code scanning results for this - rule to pass. - items: - "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" - required: - - code_scanning_tools - repository-rule: - title: Repository Rule - type: object - description: A repository rule. - oneOf: - - "$ref": "#/components/schemas/repository-rule-creation" - - "$ref": "#/components/schemas/repository-rule-update" - - "$ref": "#/components/schemas/repository-rule-deletion" - - "$ref": "#/components/schemas/repository-rule-required-linear-history" - - "$ref": "#/components/schemas/repository-rule-merge-queue" - - "$ref": "#/components/schemas/repository-rule-required-deployments" - - "$ref": "#/components/schemas/repository-rule-required-signatures" - - "$ref": "#/components/schemas/repository-rule-pull-request" - - "$ref": "#/components/schemas/repository-rule-required-status-checks" - - "$ref": "#/components/schemas/repository-rule-non-fast-forward" - - "$ref": "#/components/schemas/repository-rule-commit-message-pattern" - - "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" - - "$ref": "#/components/schemas/repository-rule-committer-email-pattern" - - "$ref": "#/components/schemas/repository-rule-branch-name-pattern" - - "$ref": "#/components/schemas/repository-rule-tag-name-pattern" - - title: file_path_restriction - description: Prevent commits that include changes in specified file paths - from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_path_restriction - parameters: - type: object - properties: - restricted_file_paths: - type: array - description: The file paths that are restricted from being pushed - to the commit graph. - items: - type: string - required: - - restricted_file_paths - - title: max_file_path_length - description: Prevent commits that include file paths that exceed a specified - character limit from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_path_length - parameters: - type: object - properties: - max_file_path_length: - type: integer - description: The maximum amount of characters allowed in file paths - minimum: 1 - maximum: 256 - required: - - max_file_path_length - - title: file_extension_restriction - description: Prevent commits that include files with specified file extensions - from being pushed to the commit graph. - type: object - required: - - type - properties: - type: - type: string - enum: - - file_extension_restriction - parameters: - type: object - properties: - restricted_file_extensions: - type: array - description: The file extensions that are restricted from being pushed - to the commit graph. - items: - type: string - required: - - restricted_file_extensions - - title: max_file_size - description: Prevent commits that exceed a specified file size limit from - being pushed to the commit. - type: object - required: - - type - properties: - type: - type: string - enum: - - max_file_size - parameters: - type: object - properties: - max_file_size: - type: integer - description: The maximum file size allowed in megabytes. This limit - does not apply to Git Large File Storage (Git LFS). - minimum: 1 - maximum: 100 - required: - - max_file_size - - "$ref": "#/components/schemas/repository-rule-workflows" - - "$ref": "#/components/schemas/repository-rule-code-scanning" - repository-ruleset: - title: Repository ruleset - type: object - description: A set of rules to apply when specified conditions are met. - required: - - id - - name - - source - - enforcement - properties: - id: - type: integer - description: The ID of the ruleset - name: - type: string - description: The name of the ruleset - target: - type: string - description: The target of the ruleset - enum: - - branch - - tag - - push - source_type: - type: string - description: The type of the source of the ruleset - enum: - - Repository - - Organization - source: - type: string - description: The name of the source - enforcement: - "$ref": "#/components/schemas/repository-rule-enforcement" - bypass_actors: - type: array - description: The actors that can bypass the rules in this ruleset - items: - "$ref": "#/components/schemas/repository-ruleset-bypass-actor" - current_user_can_bypass: - type: string - description: |- - The bypass type of the user making the API request for this ruleset. This field is only returned when - querying the repository-level endpoint. - enum: - - always - - pull_requests_only - - never - node_id: - type: string - _links: - type: object - properties: - self: - type: object - properties: - href: - type: string - description: The URL of the ruleset - html: - type: - - object - - 'null' - properties: - href: - type: string - description: The html URL of the ruleset - conditions: - anyOf: - - "$ref": "#/components/schemas/repository-ruleset-conditions" - - "$ref": "#/components/schemas/org-ruleset-conditions" - type: - - 'null' - - object - rules: - type: array - items: - "$ref": "#/components/schemas/repository-rule" - created_at: - type: string - format: date-time - updated_at: - type: string - format: date-time rule-suites: title: Rule Suites description: Response @@ -86801,6 +87164,8 @@ components: "$ref": "#/components/schemas/rate-limit" dependency_snapshots: "$ref": "#/components/schemas/rate-limit" + code_scanning_autofix: + "$ref": "#/components/schemas/rate-limit" required: - core - search @@ -96864,6 +97229,11 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. push_protection_bypass_request_comment: type: - string @@ -101849,6 +102219,12 @@ components: - approved - rejected - dismissed + reviewer_comment: + type: + - string + - 'null' + description: The comment the reviewer provided when responding to the exemption + request. created_at: type: string format: date-time @@ -110346,6 +110722,11 @@ components: anyOf: - type: 'null' - "$ref": "#/components/schemas/simple-user" + push_protection_bypass_request_reviewer_comment: + type: + - string + - 'null' + description: An optional comment when reviewing a push protection bypass. push_protection_bypass_request_comment: type: - string @@ -212014,6 +212395,31 @@ components: allowed_values: - production - development + enterprise-ruleset: + value: + id: 21 + name: super cool ruleset + target: repository + source_type: Enterprise + source: my-enterprise + enforcement: active + conditions: + organization_name: + include: + - important_organization + repository_name: + include: + - "~ALL" + rules: + - type: repository_delete + node_id: RRS_lACkVXNlcgQB + _links: + self: + href: https://api.github.com/enterprises/my-enterprise/rulesets/21 + html: + href: https://github.com/enterprise/my-enterprise/settings/policies/repositories/21 + created_at: '2024-08-15T08:43:03Z' + updated_at: '2024-09-23T16:29:47Z' organization-secret-scanning-alert-list: value: - number: 2 @@ -212151,6 +212557,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true + push_protection_bypass_request_reviewer_comment: Example response push_protection_bypass_request_comment: Example comment push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment @@ -212238,6 +212645,7 @@ components: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -218659,6 +219067,11 @@ components: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 @@ -229609,6 +230022,7 @@ components: received_events_url: https://api.github.com/users/octocat/received_events type: User site_admin: true + push_protection_bypass_request_reviewer_comment: Example response push_protection_bypass_request_comment: Example comment push_protection_bypass_request_html_url: https://github.com/owner/repo/secret_scanning_exemptions/1 resolution_comment: Example comment @@ -229631,6 +230045,7 @@ components: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -229655,6 +230070,7 @@ components: push_protection_bypassed: false push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: @@ -229697,6 +230113,7 @@ components: push_protection_bypassed_by: push_protection_bypassed_at: push_protection_bypass_request_reviewer: + push_protection_bypass_request_reviewer_comment: push_protection_bypass_request_comment: push_protection_bypass_request_html_url: resolution_comment: Example comment diff --git a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json index 0ff17d4e5..649ca3537 100644 --- a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.json @@ -153219,6 +153219,30 @@ "reset", "used" ] + }, + "code_scanning_autofix": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] } }, "required": [ @@ -153319,6 +153343,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { diff --git a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml index e3b4a8e46..81647ced7 100644 --- a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml +++ b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.2022-11-28.deref.yaml @@ -35467,6 +35467,7 @@ paths: code_scanning_upload: *260 actions_runner_registration: *260 scim: *260 + code_scanning_autofix: *260 required: - core - search @@ -35528,6 +35529,11 @@ paths: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 diff --git a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.json b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.json index 0ff17d4e5..649ca3537 100644 --- a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.json +++ b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.json @@ -153219,6 +153219,30 @@ "reset", "used" ] + }, + "code_scanning_autofix": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] } }, "required": [ @@ -153319,6 +153343,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { diff --git a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.yaml b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.yaml index e3b4a8e46..81647ced7 100644 --- a/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.yaml +++ b/descriptions-next/ghes-3.10/dereferenced/ghes-3.10.deref.yaml @@ -35467,6 +35467,7 @@ paths: code_scanning_upload: *260 actions_runner_registration: *260 scim: *260 + code_scanning_autofix: *260 required: - core - search @@ -35528,6 +35529,11 @@ paths: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 diff --git a/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.json b/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.json index 6d9fe8552..3dd4e211a 100644 --- a/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.json +++ b/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.json @@ -100736,6 +100736,9 @@ }, "scim": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -262587,6 +262590,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { diff --git a/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.yaml b/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.yaml index 609d3f008..2bfb4ed49 100644 --- a/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.yaml +++ b/descriptions-next/ghes-3.10/ghes-3.10.2022-11-28.yaml @@ -72411,6 +72411,8 @@ components: "$ref": "#/components/schemas/rate-limit" scim: "$ref": "#/components/schemas/rate-limit" + code_scanning_autofix: + "$ref": "#/components/schemas/rate-limit" required: - core - search @@ -193716,6 +193718,11 @@ components: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 diff --git a/descriptions-next/ghes-3.10/ghes-3.10.json b/descriptions-next/ghes-3.10/ghes-3.10.json index 6d9fe8552..3dd4e211a 100644 --- a/descriptions-next/ghes-3.10/ghes-3.10.json +++ b/descriptions-next/ghes-3.10/ghes-3.10.json @@ -100736,6 +100736,9 @@ }, "scim": { "$ref": "#/components/schemas/rate-limit" + }, + "code_scanning_autofix": { + "$ref": "#/components/schemas/rate-limit" } }, "required": [ @@ -262587,6 +262590,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { diff --git a/descriptions-next/ghes-3.10/ghes-3.10.yaml b/descriptions-next/ghes-3.10/ghes-3.10.yaml index 609d3f008..2bfb4ed49 100644 --- a/descriptions-next/ghes-3.10/ghes-3.10.yaml +++ b/descriptions-next/ghes-3.10/ghes-3.10.yaml @@ -72411,6 +72411,8 @@ components: "$ref": "#/components/schemas/rate-limit" scim: "$ref": "#/components/schemas/rate-limit" + code_scanning_autofix: + "$ref": "#/components/schemas/rate-limit" required: - core - search @@ -193716,6 +193718,11 @@ components: used: 0 remaining: 10 reset: 1691591091 + code_scanning_autofix: + limit: 10 + used: 0 + remaining: 10 + reset: 1691591091 rate: limit: 5000 used: 1 diff --git a/descriptions-next/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.json b/descriptions-next/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.json index 19a350d42..0fbb54dfe 100644 --- a/descriptions-next/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.json +++ b/descriptions-next/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.json @@ -133104,7 +133104,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -133219,7 +133219,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -133497,6 +133497,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -134059,7 +134066,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -134108,7 +134115,7 @@ "conditions": { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -134381,6 +134388,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -134781,6 +134795,14 @@ } ] } + }, + "source_type": { + "type": "string", + "description": "The type of the source of the ruleset", + "enum": [ + "Repository", + "Organization" + ] } }, "required": [ @@ -134883,7 +134905,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -134998,7 +135020,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -135276,6 +135298,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -135889,7 +135918,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -136004,7 +136033,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -136282,6 +136311,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -136869,7 +136905,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -136918,7 +136954,7 @@ "conditions": { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -137191,6 +137227,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -137689,7 +137732,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -137804,7 +137847,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -138082,6 +138125,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -160972,6 +161022,30 @@ "reset", "used" ] + }, + "code_scanning_autofix": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + }, + "used": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset", + "used" + ] } }, "required": [ @@ -161072,6 +161146,12 @@ "used": 0, "remaining": 10, "reset": 1691591091 + }, + "code_scanning_autofix": { + "limit": 10, + "used": 0, + "remaining": 10, + "reset": 1691591091 } }, "rate": { @@ -416715,6 +416795,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -417512,7 +417599,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -417627,7 +417714,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -417905,6 +417992,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -418476,7 +418570,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -418696,6 +418790,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -419188,7 +419289,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -419303,7 +419404,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -419581,6 +419682,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -420203,7 +420311,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -420318,7 +420426,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -420596,6 +420704,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -421182,7 +421297,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -421402,6 +421517,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -421890,7 +422012,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -422005,7 +422127,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -422283,6 +422405,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1079845,7 +1079974,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -1079960,7 +1080089,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -1080238,6 +1080367,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1082663,7 +1082799,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -1082778,7 +1082914,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -1083056,6 +1083192,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1085481,7 +1085624,7 @@ }, "enforcement": { "type": "string", - "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page.", + "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": [ "disabled", "active", @@ -1085596,7 +1085739,7 @@ { "title": "Organization ruleset conditions", "type": "object", - "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.", + "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", @@ -1085874,6 +1086017,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1086594,6 +1086744,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1087142,6 +1087299,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." @@ -1087693,6 +1087857,13 @@ "parameters": { "type": "object", "properties": { + "allowed_merge_methods": { + "type": "array", + "description": "When merging pull requests, you can allow any combination of merge commits, squashing, or rebasing. At least one option must be enabled.", + "items": { + "type": "string" + } + }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." diff --git a/descriptions-next/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.yaml b/descriptions-next/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.yaml index 4f9c7948f..bf5b59a89 100644 --- a/descriptions-next/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.yaml +++ b/descriptions-next/ghes-3.11/dereferenced/ghes-3.11.2022-11-28.deref.yaml @@ -31159,7 +31159,8 @@ paths: type: string description: The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins - can view insights on the Rule Insights page. + can view insights on the Rule Insights page. `evaluate` is + not available for the `repository` target. enum: - disabled - active @@ -31261,6 +31262,7 @@ paths: Conditions for an organization ruleset. The branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties. The push rulesets conditions object does not require the `ref_name` property. + For repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`. oneOf: - type: object title: repository_name_and_ref_name @@ -31437,6 +31439,13 @@ paths: parameters: type: object properties: + allowed_merge_methods: + type: array + description: When merging pull requests, you can + allow any combination of merge commits, squashing, + or rebasing. At least one option must be enabled. + items: + type: string dismiss_stale_reviews_on_push: type: boolean description: New, reviewable commits pushed will @@ -31838,6 +31847,12 @@ paths: type: array description: An array of rules within the ruleset. items: *227 + source_type: + type: string + description: The type of the source of the ruleset + enum: + - Repository + - Organization required: - name - enforcement @@ -37239,6 +37254,7 @@ paths: code_scanning_upload: *271 actions_runner_registration: *271 scim: *271 + code_scanning_autofix: *271 required: - core - search{"code":"internal","msg":"git-diff-tree: context deadline exceeded","meta":{"cause":"*fmt.wrapError"}}